1. インストレーションおよび構成ガイド
  2. Oracle REST Data Servicesのインストールおよび構成

2 Oracle REST Data Servicesのインストールおよび構成

この章では、Oracle REST Data Services (ORDS)をインストール、構成およびアップグレードする方法について説明します。

トピック:

関連トピック

2.1 Oracle REST Data Servicesのインストール

ORDSをインストールする前に、次のステップを完了しておく必要があります。

ノート:

このトピックの手順は、単一インスタンスのデータベースまたはPDBにOracle REST Data Servicesをインストールする場合に適用されます。CDB環境でのORDSの設定については、「Oracle REST Data Servicesでのマルチテナント・アーキテクチャの使用」の項を参照してください。

次に、次のいずれかのオプションを使用してORDSをインストールできます。

関連項目:

2.1.1 ORDSのダウンロード

この項では、ORDSをダウンロードする方法について説明します。

ORDS Zipファイルのダウンロード

Oracle REST Data Services (ORDS)のダウンロード・ページからords_<latest>.zipファイルをダウンロードして、任意のフォルダにords_<latest>.zipファイルを解凍します。ファイルの解凍先として選択したフォルダは、ORDS製品フォルダと呼ばれます。ORDS製品フォルダには、binフォルダと、ORDSの実行に必要なその他のフォルダおよびファイルが含まれています。

オペレーティング・システムのPATHへのORDS binフォルダの追加

オペレーティング・システムのPATH環境変数にORDS binフォルダを追加することをお薦めします。

Linux/UNIXオペレーティング・システムの例
echo -e 'export PATH="$PATH:/<ords product folder>/bin"' >> ~/.bash_profile

新しいシェルを起動すると、この変更が反映されます。

Windowsオペレーティング・システムの例
コマンド・プロンプトを管理者権限で使用します。
SetX PATH "%PATH%;<ords product folder>\bin"

新しいコマンド・プロンプトを起動すると、この変更が反映されます。

Macオペレーティング・システムの例
echo -e 'export PATH="$PATH:/<ords product folder>/bin"' >> ~/.zprofile

新しいターミナルを起動すると、この変更が反映されます。

yumを使用したORDSのダウンロード

ORDSは、OL7およびOL8リポジトリで公開されます。システム管理者は、ORDSをインストールしてその依存関係を処理するために、このリポジトリをyum構成に追加できます。

OL7リポジトリ: https://yum.oracle.com/repo/OracleLinux/OL7/oracle/software/x86_64/

OL8リポジトリ: https://yum.oracle.com/repo/OracleLinux/OL8/oracle/software/x86_64/

oracleソフトウェア・リポジトリがyum構成に追加されている場合は、次のコマンドを使用してORDSをダウンロードしてインストールできます。
sudo yum install ords

前述のコマンドは、すべてのORDS依存関係を処理し、ORDSプログラムを/usr/local/bin/ordsフォルダに配置して、ORDS構成を設定し、ORDSをデータベースにインストールまたはアップグレードします。

/etc/ords/conf構成ディレクトリを使用することをお薦めします。次のコマンドを使用して、ORDSを構成します。
ords -–config /etc/ords/config install
別のディレクトリを使用してORDS構成を配置し、Linuxシステム・サービス管理をsystem dまたはsystem vとして使用する場合は、/etc/ords.confフォルダにORDS configディレクトリを構成します。

RPMを使用したORDSのインストール

インストールするシステムがyumを使用していないか、インターネットに接続されていない場合は、前の項(yumを使用したORDSのダウンロード)に記載されているリンクからORDS RPMをダウンロードして、手動でRPMをインストールできます。これではORDS依存関係は処理されないため、Java JDKを手動でインストールする必要があります。RPMファイルをダウンロードした後、次のコマンドを使用してインストールできます。
sudo rpm -i ords-22.1.X-X.elX.noarch.rpm
これにより、ORDSプログラムが/usr/local/bin/ordsフォルダに配置され、ORDS構成が設定され、データベースにORDSがインストールまたはアップグレードされます。
ORDSを構成するには、次のコマンドを使用して/etc/ords/confフォルダの構成ディレクトリを使用することをお薦めします。
ords -–config /etc/ords/config install
別のディレクトリを使用してORDS構成を配置し、Linuxシステム・サービス管理をsystemdまたはsystem vとして使用する場合は、/etc/ords.confフォルダにORDS構成ディレクトリを構成します。

2.1.2 構成フォルダの構造の設定

この項では、構成フォルダの構造を設定する方法について説明します。

2.1.2.1 新しいORDS構成フォルダの指定

新規インストールでは、ORDS構成ファイルが構成フォルダに配置されます。ORDSリリース21.4.x以前の構成ファイルは、構成フォルダに移行されます。

次のいずれかのオプションを使用して、構成フォルダの場所を取得できます。
  1. コマンド・オプション:

    構成フォルダを指定するには、--configオプションを使用します。

    例:

    ords --config /path/to/conf install

  2. 環境変数:

    ノート:

    このオプションは、ORDSコマンドライン・インタフェースを使用しているときに--configオプションを含めるのを忘れた場合に推奨されます。
    • ORDS_CONFIG: ORDS_CONFIG環境変数を作成します。

      LinuxまたはUNIXオペレーティング・システムの例: 

      Shell script containing ORDS_CONFIG
cat example_env
export ORDS_CONFIG=/path/to/conf

echo $ORDS_CONFIG
/path/to/conf
    • _JAVA_OPTIONS:

      例:

      export _JAVA_OPTIONS=-Dconfig.url=/Users/<username>/work/dbtools-dev/config
./ords-22.1.0.087.1756/bin/ords config list

_JAVA_OPTIONS: -Dconfig.url=/Users/<username>/work/dbtools-dev/config
  3. 現行作業ディレクトリ:

    --config <configuration_folder>オプションが指定されておらず、ORDS_CONFIG環境変数が定義されていない場合は、現行作業ディレクトリが構成フォルダとして使用されます。

    例:

    現行作業ディレクトリが/path/to/confの場合、その場所が構成フォルダに使用されます。

ノート:

  • ORDSがORDS製品フォルダに構成ディレクトリを作成しないようにすることをお薦めします。たとえば、次の場所に構成フォルダを設定できます。 
    /Users/<user_name>/work/dbtools-dev/config/

    ベスト・プラクティスは、構成ファイルをアプリケーション・ファイルと別にすることです。これにより、メンテナンスとアップグレードが簡単になり信頼性が向上します。

  • 次のコマンドは有効ではなくなりました。

    例: java -jar ords.war install

    java -jar ords.warを使用してレガシー・コマンドを指定すると、次の警告メッセージが表示されます。

    警告: java -jar ords.warの実行のサポートは非推奨になりました。ordsをPATHに追加し、ordsコマンドをかわりに使用してください。次のコマンドを実行してORDSをPATHに追加します:

    <Displays an example of adding the bin folder to your PATH>

    新しいターミナルを起動すると、この変更が反映されます。パスにORDS製品のbinフォルダを追加することをお薦めします。

2.1.3 対話型のコマンドライン・インタフェース・インストール

この項では、対話型のコマンドライン・インタフェース(CLI)インストールのプロンプトについて説明します。プロンプトにより、ORDS構成ファイルの作成または更新、ORDSスキーマ、ORDSデータベース・ユーザー、およびデータベース内の関連データベース・オブジェクトのインストールまたはアップグレードに必要な情報の入力を求められます。スタンドアロン・モードで実行することもできます。

プロンプトを表示するには、次のいずれかのコマンドを実行する必要があります。
  • installコマンドを指定します。例: $ ords install

    ノート:

    構成ディレクトリが環境変数を介して指定されているか、現行作業ディレクトリにデフォルト設定されていることを前提としています。
  • オプション--config <CONFIG FOLDER>の後に、installコマンドを指定します。
    たとえば:
    • $ ords --config /path/to/config install
    • ords --config /path/to/conf install --interactive --log-folder /path/to/logs

表2-1 対話型インストールのプロンプト

プロンプト番号 プロンプト 説明
1. 
Enter a number to select the type of installation
    [1] Install or upgrade ORDS in the database only
    [2] Create or update a database pool and install/upgrade ORDS in the database
    [3] Create or update a database pool only
  Choose [2]:
 「インストールのタイプを選択するための番号の入力」を参照してください。
2. 
Enter a number to select the database pool to update, or create an additional database pool.
  The selected (or created) database pool will be used to install or upgrade ORDS in the database.
    [1] default  jdbc:oracle:thin:@//localhost:1521/orcl
    [2] Create an additional database pool
  Choose [1]:
「データベース・プールを選択するための番号の入力」を参照してください
3. 
Enter the database pool name:
 「データベース・プール名の入力」を参照してください
4. 
Enter a number to select the database connection type to use
    [1] Basic (host name, port, service name)
    [2] TNS (TNS alias, TNS directory)
    [3] Custom database URL
  Choose [1]:
 「データベース接続を選択するための番号の入力」を参照してください
5. 
Enter the database host name [localhost]:
 「データベース・ホスト名の入力」を参照してください
6. 
Enter the database listen port [1521]:
 「データベース・リスナー・ポートの入力」を参照してください
7. 
Enter the database service name [orcl]:
 「データベース・サービス名の入力」を参照してください
8. 
Enter the TNS location: /path/to/tns
 「TNSの場所の入力」を参照してください
9. 
Enter a number to select the TNS Network alias to use
    [1] DB1  ...CONNECT_DATA=(SERVER=DEDICATED)(SERVICE_NAME=pdb1))
    [2] DB2  ...CONNECT_DATA=(SERVER=DEDICATED)(SERVICE_NAME=pdb2)))     
    [3] DB3  ...CONNECT_DATA=(SERVER=DEDICATED)(SERVICE_NAME=pdb3)))     
  Choose [1]:
「TNSネットワーク別名を選択するための番号の入力」を参照してください
10. 
Enter the Custom database URL:
 「カスタム・データベースURLの入力」を参照してください
11. 
Provide database username with administrator privileges.
Enter the administrator username: SYS
 「管理者ユーザー名の入力」を参照してください
12. 
Enter the database password for SYS AS SYSDBA:
 「データベース・パスワードの入力」を参照してください
13. 
Enter the default tablespace for ORDS_METADATA and ORDS_PUBLIC_USER [SYSAUX]: 
Enter the temporary tablespace for ORDS_METADATA and ORDS_PUBLIC_USER [TEMP]:
「デフォルト表領域の入力」を参照してください
14. 
Enter a number to select additional feature(s) to enable:
    [1] Database Actions  (Enables all features)
    [2] REST Enabled SQL and Database API
    [3] REST Enabled SQL
    [4] Database API
    [5] None
  Choose [1]:
「追加機能を選択するための番号の入力」を参照してください
15. 
Enter a number to configure and start ORDS in standalone mode
    [1] Configure and start ORDS in standalone mode
    [2] Skip
  Choose [1]:
「スタンドアロン・モードでORDSを構成および開始するための番号の入力」を参照してください
16. 
Enter a number to use HTTP or HTTPS protocol    
[1] HTTP
[2] HTTPS
  Choose [1]:
「HTTPまたはHTTPSプロトコルを使用するための番号の入力」を参照してください
17. 
Enter the HTTP port [8080]:
「HTTPポートの入力」を参照してください
18. 
Enter the HTTPS port [8443]:
 「HTTPSポートの入力」を参照してください
19. 
Enter a number to select the certificate type
    [1] Use self-signed certificate (generates automatically)
    [2] Use my SSL certificate (requires SSL certificate and SSL certificate private key)
  Choose [1]:
「証明書タイプを選択するための番号の入力」を参照してください
20. 
Enter the SSL hostname:
 「SSLホスト名の入力」を参照してください
21. 
Enter the path for the SSL Certificate:
 「SSL証明書のパスの入力」を参照してください
22. 
Enter the path for the SSL Certificate’s private key:
 「SSL証明書の秘密キーのパスの入力」を参照してください
23. 
Enter the APEX static resources location: /path/to/apex/images
 「APEX静的リソースの場所の入力」を参照してください
2.1.3.1 インストールのタイプを選択するための番号の入力

インストールのタイプを選択します。

  1. オプション1
    • データベースのORDSのインストールまたはアップグレードのみを実行する
      • ORDSがデータベースに存在しない場合、ORDSスキーマ、ORDSデータベース・ユーザーおよび関連データベース・オブジェクトをインストールします。
      • スキーマ・バージョンが製品バージョンより小さい場合、ORDSをアップグレードします。
  2. オプション2
    • データベース・プールを作成または更新して、データベースのORDSをインストール/アップグレードする
      • データベース・プールを作成するか、既存のデータベース・プールを選択して更新します。
      • 既存のデータベース・プールの場合、プロンプトが表示されると、設定値がデフォルト値として表示されます。
    • データベースでORDSのインストール/アップグレードを実行する
      • ORDSが存在しない場合、ORDSスキーマ、ORDSデータベース・ユーザーおよび関連データベース・オブジェクトをインストールします。
      • スキーマ・バージョンが製品バージョンより小さい場合、ORDSをアップグレードします。
  3. オプション 3
    • データベース・プールの作成または更新のみを実行する
      • データベース・プールを作成するか、既存のデータベース・プールを選択して更新します。
      • 既存のデータベース・プールの場合、プロンプトが表示されると、設定値がデフォルト値として表示されます。
2.1.3.2 データベース・プールを選択するための番号の入力

ORDSデータベース・プールが構成フォルダにすでに存在する場合、データベース・プールとその接続が表示されます。

データベース・プールを選択できます。

次を選択した場合、追加のデータベース・プールを作成します
  • プロンプト1のオプション2
  • プロンプト1のオプション3

ノート:

ORDS構成プールが存在しない場合は、データベース接続タイプを入力するように求められます。プロンプト3を参照してください。
2.1.3.3 データベース・プール名の入力

プロンプト番号2でオプション2を選択すると、データベース・プール名のプロンプトが表示されます。データベース・プール名を入力します。

ノート:

  • データベース・プール名に使用できるのは、小文字のアルファベットa-z、0-9の数字と-文字のみで、最初と最後は小文字の英数字にする必要があります。

    たとえば、入力したプール名がdatabase1の場合、そのプールへのすべてのRESTリクエストは/ords/database1/で始まります。

  • データベース・プールが作成されると、データベース・プール・フォルダも、プール固有の設定およびデータベース・ユーザー資格証明を格納するウォレットとともに作成されます。

  • このプロンプトでは、マッピング・パターンも設定されます。詳細は、「追加のデータベースの構成」を参照してください。
2.1.3.4 データベース接続を選択するための番号の入力

データベース接続タイプを選択します。

ノート:

ORDS構成プールが構成フォルダに存在しない場合は、プロンプト番号1から選択すると、プロンプト番号4が表示されます。

プロンプト1でオプション2またはオプション3を選択すると、defaultという名前のデータベース・プール・フォルダが、プール固有の設定およびデータベース・ユーザー資格証明を格納するウォレットとともに作成されます。

2.1.3.5 データベース・ホスト名の入力

基本接続のデータベース・ホスト名を指定します。

2.1.3.6 データベース・リスナー・ポートの入力

基本接続のデータベース・ポートを指定します。

2.1.3.7 データベース・サービス名の入力
サービス名を指定します。サービス名のデフォルト値は、指定された順序で次のいずれかから取得されます。
  1. ORDS構成ファイルのサービス名設定。存在しない場合は次が行われます
  2. ORACLE_PDB環境変数がチェックされます。未定義の場合は次が行われます
  3. ORACLE_SID環境変数がチェックされます。未定義の場合は次が行われます
  4. orclがデフォルト値として使用されます。
2.1.3.8 TNSの場所の入力

tnsnames.oraファイルの場所を指定します。場所は、tnsnames.oraファイルがあるフォルダ、またはTNS接続用のtnsnames.oraファイルを含むzipファイルになります。

2.1.3.9 TNSネットワーク別名を選択するための番号の入力

表示されるTNSネットワーク別名のリストからTNS別名を選択します。

2.1.3.10 カスタム・データベースURLの入力

カスタム・データベースURL接続のカスタム・データベースURLを指定します。

2.1.3.11 管理者ユーザー名の入力

データベースにORDSをインストールまたはアップグレードするインストーラ権限を持つユーザーを指定します。

関連項目:

Oracle REST Data Servicesユーザーに付与される権限
2.1.3.12 データベース・パスワードの入力

管理者ユーザーのパスワードを指定します。

2.1.3.13 デフォルト表領域の入力
ORDSスキーマとORDSデータベース・ユーザーの両方の表領域を指定します。

ノート:

ORDSがデータベースにインストールされていない場合、表領域の入力を求められます。
2.1.3.14 追加機能を選択するための番号の入力

有効にする追加機能を選択します。

2.1.3.15 スタンドアロン・モードでORDSを構成および開始するための番号の入力

ORDSをスタンドアロン・モードで実行するように構成できます。また、インストールまたはアップグレードの完了後に、ORDSをスタンドアロン・モードで起動できます。

ORDSを構成せず、スタンドアロン・モードで起動しない場合は、オプション2を選択して終了します。

2.1.3.16 HTTPまたはHTTPSプロトコルを使用するための番号の入力

使用するプロトコル(HTTPまたはHTTPS)を選択します。

ノート:

HTTPSとHTTPを使用してスタンドアロン・モードでORDSを実行することをお薦めします。
2.1.3.17 HTTPポートの入力

プロンプト番号16でオプション1: 「HTTP」を選択した場合、HTTPポートを指定します。

2.1.3.18 HTTPSポートの入力

プロンプト番号16でオプション2: 「HTTPS」を選択した場合、HTTPSポートを指定します。

2.1.3.19 証明書タイプを選択するための番号の入力

プロンプト番号16でオプション2: 「HTTPS」プロトコルを選択した場合、証明書タイプのオプションを選択します。

オプション1を選択すると、ORDSによって自己署名証明書が自動的に生成され、SSLホスト名を入力するよう求められます。

オプション2を選択すると、証明書パスと証明書の秘密キーのパスに関する追加のプロンプトが表示されます。詳細は、SSL証明書の項を参照してください。

2.1.3.20 SSLホスト名の入力

プロンプト19でオプション1: 自己署名証明書を選択した場合、SSLホスト名を指定します。

2.1.3.21 SSL証明書のパスの入力

プロンプト番号19でオプション2: 自分のSSL証明書を使用するを選択した場合、SSL証明書パスを指定します。

2.1.3.22 SSL証明書の秘密キーのパスの入力

プロンプト19でオプション2: 自分のSSL証明書を使用するを選択した場合、SSL証明書の秘密キーのパスを指定します。

2.1.3.23 APEX静的リソースの場所の入力

ORDSは、APEXがデータベースにインストールされているかどうか、およびデータベース・ユーザーAPEX_PUBLIC_USERが存在するかどうかを検出し、trueであることが検出された場合は、APEXイメージの場所の入力を求められます。

2.1.4 非対話型のコマンドライン・インタフェース・インストール(サイレント)

非対話型のコマンドライン・インタフェース(CLI)インストールまたはサイレント・インストールでは、次のタスクを実行します。

  • ORDS構成ファイルの作成または更新
  • ORDSスキーマのインストールまたはアップグレード
  • データベースでのORDSプロキシ・ユーザーおよび関連オブジェクトの作成

非対話型インストール・コマンドは、スタンドアロン・モードでは実行されません。スタンドアロン・モードで実行する場合は、その後にserveコマンドを指定する必要があります。

非対話型インストールのコマンドライン・オプションを指定し、必要なオプション(たとえば、基本接続にはdb-portオプションが必要)がない場合は、エラー・メッセージが表示されます。

--db-pool <pool_name>オプションは、作成または更新するデータベース・プールを指定します。--db-poolオプションを省略すると、defaultデータベース・プールにデフォルト設定されます。

2.1.4.1 コマンドライン・インタフェース・インストールのコマンド・オプションの理解

表2-2 コマンドライン・インタフェース・インストールのコマンド・オプション

オプション 説明
--admin-user <USERNAME> データベースにORDSをインストールまたはアップグレードする、またはORDSステータス情報を取得する権限を持つユーザーを指定します。
--bequeath-connect クライアントがネットワーク・リスナーをバイパスしてOracleデータベースに直接接続できるようにする継承接続を指定します。これは、クライアントがデータベースと同じサーバー上に存在する場合です。環境を設定して--bequeath-connectオプションを使用するには、Oracle REST Data Servicesのドキュメントを参照してください。
--config <CONFIG_PATH> 構成ファイルを含むフォルダのパスを指定します。
--config-only 構成の作成または更新のみを指定します。
--db-only ORDSをデータベースにインストールまたは更新し、構成ファイルを作成または更新しないことを指定します。
--db-pool <POOL_NAME> 作成、更新または使用するデータベース・プールの名前を指定します。db-poolオプションを省略すると、defaultデータベース・プールが使用されます。
--db-custom-url <URL> データベース接続のカスタム・データベースURLを指定します。
--db-hostname <HOST> データベース・ホスト名を指定します。
--db-port <PORT> データベース・ポートを指定します。
--db-servicename <SERVICENAME> データベース・サービス名を指定します。
--db-sid <SID> データベースSIDを指定します。
--db-tns-alias <ALIAS_NAME> tnsnames.oraファイルに存在するTNS別名を指定します。
--db-tns-dir <TNS_DIR> tnsnames.oraファイルがあるフォルダを指定します。
--feature-db-api <BOOLEAN>

DB API機能を有効にするかどうかを指定します。

使用可能な値は、trueまたはfalseです。
  • 値がtrueに設定されている場合、DB API機能が有効になります。
  • 値がfalseに設定されている場合、DB API機能は無効になります。

指定したオプションが--feature-sdw trueおよび--feature db-api falseの場合、エラーが返されます。

--feature-rest-enabled-sql <BOOLEAN>

REST対応SQL機能を有効にするかどうかを指定します。

使用可能な値は、trueまたはfalseです。
  • 値がtrueに設定されている場合、REST対応SQL機能が有効になります。
  • 値がfalseに設定されている場合、REST対応SQL機能は無効になります。

指定したオプションが--feature-sdw trueおよび--feature-rest-enabled-sql falseの場合、エラーが返されます。

--feature-sdw <BOOLEAN>

データベース・アクション機能を有効にするかどうかを指定します。

使用可能な値は、trueまたはfalseです。

  • 値がtrueに設定されている場合、データベース・アクション機能が有効になります。
  • 値がfalseに設定されている場合、データベース・アクション機能は無効になります。

このオプションがtrueに設定されている場合、構成ファイルで次の設定がtrueに設定されます。

  • database.api.enabled
  • restEnabledSql.active

--feature-sdw trueおよび次のオプションのいずれかが指定され、falseに設定されている場合、エラーが返されます。

  • --feature-db-api
  • --feature-rest-enabled-sql
--gateway-mode <MODE>

PL/SQLゲートウェイ・モードを指定します。

使用可能な値は、proxied、directまたはdisabledです。

デフォルト値はdisabledです。

説明:
  • disabled - PL/SQLゲートウェイは使用できません。
  • direct - PL/SQLゲートウェイ・コールは、(pool.xml設定にある) db.usernameで識別されるユーザーとして直接実行されます。
  • proxied - PL/SQLゲートウェイ・コールは、ランタイム・ユーザー(db.usernameはpool.xmlにある)からords_admin.config_plsql_gatewayによって構成された関連スキーマにプロキシすることで実行されます。
--gateway-user <USER> Oracleデータベースに存在し、ストアド・プロシージャにアクセスする権限を持つユーザーを指定します。
--interactive, -i 必要なすべての情報をユーザーに要求します。
--help, -h コマンドの使用方法を示します。
--legacy-config <FOLDER> 改訂された構成構造に移行するレガシー構成フォルダを指定します。
--legacy-context <STRING> レガシー構成で使用されていたコンテキスト(例: ords、apexなど)を指定します。
--log-folder インストール、アップグレード、修復またはアンインストールのログをログ・フォルダに書き込みます。このオプションを省略すると、出力は標準出力に書き込まれます。
--password-stdin ORDSのインストール、アップグレード、修復またはアンインストール・コマンドを非対話的に実行するには、このオプションを使用して、入力をファイルまたはhereドキュメントにリダイレクトするときに標準入力からパスワード値を読み取ります。
--pdb-exclude <(PDB...)>

CDBに適用可能なオプションを指定します。

ORDSのインストール/アップグレードまたは修復から除外されるPDBのリスト。
--pdb-open-readwrite-all

CDBに適用可能なオプションを指定します。

PDBのステータスがクローズまたは読取り専用である場合に、すべてのPDBを読取り/書込みモードでオープンするかどうかを指定します。
--pdb-open-readwrite <(PDB...)>

CDBに適用可能なオプションを指定します。

ORDSのインストール、アップグレード、修復またはアンインストールのために、読取り/書込みで開かれる、読取り専用またはクローズのPDBのリスト。
--pdb-skip-readonly

CDBに適用可能なオプションを指定します。

読取り専用のPDBをスキップします。

このオプションを省略すると、ORDSのインストールまたはアップグレードでPDBが読取り専用であることをユーザーに通知するエラー・メッセージが返されます。PDB$SEEDは読取り/書込みで開かれているため、除外します。

--pdb-skip-closed

CDBに適用可能なオプションを指定します。

クローズ(マウント)されているPDBをスキップします。

このオプションを省略すると、ORDSのインストール/アップグレードでPDBがクローズされていることをユーザーに通知するエラー・メッセージが返されます。
--proxy-user 標準入力のリダイレクト時に、ファイルまたはhereドキュメントにあるORDSデータベース・ユーザー(ORDS_PUBLIC_USER)のパスワードを指定します。
--proxy-user-tablespace <TABLESPACE>

ORDSのインストールに適用可能なオプションを指定します。

プロキシ・ユーザー(ORDS_PUBLIC_USERなど)のデフォルト表領域。

このオプションを省略すると、デフォルトのデータベースのデフォルト表領域が使用されます。
--proxy-user-temp-tablespace <TABLESPACE>

ORDSのインストールに適用可能なオプションを指定します。

プロキシ・ユーザー(ORDS_PUBLIC_USERなど)の一時表領域。

このオプションを省略すると、デフォルトのデータベースの一時表領域が使用されます。
--schema-tablespace <TABLESPACE>

ORDS_METADATAスキーマのデフォルト表領域を指定します。

このオプションを省略すると、デフォルトのデータベースのデフォルト表領域が使用されます。
--schema-temp-tablespace <TABLESPACE>

ORDSのインストールに適用可能なオプションを指定します。

ORDS_METADATAスキーマの一時表領域。

このオプションを省略すると、デフォルトのデータベースの一時表領域が使用されます。
2.1.4.2 入力リダイレクションの使用

この項では、hereコマンドまたはファイルを使用して標準入力をリダイレクトする方法について説明します。

ファイルへのSTDINのリダイレクト

パスワードを含むファイルにSTDINをリダイレクトします。次の例では、ファイルに2つのパスワードが含まれている必要があります。各パスワードは、個別の行に指定する必要があります。

例:
$ cat password.txt
firstpassword
secondpassword

最初のパスワードは、コマンドラインの最初のユーザー(SYSなど)に属します。2番目のパスワードは、コマンドラインの2番目のユーザー(proxy-userなど)に属します。 

ords --config <configuration_folder> install --db-pool <pool_name> --admin-user <username> --proxy-user 
--db-hostname <host> --db-port <port_number> --db-servicename <service_name> 
--log-folder <log_folder> --feature-sdw <boolean> --password-stdin < <filename>

例:


ords --config /path/to/conf install --db-pool db1 --admin-user SYS --proxy-user --db-hostname localhost 
--db-port 1521 --db-servicename orcl --log-folder /path/to/logs --feature-sdw true 
--password-stdin < password.txt

Hereドキュメントを使用した標準入力のリダイレクト

パスワードにHereドキュメント(heredocとも呼ばれる)を使用してSTDINをリダイレクトします。heredocは、<<リダイレクション演算子と、その後に続くデリミタ・トークンで構成されます。

各パスワードは個別の行に指定する必要があり、デリミタ・トークンで終了します。

例:

最初のパスワードは、コマンドラインの最初のユーザー(SYSなど)に属します。2番目のパスワードは、コマンドラインの2番目のユーザー(proxy-userなど)に属します。 

ords --config <configuration_folder> install --db-pool <pool_name> --admin-user <username> --proxy-user --db-hostname
 <host> --db-port <port_number> --db-servicename <service_name> --log-folder <log_folder> --feature-sdw <boolean> 
--password-stdin << EOF
<password1>
<password2>
EOF
ords --config /path/to/conf install --db-pool db1 --admin-user SYS --proxy-user --db-hostname 
localhost --db-port 1521 --db-servicename orcl --log-folder /path/to/logs --feature-sdw true 
--password-stdin << EOF
<password1>
<password2>
EOF

2.2 Oracle REST Data Servicesインストールの修復

Oracle REST Data Servicesのインストールが有効であることを確認する場合は、修復コマンドを指定します。

ノート:

データベース内のORDSを修復するには、ORDS製品のバージョンが、データベースにインストールされているORDSスキーマのバージョンと同じである必要があります。
情報の入力を求める修復コマンドの例:
ords [--config <folder>] install repair --interactive [--log-folder <folder>]

既存の構成がある場合は、データベース・プールのリストから選択できます。ORDSをインストールするデータベース接続を指定することもできます。管理者のユーザー名とパスワードを入力するように求められます。

例

Oracle REST Data Services - Interactive Repair

  Enter a number to select the database pool to use or specify the database connection
    [1] default      jdbc:oracle:thin:@//localhost:1521/orcl
    [2] sales          jdbc:oracle:thin:@//localhost:1521/pdb1
    [3] Specify the database connection
  Choose [1]: 
  Provide database user name with administrator privileges.
    Enter the administrator username: SYS
    Enter the database password for SYS AS SYSDBA:

ノート:

Oracle REST Data Servicesをインストールするとき、Oracle Application Express (APEX)スキーマの検出が試行され、ビューが作成されます。このビューは、APEXスキーマ内の関連する表をOracle REST Data Servicesスキーマ内の表に結合したものです。APEXの前にOracle REST Data Servicesをインストールする場合、Oracle REST Data ServicesではAPEXスキーマが見つからないため、欠落しているAPEX表のかわりにスタブ・ビューが作成されます。

Oracle REST Data ServicesをAPEXの後にインストールし、Oracle REST Data Servicesから問い合せる必要があるAPEXオブジェクトが必ず存在しているようにすることをお薦めします。Oracle REST Data ServicesをAPEXの前にインストールする場合、修復コマンドを使用して、Oracle REST Data ServicesによるAPEXスキーマに対する問合せを強制的に再構築します。

2.2.1 修復CLIのコマンド・オプション

この項では、データベース内のORDSスキーマを修復するために使用される対話型および非対話型のインストール修復CLIコマンドについて説明します。

表2-3 修復CLIのコマンド・オプション

コマンド 説明
--admin-user <string> データベースでORDSをインストール、アップグレードまたはアンインストールする権限を持つユーザーを指定します。
--bequeath-connect クライアントがネットワーク・リスナーをバイパスしてOracleデータベースに直接接続できるようにする継承接続を指定します。これは、クライアントがデータベースと同じサーバー上に存在する場合に発生します。
--db-custom-url <url> データベース接続のカスタム・データベースURLを指定します。
--db-hostname <string> データベース・ホスト名を指定します。
--db-pool <string> データベース接続プールの名前を指定します。
--db-port <int> データベース・ポートを指定します。
--db-servicename <string> データベース・サービス名を指定します。
--db-sid <string> データベースを識別する一意の名前のシステム識別子を指定します。
--db-tns-alias <string> tnsnames.oraファイルに存在するTNS別名を指定します。
--db-tns-dir <folder> tnsnames.oraファイルがあるフォルダを指定します。
-h, --help コマンドの使用方法を示し、その情報を提供します。
-i, --interactive 必要な情報の入力を求めます。
--log-folder <folder> インストール、アップグレードまたはアンインストールのログをログ・フォルダに書き込みます。このオプションを省略すると、出力は標準出力に書き込まれます。
--password-stdin このオプションを使用して、ords installまたはuninstallコマンドを非対話型で実行した場合に、入力をファイルまたはhereドキュメントにリダイレクトするときに標準入力からパスワード値を読み取るように指定します。--password-stdinオプションとリダイレクト記号(「<」または「<<」)を省略すると、パスワードを必要とするコマンド・オプションに対してパスワードを入力するよう求められます。
--pdb-exclude <string...> ORDSのインストール、アップグレードまたは修復から除外されるPDBのリストを指定します。このオプションは、CDBにのみ適用されます。
--pdb-open-readwrite <string...> ORDSのインストール、アップグレード、修復またはアンインストールのために、読取り/書込みで開かれる、読取り専用またはクローズのPDBのリストを指定します。このオプションは、CDBにのみ適用されます。
--pdb-open-readwrite-all PDBのステータスがクローズまたは読取り専用の場合、すべてのPDBを読取り/書込みモードで開くことを指定します。このオプションは、CDBにのみ適用されます。
--pdb-skip-closed クローズ(マウント)されているPDBをスキップします。このオプションは、CDBにのみ適用されます。
--pdb-skip-readonly 読取り専用のPDBをスキップします。このオプションは、CDBにのみ適用されます。

2.3 Oracle REST Data Servicesのアップグレード

この項では、Oracle REST Data Servicesの最新リリースにアップグレードする方法について説明します。

ORDS 22.1.x以降からのアップグレード

ORDS 22.1.x以降のリリースからアップグレードする場合は、次の項を参照してください。

ORDS 21.4.x以前のリリースからのアップグレード

ORDS 21.4.x以前のリリースからアップグレードする場合は、「ORDS 21.4.x以前のリリースからの構成の移行およびアップグレード」を参照してください

2.3.1 ORDS 21.4.x以前のリリースからの構成の移行およびアップグレード

この項では、ORDS 21.4.x以前のリリースからアップグレードする方法について説明します。

ORDS 21.4.x以前のリリースからORDS 22.xにアップグレードするには:

以前のORDSリリース(21.4.x以前)で使用されていた構成ファイルの場所を指定します。場所がわからない場合は、以前のORDSリリース(21.4.x以前)を使用してコマンドを指定します。

java -jar /path/to/earlierRelease/ords.war configdir

例:
java -jar /path/to/earlierRelease/ords.war configdir
 
INFO   The config.dir value is /path/to/legacy/conf

前述の例では、/path/to/legacy/confが構成の場所です

ORDS 21.4.x以前のリリースからORDS 22.xリリースにアップグレードするには、次の2つの方法があります。
2.3.1.1 対話型アップグレード

対話型アップグレード

次のinstallコマンドを指定して構成を移行し、指定したデータベースのORDSをアップグレードします。
ords --config <folder> install -i --legacy-config <folder> --log-folder
    <folder>

表2-4 対話型のアップグレード・コマンド

コマンド・オプション 説明
--config <folder>

移行した構成ファイルを格納する構成フォルダを指定します。

構成フォルダは、レガシー構成フォルダと同じ場所にしないでください。それ以外の場合は、エラーが発生します。
-iまたは--interactive 対話型モードでコマンドを実行することを指定します。次に、情報の入力を求められます。
--legacy-config <folder> ORDS 21.4.x以前のリリースに使用した構成ファイルの場所を指定することを指定します。
--log-folder <folder> ログ・ファイルを格納する場所を指定することを指定します。 
ords --config /path/to/new/conf install -i --legacy-config /path/to/legacy/conf --log-folder /path/to/logs
 
ORDS: Release 22.x Production on Wed <month> 1 12:00:01 <year>
 
Copyright (c) 2010, 2022, Oracle.
 
Configuration:
  /path/to/new/conf
 
Oracle REST Data Services 22.x.x.rNNNNNN - Migrate Configuration
Migrating ORDS Configuration files located at /path/to/legacy/conf/ords
. . .
Legacy configuration files located /path/to/legacy/conf/ords are no longer being used to configure ORDS or its connection pools.  Your migrated configuration files are now located at /path/to/new/conf
 
Oracle REST Data Services - Interactive Install
 
  Enter a number to select the type of installation
    [1] Install or upgrade ORDS in the database only
    [2] Create or update a database pool and install/upgrade ORDS in the database
    [3] Create or update a database pool only
  Choose [1]:

オプション1を選択して、データベースのORDSをアップグレードします。移行されたデータベース・プールのリストが表示されます。apexという名前のレガシー構成のデータベース・プールが移行され、名前がdefaultに変更されます。 

Enter a number to select the database pool to use or specify the database connection
  [1] default      jdbc:oracle:thin:@//localhost:1521/orcl
  [2] hr           jdbc:oracle:thin:@//localhost:1521/pdb1
  [3] Specify the database connection
Choose [1]:

アップグレードするデータベース・プールを選択します。次に、管理者のユーザー名とパスワードの入力を求められます。

Provide database user name with administrator privileges.
    Enter the administrator username: sys
    Enter the database password for SYS AS SYSDBA:
Connecting to database user: SYS AS SYSDBA url: jdbc:oracle:thin:@//localhost:1521/orcl
 
Retrieving information.
Connecting to database user: ORDS_PUBLIC_USER url:jdbc:oracle:thin:@//localhost:1521/orcl
Created folder /path/to/logs/
INFO   Upgrading Oracle REST Data Services schema 21.4.2.rNNNNNN to version 22.x.x.rNNNNNN in ORCL
INFO   Completed upgrade for Oracle REST Data Services version 22.x.x.rNNNNNN. Elapsed time: 00:00:02.585
 
INFO   Log file written to /path/to/logs/ords_upgrade_<date-time>.log

これでアップグレード・プロセスが完了しました。

アップグレードするデータベース・プールが複数ある場合は、構成がすでに移行されているため、--legacy-configオプションを除外してinstallコマンドを再度実行します。 

ords --config /path/to/new/conf install -i --log-folder /path/to/logs
 
. . .
  Enter a number to select the type of installation
    [1] Install or upgrade ORDS in the database only
    [2] Create or update a database pool and install/upgrade ORDS in the database
    [3] Create or update a database pool only
  Choose [1]:

オプション1を選択します

2.3.1.2 サイレント・アップグレード
サイレント・アップグレードを実行するには、次のものを指定する必要があります。
  • レガシー構成の場所
  • 管理者ユーザーのデータベース・パスワード
データベース・パスワードは、テキスト・ファイルまたはHereドキュメントを使用して指定できます。テキスト・ファイルを使用する場合は、アップグレードが完了したら必ずテキスト・ファイルを削除してください。apexという名前のレガシー構成のデータベース・プールが移行され、名前がdefaultに変更されます。

--database-pool <name>オプションを省略すると、デフォルトのデータベース・プールを使用してアップグレードします。

テキスト・ファイルの使用

パスワードを含むテキスト・ファイルを使用して標準入力をリダイレクトできます。アップグレード操作が完了したら、テキスト・ファイルを削除します。
ords --config <folder> install --admin-user <user> --legacy-config <folder> --log-folder <folder>
      --password-stdin <  <text-file>

<text-file>と1 passwordを使用する場合の例

The text file contains 1 password for --admin-user <user>

ords --config /path/to/new/conf install --admin-user SYS --legacy-config /path/to/legacy/conf 
--log-folder /path/to/logs --password-stdin < adminpwd.txt

Hereドキュメントの使用

パスワードにHereドキュメント(heredocとも呼ばれる)を使用して、標準入力をリダイレクトできます。アップグレード操作が完了すると、heredocは、<<リダイレクション演算子とその後のデリミタ・トークンで構成されます。パスワードを含むスクリプトを使用している場合は、スクリプトを削除します。 

ords --config <folder> install --admin-user <user> --legacy-config <folder> --log-folder <folder> --password-stdin <<  <delimiter-token>
> <password>
> <delimiter-token>
ords --config /path/to/new/conf install --admin-user SYS --legacy-config /path/to/legacy/conf --log-folder
        /path/to/logs --password-stdin << EOF
> <password for admin-user>
> EOF

2.4 Oracle REST Data Servicesのアンインストール

この項では、ORDSスキーマのアンインストールに使用される対話型および非対話型のアンインストールCLIコマンドについて説明します。

2.4.1 対話型のアンインストールCLI

対話型アンインストールCLIでは、データベースからORDSスキーマ、ORDSプロキシ・ユーザーおよび関連データベース・オブジェクトをアンインストールするために必要な情報の入力が求められます。

プロンプトを表示するには、次のいずれかのコマンドを実行する必要があります。
  • uninstallコマンドのみを指定します。例: $ ords uninstall

    ノート:

    構成フォルダが環境変数を介して指定されているか、現行作業ディレクトリにデフォルト設定されていることを前提としています。
  • オプション--config <configuration folder>の後に、uninstallコマンドを指定します。例: $ ords --config /path/to/config uninstall
  • --interactiveオプションを指定します。

    例: $ ords --config /path/to/config uninstall --interactive

表2-5 対話型アンインストールのプロンプト

プロンプト番号 プロンプト 説明
1. 
Enter a number to select the database pool to use or create the database pool
[1] default jdbc:oracle:thin:@//localhost:1521/orcl
[2] Specify the database connection 
Choose [1]:
 「データベース・プールを選択するための番号の入力」を参照してください
2. 
Enter a number to select the database connection type to use
    [1] Basic (host name, port, service name)
    [2] TNS (TNS alias, TNS directory)
    [3] Custom database URL
  Choose [1]:
 「データベース接続タイプを選択するための番号の入力」を参照してください
3. 
Enter the database host name [localhost]:
 「データベース・ホスト名の入力」を参照してください
4. 
Enter the database listen port [1521]:
 「データベース・リスナー・ポートの入力」を参照してください
5. 
Enter the database service name [orcl]:
 「データベース・サービス名の入力」を参照してください
6. 
Enter the TNS location: /path/to/tns
 「TNSの場所の入力」を参照してください
7. 
Enter a number to select the TNS Network alias to use
    [1] DB1  ...CONNECT_DATA=(SERVER=DEDICATED)(SERVICE_NAME=pdb1)))
    [2] DB2  ...CONNECT_DATA=(SERVER=DEDICATED)(SERVICE_NAME=pdb2)))     
    [3] DB3  ...CONNECT_DATA=(SERVER=DEDICATED)(SERVICE_NAME=pdb3)))     
  Choose [1]:
「TNSネットワーク別名を選択するための番号の入力」を参照してください
8. 
Enter the Custom database URL:
 「カスタム・データベースURLの入力」を参照してください
9. 
Provide database username with administrator privileges.
    Enter the administrator username: SYS
「管理者ユーザー名の入力」を参照してください
10. Enter the database password for SYS AS SYSDBA: 「SYS AS SYSDBAのデータベース・パスワードの入力」を参照してください
11. 
ORDS contains 1 enabled/disabled schema: HR

  Uninstall ORDS in the database
    [1] Yes
    [2] No
  Choose [2]:
 「ORDSをアンインストールするためのオプションの入力」を参照してください
2.4.1.1 データベース・プールを選択するための番号の入力
このプロンプトが表示されるのは、構成プールが構成フォルダに存在する場合のみです。
  • データベース・プールを選択すると、データベース接続タイプがバイパスされ、管理者のユーザー名とパスワードの入力が求められます。
  • オプション2を選択すると、プロンプト番号2が表示されます。

ノート:

構成プールが構成フォルダに存在しない場合は、データベース接続タイプを入力するように求められます。
2.4.1.2 データベース接続タイプを選択するための番号の入力

データベース接続タイプを選択します。

2.4.1.3 データベース・ホスト名の入力

基本接続のデータベース・ホスト名を指定します。

2.4.1.4 データベース・リスナー・ポートの入力

基本接続のデータベース・ポートを指定します。

2.4.1.5 データベース・サービス名の入力
サービス名を指定します。サービス名のデフォルト値は、指定された順序で次のいずれかから取得されます。
  1. ORDS構成ファイルのサービス名設定。存在しない場合は次が行われます
  2. ORACLE_PDB環境変数がチェックされます。未定義の場合は次が行われます
  3. ORACLE_SID環境変数がチェックされます。未定義の場合は次が行われます
  4. orclがデフォルト値として使用されます。
2.4.1.6 TNSの場所の入力

tnsnames.oraファイルの場所を指定します。場所は、tnsnames.oraファイルがあるフォルダ、またはTNS接続用のtnsnames.oraファイルを含むzipファイルになります。

2.4.1.7 TNSネットワーク別名を選択するための番号の入力

表示されるTNSネットワーク別名のリストからTNS別名を選択します。

2.4.1.8 カスタム・データベースURLの入力

カスタム・データベースURL接続のカスタム・データベースURLを指定します。

2.4.1.9 管理者ユーザー名の入力

データベースにORDSをインストールまたはアップグレードするインストーラ権限を持つユーザーを指定します。

関連項目:

Oracle REST Data Servicesユーザーに付与される権限
2.4.1.10 SYS AS SYSDBAのデータベース・パスワードの入力

管理者ユーザーのパスワードを指定します。

2.4.1.11 ORDSをアンインストールするためのオプションの入力

ORDSの有効または無効なスキーマが存在し、--forceコマンド・オプションが指定されていない場合、有効または無効なスキーマが表示され、データベースのORDSをアンインストールするための確認を求められます。

--forceコマンド・オプションが指定されている場合、アンインストールの確認は表示されません。

2.4.2 非対話型のアンインストールCLI

非対話型アンインストールCLIでは、データベースからORDSスキーマ、ORDSプロキシ・ユーザーおよび関連データベース・オブジェクトがアンインストールされます。

非対話型アンインストールCLIのコマンド・オプションを指定します。必要なオプション(接続のdb-portなど)がない場合、プロンプトは表示されません。かわりに、エラーが返されます。

2.4.2.1 入力リダイレクションの使用

この項では、Hereドキュメントまたはファイルを使用して標準入力をリダイレクトする方法について説明します。

ファイルへの標準入力のリダイレクト

パスワードを含むファイルにSTDINをリダイレクトします。次の例では、ファイルに1つのパスワードが含まれています。

例:
$ cat adminpwd.txt
password

このパスワードはコマンドラインの管理者ユーザー(SYSなど)に属します。この例では、configフォルダおよびdb1プールがすでに存在することを前提としています。

ords --config /path/to/conf uninstall --db-pool db1 --admin-user SYS --log-folder /path/to/logs --password-stdin < adminpwd.txt

Hereドキュメントを使用した標準入力のリダイレクト

パスワードにHereドキュメント(heredocとも呼ばれる)を使用してSTDINをリダイレクトします。heredocは、<<リダイレクション演算子と、その後に続くデリミタ・トークンで構成されます。

パスワードは個別の行に指定する必要があり、デリミタ・トークンで終了します。

例:

ords --config <configuration_folder> uninstall --db-pool <pool_name> --admin-user <username> 
--db-hostname <host> --db-port <port_number> --db-servicename <service_name> --log-folder <log_folder> 
--password-stdin << EOF
<password>
EOF

このパスワードはコマンドラインの管理者ユーザー(SYSなど)に属します。 

ords --config /path/to/config uninstall --db-pool db1 --admin-user SYS --db-hostname
      localhost --db-port 1521 --db-servicename orcl --log-folder /path/to/logs << EOF
<password>
EOF
2.4.2.2 アンインストールCLIのコマンド・オプション

表2-6 アンインストールCLIのコマンド・オプション

オプション 説明
--admin-user <USERNAME> データベースでORDSをインストール、アップグレード、修復またはアンインストールする権限を持つユーザーを指定します。
--bequeath-connect クライアントがネットワーク・リスナーをバイパスしてOracleデータベースに直接接続できるようにする継承接続を指定します。これは、クライアントがデータベースと同じサーバー上に存在する場合に発生します。
--config <CONFIG_PATH> 構成ファイルを含むフォルダのパスを指定します。
--db-pool <POOL_NAME> データベース・プールの名前を指定します。
--db-custom-url <URL> ユーザー指定のカスタムURLを指定します。
-db-hostname <HOST>- データベース・ホスト名を指定します。
--db-port <PORT> データベース・ポートを指定します。
--db-servicename <SERVICENAME> データベース・サービス名を指定します。
--db-sid <SID> データベースSIDを指定します。
--db-tns-alias <ALIAS_NAME> tnsnames.oraファイルに存在するtns別名を指定します。
-db-tns-dir <TNS_DIR>- tnsnames.oraファイルがあるフォルダを指定します。
--force ORDSの有効/無効なスキーマの数にかかわらず、ORDSをデータベースからアンインストールできることを指定します。
--help, -h コマンドの使用方法を示します。
--interactive, -i 必要なすべての情報をユーザーに要求します。
--log-folder

インストール、アップグレード、修復またはアンインストールのログをログ・フォルダに書き込みます。このオプションを省略すると、出力は標準出力に書き込まれます。
-password-stdin ORDSのインストールまたはアンインストール・コマンドを非対話的に実行する場合に指定します。このオプションを使用して、入力をファイルまたはhereドキュメントにリダイレクトするときに標準入力からパスワード値を読み取ることができます。--password-stdinオプションとリダイレクト記号(「<」または「<<」)を省略すると、パスワードを必要とするコマンド・オプションに対してパスワードを入力するよう求められます。
--pdb-open-readwrite-all

CDBに適用可能なオプションを指定します。

PDBのステータスがクローズまたは読取り専用である場合に、すべてのPDBを読取り/書込みモードでオープンするかどうかを指定します。
--pdb-open-readwrite <(PDB...)>

CDBに適用可能なオプションを指定します。

ORDSをアンインストールするために、読取り/書込みで開かれる、読取り専用またはクローズのPDBのリストを指定します。

2.5 構成設定の更新

ORDS configコマンドは、構成ファイル内のグローバル設定およびデータベース・プール固有の設定の内容を更新および編集するために使用されます。

configコマンドは、サブコマンドのリストで構成されます。configコマンドには、設定を適用するデータベース・プールを識別する--db-pool <POOL_NAME>オプションがあります。このオプションを省略すると、デフォルトのデータベース・プール設定が更新されます。

ords config [OPTIONS] [SUB-COMMAND]

説明:
  • オプション:
    • --db-pool <string>: 構成するデータベース接続プールの名前
    • -h, --help: コマンドの使用情報を表示します
  • サブコマンド: delete、get、info、list、secret、setおよびuser

info

次に、サブコマンドのリストとその説明を示します。

指定されたキーの説明を示し、その目的を説明します。それが機密値であるかどうか、およびデフォルト値を示します。

例: ords config info <KEY>

set

configキーを値に設定します。設定をグローバル・レベルで設定する場合は、--globalオプションを使用します。

例: ords config set [--global] <KEY> <VALUE>

secret

機密値を設定します(接続プールのパスワードなど)。ords config secretを使用して、機密値を設定します。一部の値は機密です(例: db.password)。Oracle Secure Coding Standardsに従って、このような値をコマンドライン引数として渡さないようにしてください。値の漏洩につながるためです(ps出力に含められます)。

例: ords config secret --password-stdin <KEY> < <file>

ノート:

機密値に対してords config setを実行しようとすると、エラーが返されます。

非対話型の例:

--password-stdinオプションが指定されている場合、値はstdinから読み取られます。

例:

ords config secret --password-stdin db.password < secret.txt

対話型の例

--password-stdinが指定されていない場合、ユーザーはシークレット値の入力および確認を求められます。

例:

ords config secret db.password

get

構成値をstdoutにエコーします。値がシークレットの場合、その値はテキスト******に置き換えられます。シークレットのプレーン・テキストを表示する場合は、--secret引数を使用します。

例: ords config get [--global] [--secret] <KEY>

list

プール設定およびグローバル設定に対して明示的に構成された値をすべて表示します。シークレット値は、テキスト******に置き換えられます。-–include-defaultsを使用して、デフォルト値を含むすべての設定をリストします。

例: ords config list [--include-defaults]

この情報には、設定の名前、値およびソースの場所(グローバル構成、プール固有の構成またはグローバル/プール・ウォレット)がリストされます。この表には、次のような列が含まれます
  • Setting: 設定の名前
  • Value: 設定の値
  • Source: グローバル/プール固有の設定の場所

たとえば、出力は次のようになります。

Configuration: /path/to/conf/
 
Database pool: default
 
Setting                        Value                      Source
-------------------         ---------------            ------
db.connectionType           basic                      Pool       
db.hostname                 localhost                  Pool       
db.password                 ******                     Pool Wallet
db.port                     1521                       Pool       
db.servicename              orcl                       Pool       
db.username                 ORDS_PUBLIC_USER           Pool       
feature.sdw                 true                       Pool       
restEnabledSql.active       true                       Pool
Source列は、設定値の元を示します。設定値は次のいずれかになります。
  • Default: 設定のデフォルト値を使用します
  • Global: 値はglobal/settings.xml構成ファイルで指定されます
  • Pool:値はプールで明示的に構成されます
  • Pool Wallet:(機密)値はプール・ウォレットで明示的に構成されます

user delete

構成からキーを削除します。

例: delete [--global]

user add

資格証明ファイルにユーザーとそのパスワードおよびロールを追加します。そのユーザーがすでに存在する場合は更新されます。

非対話型

STDINから読み取るためのオプション--password-stdinを含めます。ユーザーのパスワード・ファイルが必要です。

例: 
ords config user add --password-stdin <USERNAME> roles <ROLES> < userpwd.txt

対話型

--password-stdinオプションを省略すると、パスワードの入力を求められます。

例: 
ords config user add <USERNAME> roles <ROLES>

Enter the password:
Confirm password:

user delete

ords config user delete <USERNAME>

指定されたユーザーを削除します。

user get

ords config user get <USERNAME>

指定されたユーザーを取得します。

user list

ords config user list

資格証明ファイル内のユーザーをリストします。

関連項目: