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

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

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

トピック:

関連トピック

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

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

ノート:

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

Oracle API for MongoDBの使用を計画している場合は、Oracle REST Data Servicesを非CDBまたはPDBにインストールする必要があります。詳細は、「Oracle Database API for MongoDBの有効化と構成」を参照してください。

次に、次のいずれかのオプションを使用して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以前の構成ファイルは、構成フォルダに移行されます。

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

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

例:

ords --config /path/to/conf install
環境変数:

ノート:
このオプションは、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
```
現行作業ディレクトリ:
--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)インストール・プロンプトにある自動インストール機能を使用する様々なシナリオを説明します。

次の各項で説明するシナリオのプロンプトを表示するには、次のいずれかのコマンドを実行する必要があります:

表2-1 ORDS CLIコマンド

ORDS CLIコマンド	説明
`ords install`	データベース・プールを作成するか、既存のデータベース・プールのORDSをアップグレードします。ORDS構成に複数のデータベース・プールが存在する場合は、アップグレード・スクリプトを生成します。
`ords install -i --db-only`	データベース・プール内のORDSをインストールまたはアップグレードするか、データベース接続を指定します。ORDS構成に複数のデータベース・プールが存在する場合は、アップグレード・スクリプトを生成します。このコマンドでは、ORDS構成は作成も更新もされません。
`ords install -i --config-only`	データベース・プールを作成または更新します。このコマンドは、データベースのORDSをインストールまたはアップグレードしません。

構成フォルダ

--config <CONFIG FOLDER>オプションを指定せずにインストール・コマンドを指定します。これは、構成ディレクトリが環境変数を介して指定されているか、現行作業ディレクトリにデフォルト設定されていることを前提としています。

例:

ords install
ords install -i --config-only
ords install -i --db-only

--config <CONFIG FOLDER>オプションを使用して、installコマンドを指定します。ORDSは、使用されたORDS CLIコマンドに応じて、その構成フォルダを使用して構成を作成または更新するか、その<CONFIG FOLDER>の場所から既存の構成を読み取ります。

例:

ords --config /path/to/myconfig install
ords --config /path/to/myconfig install -i --config-only
ords --config /path/to/myconfig install -i --db-only

2.1.3.1 ORDSの自動インストール

Oracle REST Data Services (ORDS)リリース24.1以降、自動インストール機能が導入されました。

自動インストール操作では、データベース接続を検出し、ユーザーに表示します。データベース・プールの作成ははるかに簡単で、ユーザーへのプロンプトを最小限に抑えるためにデフォルト設定が使用されます。継承接続が使用可能な場合は、データベースからの情報を取得し、管理者ユーザーの資格証明を使用せずにデータベースにORDSをインストールまたはアップグレードするために使用されます。

関連項目:

対話型インストールのための継承接続の設定

自動インストール機能を示すシナリオの一部を次に示します:

2.1.3.1.1 シナリオ1: 新規ORDS構成およびORDSインストール

この項では、新しいORDS構成を作成するための対話型のコマンドライン・インタフェース(CLI)インストールのプロンプトについて説明します。

次のORDS CLIコマンドを実行します:

ords install

前述のコマンドを実行すると、対話型のインストーラはORDS構成が存在しないことを検出します。デフォルトのデータベース・プールが作成されます。「追加のデータベース・プールの作成」を参照してください。デフォルトのデータベース・プールを作成し、データベースにORDSをインストールするよう求められます。

2.1.3.1.2 シナリオ2: 単一データベース・プール(デフォルト・プール)

次のORDS CLIコマンドを実行します:

ords install

新しいORDS構成を作成すると、デフォルト・プールが作成されます。このシナリオでは、defaultデータベース・プールと呼ばれるデータベース・プールが1つのみ存在することを示します。デフォルトのデータベース・プールを選択し、データベースのORDSをアップグレードするオプションがあります。追加のデータベース・プールを作成するオプションもあります。

表2-2 単一データベース・プールのプロンプト

プロンプト	説明
`Enter a number to select the database pool to upgrade ORDS or create an additional database pool [1] default jdbc:oracle:thin:@DB1?TNS_ADMIN=/path/to/myfolder [C] Create an additional database pool`	参照先データベース・プールを選択するための番号の入力追加のデータベース・プールの作成

2.1.3.1.3 シナリオ3: 複数のデータベース・プール

このシナリオでは、構成に複数のデータベース・プールが存在する場合、既存のデータベース・プールでORDSをアップグレードしたり、アップグレード・スクリプトを生成したり、ORDSをアップグレードするデータベース・プールを指定したり、追加のデータベース・プールを作成したりできます。

構成内のデータベース・プールのリストを表示します。デフォルトのデータベース・プールが最初に表示され、その後に他のデータベース・プールがアルファベット順に表示されます。

次のORDS CLIコマンドを実行します:

ords install

表2-3 複数のデータベース・プールのプロンプト

プロンプト説明

プロンプト	説明
Enter a number to select the database pool to upgrade ORDS. Total database pools is 12. Showing only the first 9 database pools. Additional options to Generate script, Specify a database pool, or Create additional database pool. [1] default jdbc:oracle:thin:@MYPDB?TNS_ADMIN=/path/to/my/folder [2] exampledb1 jdbc:oracle:thin:@DB1?TNS_ADMIN=/path/to/my/folder [3] exampledb2 jdbc:oracle:thin:@DB2?TNS_ADMIN=/path/to/my/folder [4] exampledb3 jdbc:oracle:thin:@DB3?TNS_ADMIN=/path/to/my/folder [5] fxdb50 jdbc:oracle:thin:@//localhost:1521/fxdb50 [6] hrdb105 jdbc:oracle:thin:@//myhr.xyzcorp.com:1521/hrdb [7] sampledb7 jdbc:oracle:thin:@//my-dev.sample.com:1523/db7 [8] sampledb8 jdbc:oracle:thin:@//my-dev.sample.com:1523/db8 [9] sampledb9 jdbc:oracle:thin:@//my-dev.sample.com:1523/db9 [G] Generate script to upgrade ORDS in all the database pools [S] Specify the database pool name to upgrade ORDS [C] Create an additional database pool Choose [1]:	データベース・プールの合計数が9より大きい場合は、オプション`「ORDSをアップグレードするデータベース・プール名を指定します」`が表示されます。参照先: データベース・プールを選択するための番号の入力アップグレード・スクリプトの生成 ORDSをアップグレードするデータベース・プール名を指定します追加のデータベース・プールの作成

Enter a number to select the database pool to upgrade ORDS. Total database pools is 12.   
Showing only the first 9 database pools. Additional options to Generate script, Specify a database pool, 
or Create additional database pool.
    [1] default      jdbc:oracle:thin:@MYPDB?TNS_ADMIN=/path/to/my/folder
    [2] exampledb1   jdbc:oracle:thin:@DB1?TNS_ADMIN=/path/to/my/folder
    [3] exampledb2   jdbc:oracle:thin:@DB2?TNS_ADMIN=/path/to/my/folder
    [4] exampledb3   jdbc:oracle:thin:@DB3?TNS_ADMIN=/path/to/my/folder
    [5] fxdb50       jdbc:oracle:thin:@//localhost:1521/fxdb50
    [6] hrdb105      jdbc:oracle:thin:@//myhr.xyzcorp.com:1521/hrdb
    [7] sampledb7    jdbc:oracle:thin:@//my-dev.sample.com:1523/db7
    [8] sampledb8    jdbc:oracle:thin:@//my-dev.sample.com:1523/db8
    [9] sampledb9    jdbc:oracle:thin:@//my-dev.sample.com:1523/db9
    [G] Generate script to upgrade ORDS in all the database pools
    [S] Specify the database pool name to upgrade ORDS
    [C] Create an additional database pool
Choose [1]:

データベース・プールの合計数が9より大きい場合は、オプション「ORDSをアップグレードするデータベース・プール名を指定します」が表示されます。

参照先:

2.1.3.1.4 シナリオ4: 構成の追加または更新のみ

次のORDS CLIコマンドを実行します:

ords install -i --config-only

このシナリオを使用すると、既存のデータベース・プールを更新したり、データベース・プールを作成できます。--config-onlyオプションは、データベースでORDSのインストールまたはアップグレード操作を実行しません。

表2-4 構成の追加/更新のみのプロンプト

プロンプト説明

プロンプト	説明
`Enter a number to select the database pool to update, or create an additional database pool. [1] default jdbc:oracle:thin:@MYPDB?TNS_ADMIN=/path/to/my/folder [2] exampledb1 jdbc:oracle:thin:@DB1?TNS_ADMIN=/path/to/my/folder [3] sampledb7 jdbc:oracle:thin:@//my-dev.sample.com:1523/db7 [C] Create an additional database pool Choose [1]:`	参照先: データベース・プールおよびスタンドアロン構成の複数オプション追加のデータベース・プールの作成

Enter a number to select the database pool to update, or create an additional database pool.
   [1] default      jdbc:oracle:thin:@MYPDB?TNS_ADMIN=/path/to/my/folder
   [2] exampledb1   jdbc:oracle:thin:@DB1?TNS_ADMIN=/path/to/my/folder
   [3] sampledb7    jdbc:oracle:thin:@//my-dev.sample.com:1523/db7
   [C] Create an additional database pool
Choose [1]:

参照先:

2.1.3.1.5 シナリオ5: データベースのORDSのインストールまたはアップグレードのみ

次のORDS CLIコマンドを実行します:

ords install -i --db-only

このシナリオを使用すると、データベース内のORDSのみをインストールまたはアップグレードできます。構成に複数のデータベース・プールが存在する場合は、次のオプションがあります:

既存のデータベース・プールでのORDSのアップグレード
アップグレード・スクリプトの生成
データベース接続またはデータベース・プールを指定してデータベースでORDSをインストールまたはアップグレードする

構成内のデータベース・プールのリストを表示します。

デフォルトのデータベース・プールが最初に表示され、その後に他のデータベース・プールがアルファベット順に表示されます。最大9個のデータベース・プールが表示されます。データベース・プールの最大数に達すると、オプション「ORDSをアップグレードするデータベース・プール名を指定します」が表示されます。

表2-5 データベースのORDSのインストールまたはアップグレードのみのプロンプト

プロンプト説明

プロンプト	説明
Enter a number to select the database pool to upgrade ORDS. Total database pools is 12. Showing only the first 9 database pools. Additional options to Generate script, Specify a database pool or database connection to upgrade ORDS. [1] default jdbc:oracle:thin:@MYPDB?TNS_ADMIN=/path/to/my/folder [2] exampledb1 jdbc:oracle:thin:@DB1?TNS_ADMIN=/path/to/my/folder [3] exampledb2 jdbc:oracle:thin:@DB2?TNS_ADMIN=/path/to/my/folder [4] exampledb3 jdbc:oracle:thin:@DB3?TNS_ADMIN=/path/to/my/folder [5] fxdb50 jdbc:oracle:thin:@//localhost:1521/fxdb50 [6] hrdb105 jdbc:oracle:thin:@//myhr.xyzcorp.com:1521/hrdb [7] sampledb7 jdbc:oracle:thin:@//my-dev.sample.com:1523/db7 [8] sampledb8 jdbc:oracle:thin:@//my-dev.sample.com:1523/db8 [9] sampledb9 jdbc:oracle:thin:@//my-dev.sample.com:1523/db9 [G] Generate script to upgrade ORDS in all the database pools [S] Specify the database connection to install/upgrade ORDS [P] Specify the database pool name to upgrade ORDS Choose [1]:	データベース・プールの合計数が9より大きい場合は、オプション`「ORDSをアップグレードするデータベース・プール名を指定します」`が表示されます。参照先: データベース・プールを選択するための番号の入力アップグレード・スクリプトの生成データベース接続を選択するための番号の入力 ORDSをアップグレードするデータベース・プール名を指定します

Enter a number to select the database pool to upgrade ORDS. Total database pools is 12. 
Showing only the first 9 database pools. Additional options to Generate script, 
Specify a database pool or database connection to upgrade ORDS.
    [1] default      jdbc:oracle:thin:@MYPDB?TNS_ADMIN=/path/to/my/folder
    [2] exampledb1   jdbc:oracle:thin:@DB1?TNS_ADMIN=/path/to/my/folder
    [3] exampledb2   jdbc:oracle:thin:@DB2?TNS_ADMIN=/path/to/my/folder
    [4] exampledb3   jdbc:oracle:thin:@DB3?TNS_ADMIN=/path/to/my/folder
    [5] fxdb50       jdbc:oracle:thin:@//localhost:1521/fxdb50
    [6] hrdb105      jdbc:oracle:thin:@//myhr.xyzcorp.com:1521/hrdb
    [7] sampledb7    jdbc:oracle:thin:@//my-dev.sample.com:1523/db7
    [8] sampledb8    jdbc:oracle:thin:@//my-dev.sample.com:1523/db8
    [9] sampledb9    jdbc:oracle:thin:@//my-dev.sample.com:1523/db9
    [G] Generate script to upgrade ORDS in all the database pools
    [S] Specify the database connection to install/upgrade ORDS
    [P] Specify the database pool name to upgrade ORDS
Choose [1]:

参照先:

2.1.3.1.5.1 データベース・プールを選択するための番号の入力

データベース・プールとその接続が表示されます。番号を入力して、データベースのORDSをインストールまたはアップグレードするデータベース・プールを選択します。ORDSがデータベースに存在しない場合、インストーラはデータベースにORDSをインストールします。ORDSスキーマ・バージョンが使用しているORDS製品バージョンより小さい場合、インストーラはデータベース内のORDSをアップグレードします。

2.1.3.1.6 追加のデータベース・プールの作成

「追加のデータベース・プールを作成します」オプション

「追加のデータベース・プールを作成します」オプションでは、次の情報の入力を求められます:

データベース・プール名
- ORDS構成にデータベース・プールがすでに存在する場合は、データベース・プール名の入力を求められます。
  
  ノート:
  新しいORDS構成を作成する場合は、デフォルトのデータベース・プールが作成されるため、データベース・プール名の入力を求められません。
接続情報
- tnsnames.oraファイルのTNSネット・サービス名を表示します。TNSネット・サービス名を選択するオプションがあります。
  - フォルダ内のtnsnames.oraファイルを自動的に検索します。
- データベース接続(「基本」、「TNS」または「カスタムURL」)を指定します。
管理者のユーザー名とパスワード

ノート:
継承接続を使用していて、ホストとservicenameまたはsidがデータベースに存在する場合、管理者のユーザー名とパスワードの入力を求められません。
データベース・プールおよびスタンドアロン構成を更新するための複数のオプション
- 接続情報
- ランタイム・ユーザーORDS_PUBLIC_USERパスワード
- ORDSランタイム・ユーザーおよびORDSスキーマのデフォルト表領域および一時表領域
- 追加のORDS機能
- スタンドアロン・モード構成
  - HTTP/HTTPSプロトコル
  - プロトコル・ポート
  - HTTPSプロトコルの証明書タイプ
    - 自己署名証明書
    - ユーザーが提供する証明書
  - APEX静的リソースの場所
    
    ノート:
    APEXがデータベースに存在する場合は、「APEX静的リソースの場所」オプションが表示されます。

データベース・プールおよびスタンドアロン構成の複数のオプションが表示され、更新を行うことができます。表示される値に問題がない場合は、オプションAを選択し、同意および続行します。オプションに「同意して続行 - 構成を作成し、データベースのORDSをインストールします」が含まれる場合、データベース・プールが作成され、ORDSがデータベースにインストールされます。オプション「ORDSをスタンドアロン・モードで構成および起動する」を有効にすると、スタンドアロン設定が作成または更新され、インストールの完了後にORDSが実行されます。

例2-1 追加のデータベース・プールの作成

Enter the database pool name: database2

Enter a number to select the TNS Net Service Name to use or specify the database connection
    [1] TNS name: DB2  SERVICE_NAME=pdb2                                   
    [2] TNS name: DB3  SERVICE_NAME=pdb3                                   
    [3] TNS name: DB4  SERVICE_NAME=pdb4                                   
    [S] Specify the database connection
Choose [1]: 1
  
Connecting to administrator user: SYS AS SYSDBA for PDB service name: pdb2 using bequeath connection
  
ORDS is not installed in the database. ORDS installation is required.
  
Enter a number to update the value or select option A to Accept and Continue
  [1] Connection Type: TNS
  [2] TNS Connection: TNS_NAME=DB2 TNS_FOLDER=/path/to/myfolder
         Administrator User: SYS AS SYSDBA via Bequeath Connect
  [3] Database password for ORDS runtime user (ORDS_PUBLIC_USER): <generate>
  [4] ORDS runtime user and schema tablespaces:  Default: SYSAUX Temporary TEMP
  [5] Additional Feature: Database Actions
  [6] Configure and start ORDS in Standalone Mode: Yes
  [7]    Protocol: HTTPS
  [8]       HTTPS Port: 8443
  [9]    Certificate Type: Use Self-Signed Certificate
  [10]      SSL Hostname: myhost
  [11]   APEX static resources location: /path/to/apex/images
  [A] Accept and Continue - Create configuration and Install ORDS in the database
  [Q] Quit - Do not proceed. No changes
Choose [A]:

表2-6 追加のデータベース・プールの作成プロンプト

プロンプト	説明
`Enter the database pool name: database2`	ORDS構成がすでに存在し、データベース・プールが含まれている場合は、データベース・プール名の入力を求められます。ノート: 新しい構成を作成する場合は、`default`という名前のデータベース・プールが作成されるため、データベース・プール名の入力を求められません。「データベース・プール名の入力」を参照してください
`Enter a number to select the TNS Net Service Name to use or specify the database connection [1] TNS name: DB2 SERVICE_NAME=pdb2 [2] TNS name: DB3 SERVICE_NAME=pdb3 [3] TNS name: DB4 SERVICE_NAME=pdb4 [S] Specify the database connection Choose [1]:`	参照先番号の入力による、使用するTNSネット・サービス名の選択またはデータベース接続の指定データベース接続を選択するための番号の入力
`Provide database user name with administrator privileges. Enter the administrator username: SYS Enter the database password for SYS AS SYSDBA:`	ノート: 継承接続を使用していて、ホストとservicenameおよびsidがデータベースに存在する場合、管理者のユーザー名またはパスワードの入力を求められません。
Enter a number to update the value or select option A to Accept and Continue [1] Connection Type: TNS [2] TNS Connection: TNS_NAME=DB2 TNS_FOLDER=/path/to/myfolder Administrator User: SYS AS SYSDBA via Bequeath Connect [3] Database password for ORDS runtime user (ORDS_PUBLIC_USER): <generate> [4] ORDS runtime user and schema tablespaces: Default: SYSAUX Temporary TEMP [5] Additional Feature: Database Actions [6] Configure and start ORDS in Standalone Mode: Yes [7] Protocol: HTTPS [8] HTTPS Port: 8443 [9] Certificate Type: Use Self-Signed Certificate [10] SSL Hostname: myhost [11] APEX static resources location: /path/to/apex/images [A] Accept and Continue - Create configuration and Install ORDS in the database [Q] Quit - Do not proceed. No changes Choose [A]:	データベース・プールのデフォルト値が青色で強調表示されます。 ORDS構成にすでに存在するスタンドアロン設定を表示します。これらの設定は、オプション`「ORDSをスタンドアロン・モードで構成および起動する」`の後に表示されます。「データベース・プールおよびスタンドアロン構成の複数オプション」を参照してください

2.1.3.1.6.1 データベース・プール名の入力

オプション「追加のデータベース・プールを作成します」を選択すると、データベース・プール名が表示されます。データベース・プール名はマッピング・パターンを設定するため、慎重に指定します。

プロンプトが表示されたら、オプションcを選択すると、データベース・プール名のプロンプトが表示されます。データベース・プール名を入力します。たとえば、入力したプール名がdatabase1の場合、そのプールへのすべてのRESTリクエストは/ords/database1/で始まります。

ノート:

データベース・プール名に使用できるのは、小文字のアルファベットa-z、数字0-9および文字"-"、"_"および"."のみです。
データベース・プールが作成されると、データベース・プール・フォルダも、プール固有の設定およびデータベース・ユーザー資格証明を格納するウォレットとともに作成されます。
データベース・プール名によって、マッピング・パターンも設定されます。

新しいORDS構成を作成する場合は、データベース・プール名の入力を求められません。

2.1.3.1.6.2 番号の入力による、使用するTNSネット・サービス名の選択またはデータベース接続の指定

TNSネット・サービス名とそのサービス名またはSIDのリストは、tnsnames.oraファイルがフォルダにある場合に表示されます。tnsnames.oraがフォルダに存在しない場合は、データベース接続タイプのオプションが表示されます。

関連項目:

データベース接続を選択するための番号の入力

2.1.3.1.6.3 データベース接続を選択するための番号の入力

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

表2-7 データベース接続の選択のプロンプト

プロンプト説明

プロンプト	説明
`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]:`	参照先: 基本接続の入力 TNS接続の入力カスタムURL接続の入力

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]:

参照先:

2.1.3.1.6.3.1 基本接続の入力

データベース・ホスト名、データベース・リスナー・ポートおよびサービス名を指定します。

表2-8 基本接続の入力のプロンプト

プロンプト	説明
`Enter the database host name [localhost]:`	「データベース・ホスト名の入力」を参照してください
`Enter the database listen port [1521]:`	「データベース・リスナー・ポートの入力」を参照してください
`Enter the database service name [orcl]:`	「データベース・サービス名の入力」を参照してください

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

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

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

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

2.1.3.1.6.3.1.3 データベース・サービス名の入力

サービス名を指定します。サービス名のデフォルト値は、指定された順序で次のいずれかのオプションから取得されます:

ORDS構成ファイルのサービス名設定。存在しない場合は次が行われます
ORACLE_PDB環境変数がチェックされます。未定義の場合は次が行われます
ORACLE_SID環境変数がチェックされます。未定義の場合は次が行われます
orclがデフォルト値として使用されます。

2.1.3.1.6.3.2 TNS接続の入力

TNSフォルダの場所を指定し、TNSネットワーク別名を選択します。

表2-9 TNS接続プロンプト

プロンプト	説明
`Enter the TNS location: /path/to/myfolder`	「TNSの場所の入力」を参照してください
`Enter a number to select the TNS Network alias to use [1] DB1 SERVICE_NAME=pdb1 [2] DB2 SERVICE_NAME=pdb2 [3] FREEPDB1 SERVICE_NAME=freepdb1 Choose [1]:`	「TNSネットワーク別名を選択するための番号の入力」を参照してください

2.1.3.1.6.3.2.1 TNSの場所の入力

tnsnames.oraファイルがある有効なフォルダを指定します。

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

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

2.1.3.1.6.3.3 カスタムURL接続の入力

カスタムURL接続を指定します。

表2-10 カスタムURL接続プロンプト

プロンプト	説明
`Enter the Custom database URL: jdbc:oracle:thin:@//localhost:1521/orcl`	「カスタム・データベースURLの入力」を参照してください

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

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

URLフォーマットの例:

jdbc:oracle:<driver>:@//<host>:<port>/<servicename>
jdbc:oracle:thin:@//localhost:1521/orcl

jdbc:oracle:<drivertype>:@(DESCRIPTION=(ADDRESS=(PROTOCOL=TCP)(HOST=<host>)(PORT=<port>))(CONNECT_DATA=(SERVICE_NAME=<servicename>)))
jdbc:oracle:thin:@(DESCRIPTION=(ADDRESS=(PROTOCOL=TCP)(HOST=localhost)(PORT=1521))(CONNECT_DATA=(SERVICE_NAME=orcl)))

2.1.3.1.7 データベース・プールおよびスタンドアロン構成の複数オプション

データベース・プールを作成または更新する場合、複数のオプションにデータベース・プールおよびスタンドアロン構成プロンプトが表示されます。スタンドアロン構成オプションは、「ORDSをスタンドアロン・モードで構成および起動する」プロンプトの後に表示されます。

ノート:

データベース・プールがORDS構成にすでに存在する場合は、既存のスタンドアロン設定が表示されます。

オプション番号を入力して、設定の値を変更します。値に問題がなければ、[Enter]キーを押し、同意および続行します。

2.1.3.1.7.1 デフォルト値を使用する複数のオプション

新しいデータベース・プールの場合、次のデフォルト値が青色で強調表示されます:

ランタイム・ユーザー(ORDS_PUBLIC_USER)パスワードの生成
ORDSをデータベースにインストールする場合、デフォルト表領域のデフォルト値はSYSAUXで、一時表領域はTEMPです。

ノート:
これらの表領域が存在しない場合は、データベースのデフォルト表領域が使用されます。
追加機能のデフォルトは「データベース・アクション」です。
ORDSをスタンドアロン・モードでインストールする場合、「ORDSをスタンドアロン・モードで構成および起動する」はデフォルトで「はい」に設定されます。
プロトコルのデフォルトはHTTPです
「選択」のデフォルト値は[A]同意して続行です。

図2-1 デフォルト値を使用する複数のオプションの例

「図2-1 デフォルト値を使用する複数のオプションの例」の説明

表2-11 データベース・プールおよびスタンドアロン構成プロンプト

プロンプト	説明
`Connection Type: TNS`	接続のタイプ。基本、TNSまたはカスタムURLを表示します。「データベース接続を選択するための番号の入力」を参照してください
`Basic Connection: HOST=localhost PORT=1521 SERVICE_NAME=DB1`	接続タイプが基本の場合、基本接続を表示します。「基本接続の入力」を参照してください。
`TNS Connection: TNS_NAME=DB1 TNS_FOLDER=/path/to/myfolder`	接続タイプがTNSの場合、TNS接続を表示します。「TNS接続の入力」を参照してください
`Custom URL Connection: CUSTOM_URL=jdbc:oracle:thin:@//localhost:1521/DB1`	接続タイプがカスタムURLの場合、カスタムURL接続を表示します。「カスタムURL接続の入力」を参照してください
`Database password for ORDS runtime user (ORDS_PUBLIC_USER): <generate>`	デフォルトでは、パスワードが生成されます。「パスワード・オプションの入力」を参照してください
`ORDS runtime user and schema tablespaces: Default: SYSAUX Temporary TEMP`	データベースにORDSをインストールする場合にのみ、「表領域」オプションを表示します。「表領域の入力」を参照してください
`Additional Feature: Database Actions`	追加機能のデフォルトをデータベース・アクションに設定します。「追加機能を選択するための番号の入力」を参照してください
`Configure and start ORDS in Standalone Mode: Yes`	`「はい」`または`「いいえ」`に切り替えます。 ORDSをデータベースにインストールし、継承接続を使用しない場合のオプションを表示します。「スタンドアロン構成」を参照してください。
`Configure ORDS in Standalone Mode: Yes`	「はい」または「いいえ」に切り替えます継承接続または構成のみ(`--config-only`)オプションを使用する場合のオプションを表示します。「スタンドアロン構成」を参照してください。
`Protocol: HTTP`	プロトコルをHTTPにデフォルト設定します。「HTTPまたはHTTPSプロトコルを使用するための番号の入力」を参照してください
`HTTP Port: 8080`	HTTPポートを8080にデフォルト設定します。プロトコルがHTTPの場合、HTTPポートが表示されます。「HTTPまたはHTTPSプロトコルを使用するための番号の入力」を参照してください
`APEX static resources location: /path/to/apex/images`	「APEX静的リソースの場所の入力」を参照してください
`Accept and Continue - Create configuration and Install ORDS in the database`	「同意して続行オプション」を参照してください。

2.1.3.1.7.1.1 同意して続行オプション

値の更新および確認が完了したら、オプション[A]同意して続行を選択します。同意して続行には、実行内容に関するメッセージが表示されます。たとえば、「同意して続行 - 構成を作成し、データベースのORDSをインストールします」オプションを指定するとデータベース・プールが作成され、ORDSがデータベースにインストールされます。スタンドアロン・モードでのORDS構成が有効になると、スタンドアロン構成も作成または更新されます。

2.1.3.1.7.1.2 パスワード・オプションの入力

ORDS_PUBLIC_USERのランタイム・ユーザー・パスワードは、デフォルトでパスワードを生成します。パスワードを変更し、独自のパスワードを指定する場合は、オプションSを選択してパスワードを指定します。パスワードを2回要求されます。

表2-12 パスワード・オプション・プロンプトの例

プロンプト

プロンプト
`Enter your choice for the runtime user password (ORDS_PUBLIC_USER) [S] Specify your own password [G] Generate password [C] Cancel - No Changes Choose [G]: S Enter the database password for ORDS_PUBLIC_USER: Confirm password:`

Enter your choice for the runtime user password (ORDS_PUBLIC_USER)
   [S] Specify your own password
   [G] Generate password
   [C] Cancel - No Changes
Choose [G]: S

Enter the database password for ORDS_PUBLIC_USER: 
Confirm password:

2.1.3.1.7.1.3 表領域の入力

表領域オプションは、データベースにORDSをインストールする場合にのみ表示されます。ORDSデータベース・ランタイム・ユーザーおよびORDSスキーマのデフォルトおよび一時表領域を指定します。デフォルト表領域のデフォルト値はSYSAUXで、一時表領域のデフォルト値はTEMPです。

表2-13 表領域プロンプトの例

プロンプト
`Enter the default tablespace for ORDS_METADATA and ORDS_PUBLIC_USER [SYSAUX]: MYTABLESPACE`
`Enter the temporary tablespace for ORDS_METADATA and ORDS_PUBLIC_USER [TEMP]:`

2.1.3.1.7.1.4 追加機能を選択するための番号の入力

有効にする追加機能を指定します。

表2-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]:`

2.1.3.1.7.2 スタンドアロン構成

この項では、Oracle REST Data Services (ORDS)を構成し、スタンドアロン・モードで実行する方法について説明します。

表2-15 スタンドアロン構成のプロンプト

プロンプト説明

プロンプト	説明
`Configure and start ORDS in Standalone Mode:`	オプションを`「はい」`または`「いいえ」`に切り替えます。`「はい」`は、ORDSをスタンドアロン・モードで構成することを示します。また、ORDSのインストールまたはアップグレード・プロセスが完了すると、ORDSはスタンドアロン・モードで実行されます。`「いいえ」`は、スタンドアロン構成を変更せず、スタンドアロン・モードでORDSを実行しないことを示します。ノート: `「ORDSをスタンドアロン・モードで構成および起動する」`オプションは、ORDSをインストールしており、継承接続を使用していない場合にのみ表示されます。
`Configure ORDS in Standalone Mode`	オプションを`「はい」`または`「いいえ」`に切り替えられます。`「はい」`は、ORDSをスタンドアロン・モードで構成することを示します。`「いいえ」`は、スタンドアロン構成を変更しないことを示します。ノート: 「ORDSをスタンドアロン・モードで構成および起動する」オプションは、継承接続または構成のみ(`--config-only`)オプションを使用している場合のみ表示されます。継承接続を使用するようにOS環境を設定している場合は、`ords serve`コマンドを使用する前に、`JDK_JAVA_OPTIONS`に`useOracleHome=true`が含まれていないことを確認してください。環境変数`JDK_JAVA_OPTIONS`から`useOracleHome`を削除するか、`JDK_JAVA_OPTIONS`を設定解除します。 ORDSがデータベースにインストールされていて、ORDSをスタンドアロン・モードで実行する場合は、`ords serve`コマンドを使用します。

Configure and start ORDS in Standalone Mode:

オプションを「はい」または「いいえ」に切り替えます。「はい」は、ORDSをスタンドアロン・モードで構成することを示します。また、ORDSのインストールまたはアップグレード・プロセスが完了すると、ORDSはスタンドアロン・モードで実行されます。「いいえ」は、スタンドアロン構成を変更せず、スタンドアロン・モードでORDSを実行しないことを示します。

ノート:

「ORDSをスタンドアロン・モードで構成および起動する」オプションは、ORDSをインストールしており、継承接続を使用していない場合にのみ表示されます。

Configure ORDS in Standalone Mode

オプションを「はい」または「いいえ」に切り替えられます。「はい」は、ORDSをスタンドアロン・モードで構成することを示します。「いいえ」は、スタンドアロン構成を変更しないことを示します。

ノート:

「ORDSをスタンドアロン・モードで構成および起動する」オプションは、継承接続または構成のみ(--config-only)オプションを使用している場合のみ表示されます。
継承接続を使用するようにOS環境を設定している場合は、ords serveコマンドを使用する前に、JDK_JAVA_OPTIONSにuseOracleHome=trueが含まれていないことを確認してください。環境変数JDK_JAVA_OPTIONSからuseOracleHomeを削除するか、JDK_JAVA_OPTIONSを設定解除します。

ORDSがデータベースにインストールされていて、ORDSをスタンドアロン・モードで実行する場合は、ords serveコマンドを使用します。

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

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

ノート:

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

2.1.3.1.7.2.1.1 HTTPポートの入力

HTTPポートを指定します。デフォルトのHTTPポートは8080です。

2.1.3.1.7.2.2 HTTPSポートの入力

HTTPSポートを指定します。デフォルトのHTTPSポートは8443です。

表2-16 HTTPSプロトコルのプロンプト

プロンプト	説明
`Enter a number to select the protocol [1] HTTP [2] HTTPS Choose [1]:`	使用するプロトコル(HTTPまたはHTTPS)を選択します。
`Enter the HTTPS port [8443]:`	HTTPSポートを指定します。デフォルトのHTTPSポートは8443です。
`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]: 1`	参照先: 証明書タイプを選択するための番号の入力 HTTPSプロトコルおよび自己署名証明書の使用 HTTPSプロトコルおよびSSL証明書の使用

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

ORDSをスタンドアロン・モードで実行するときに自動的に生成される自己署名証明書を選択するか、SSL証明書とその秘密キーの両方を必要とするSSL証明書を指定できます。

2.1.3.1.7.2.4 HTTPSプロトコルおよび自己署名証明書の使用

プロンプト「自己署名証明書を使用する」を選択すると、SSLホスト名を入力するように求められます。

表2-17 自己署名証明書の使用例

プロンプト

プロンプト
`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]: 1 Enter the SSL hostname: myhost`

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]: 1

  Enter the SSL hostname: myhost

ORDSをスタンドアロン・モードで実行すると、ORDSによって自己署名証明書が生成されます。

表2-18 HTTPSプロトコルおよび自己署名証明書の使用のプロンプト

プロンプト	説明
`Certificate Type: Use Self-Signed Certificate`
`SSL Hostname: myhost`	SSLホスト名を指定します。

2.1.3.1.7.2.5 HTTPSプロトコルおよびSSL証明書の使用

「自分のSSL証明書を使用する」を選択すると、既存のSSL証明書とその秘密キーを指定する必要があります。

SSL証明書の使用例

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]: 2

 Enter the path for the SSL Certificate: /path/to/mycertificate.crt
 Enter the path for the SSL Certificates private key: /path/to/mycert.der

表2-19 HTTPSプロトコルおよびSSL証明書の使用のプロンプト

プロンプト	説明
`Certificate Type: Use my SSL Certificate`	「証明書タイプを選択するための番号の入力」を参照してください
`Path for the SSL Certificate: /path/to/mycert.crt`	「SSL証明書のパスの入力」を参照してください
`Path for the SSL Certificate private key: /path/to/mycert.der`	「SSL証明書の秘密キーのパスの入力」を参照してください

2.1.3.1.7.2.5.1 SSL証明書のパスの入力

SSL証明書ファイルの場所とファイル名を指定します。

例:

/path/to/mycert.crt

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

SSL証明書の秘密キー・ファイルの場所とファイル名を指定します。

例

/path/to/mycert.der

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

ORDSは、APEXがデータベースにインストールされているかどうか、およびデータベース・ユーザーAPEX_PUBLIC_USERが存在するかどうかを検出します。見つかった場合は、「APEX静的リソースの場所」オプションが表示されます。APEXイメージのフォルダの場所を指定します。

2.1.3.1.7.2.7 アップグレード・スクリプトの生成

オプション[G]「すべてのデータベース・プールでORDSをアップグレードするためのスクリプトを生成します」を選択すると、スクリプトの場所の入力を求められ、アップグレード・スクリプトが生成されます。アップグレード・スクリプトには、データベースのORDSをアップグレードするためのORDS非対話型(サイレント)コマンドが含まれており、使用するデータベース・プールが含まれています。このスクリプトは、シェル環境で実行できます。

表2-20 ORDSをアップグレードするスクリプトの生成のプロンプト

プロンプト

プロンプト
Enter a number to select the database pool to upgrade ORDS. Total database pools is 12. Showing only the first 9 database pools. Additional options to Generate script, Specify a database pool, or Create additional database pool. [1] default jdbc:oracle:thin:@MYPDB?TNS_ADMIN=/path/to/my/folder [2] exampledb1 jdbc:oracle:thin:@DB1?TNS_ADMIN=/path/to/my/folder [3] exampledb2 jdbc:oracle:thin:@DB2?TNS_ADMIN=/path/to/my/folder [4] exampledb3 jdbc:oracle:thin:@DB3?TNS_ADMIN=/path/to/my/folder [5] fxdb50 jdbc:oracle:thin:@//localhost:1521/fxdb50 [6] hrdb105 jdbc:oracle:thin:@//myhr.xyzcorp.com:1521/hrdb [7] sampledb7 jdbc:oracle:thin:@//my-dev.sample.com:1523/db7 [8] sampledb8 jdbc:oracle:thin:@//my-dev.sample.com:1523/db8 [9] sampledb9 jdbc:oracle:thin:@//my-dev.sample.com:1523/db9 [G] Generate script to upgrade ORDS in all the database pools [S] Specify the database pool name to upgrade ORDS [C] Create an additional database pool Choose [1]: G Enter the location to store the ORDS upgrade script [/path/to/scripts]: Generating upgrade script... Completed generating upgrade script at /path/to/scripts/ords_upgrade_db_pools_2024-03-24_161653_46492

  Enter a number to select the database pool to upgrade ORDS. Total database pools is 12. Showing only the first 9 database pools.
  Additional options to Generate script, Specify a database pool, or Create additional database pool.
    [1] default      jdbc:oracle:thin:@MYPDB?TNS_ADMIN=/path/to/my/folder
    [2] exampledb1   jdbc:oracle:thin:@DB1?TNS_ADMIN=/path/to/my/folder
    [3] exampledb2   jdbc:oracle:thin:@DB2?TNS_ADMIN=/path/to/my/folder
    [4] exampledb3   jdbc:oracle:thin:@DB3?TNS_ADMIN=/path/to/my/folder
    [5] fxdb50       jdbc:oracle:thin:@//localhost:1521/fxdb50
    [6] hrdb105      jdbc:oracle:thin:@//myhr.xyzcorp.com:1521/hrdb
    [7] sampledb7    jdbc:oracle:thin:@//my-dev.sample.com:1523/db7
    [8] sampledb8    jdbc:oracle:thin:@//my-dev.sample.com:1523/db8
    [9] sampledb9    jdbc:oracle:thin:@//my-dev.sample.com:1523/db9
    [G] Generate script to upgrade ORDS in all the database pools
    [S] Specify the database pool name to upgrade ORDS
    [C] Create an additional database pool
  Choose [1]: G

  Enter the location to store the ORDS upgrade script [/path/to/scripts]: 
Generating upgrade script...

Completed generating upgrade script at /path/to/scripts/ords_upgrade_db_pools_2024-03-24_161653_46492

host、port、servicename/sidなどのデータベース・プール接続情報に基づいて、継承接続を使用していて、ORDSがデータベースに存在する場合、非対話型(サイレント)コマンドに--bequeath-connectオプションが含まれます。

例:

ords --config /path/to/myconfig install --db-pool exampledb1 --bequeath-connect --db-only

それ以外の場合は、--admin-user <username>を管理者ユーザーに置き換え、--password-stdin < <file>を管理者パスワードを含むファイルに置き換える必要があります。

例:

ords --config /path/to/myconfig install --db-pool <pool> --admin-user <username> --db-only --password-stdin < <file>
ords --config /path/to/myconfig install --db-pool <pool> --admin-user ADMIN --db-only --password-stdin < /path/to/special.txt

生成されたアップグレード・スクリプトの例

# ------------------------------------------------------------
# Date       : 24 Mar 2024 16:27:05
# Release    : Oracle REST Data Services 24.1.0.r0822130
# Type       : Generated Upgrade Script
# ------------------------------------------------------------

# ------------------------------------------------------------
# Database   : Oracle Database 23c Free 
# DB Version : 23.3.0.23.09
# Install/upgrade command using --bequeath-connect option
# ------------------------------------------------------------

ords --config /path/to/myconfig install --bequeath-connect --db-only
ords --config /path/to/myconfig install --db-pool exampledb1 --bequeath-connect --db-only
ords --config /path/to/myconfig install --db-pool exampledb2 --bequeath-connect --db-only
ords --config /path/to/myconfig install --db-pool exampledb3 --bequeath-connect --db-only
ords --config /path/to/myconfig install --db-pool fxdb50 --bequeath-connect --db-only

# ------------------------------------------------------------
# Install/upgrade command using --db-only option
# ------------------------------------------------------------

ords --config /path/to/myconfig install --db-pool hrdb105 --admin-user <username> --db-only --password-stdin < <file>
ords --config /path/to/myconfig install --db-pool sampledb7 --admin-user <username> --db-only --password-stdin < <file>
ords --config /path/to/myconfig install --db-pool sampledb8 --admin-user <username> --db-only --password-stdin < <file>
ords --config /path/to/myconfig install --db-pool sampledb9 --admin-user <username> --db-only --password-stdin < <file>
ords --config /path/to/myconfig install --db-pool testdb111 --admin-user <username> --db-only --password-stdin < <file>
ords --config /path/to/myconfig install --db-pool testdb222 --admin-user <username> --db-only --password-stdin < <file>
ords --config /path/to/myconfig install --db-pool testdb333 --admin-user <username> --db-only --password-stdin < <file>

2.1.3.1.7.2.8 ORDSをアップグレードするデータベース・プール名を指定します

オプション「ORDSをアップグレードするデータベース・プール名を指定します」では、データベース・プール名の入力を求められます。ORDS構成にデータベース・プール名が存在する場合、ORDSはデータベースでアップグレードされます。

例:

Enter the database pool name: db1

2.1.3.1.8 対話型インストールのための継承接続の設定

継承接続を使用して、データベースでOracle REST Data Servicesをインストールおよびアップグレードできます。

継承接続により、ORDSはネットワーク・リスナーをバイパスしてOracleデータベースに直接接続できます。その後、データベースと同じサーバーでORDSを実行できます。

継承接続を使用するには、管理者のユーザー名とパスワードは必要ありません。継承接続を使用するには、次の環境変数を設定します:

ORACLE_HOME
ORACLE_SID
LD_LIBRARY_PATH ($ORACLE_HOME/libを指す)

その後、次のいずれかのORDS CLIコマンドを実行してORDSをインストールできます:

ords --java-options "-DuseOracleHome=true" install
データベース・プールを作成するか、またはデータベース・プール内のORDSをアップグレードします。
ords --java-options "-DuseOracleHome=true" install -i --db-only
データベース・プール内のORDSをインストールまたはアップグレードするか、データベース接続を指定します。ここでは、構成は作成または更新されません。

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

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

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

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

ノート:

継承接続を使用するようにOS環境を設定している場合は、ords serveコマンドを使用する前に、JDK_JAVA_OPTIONSにuseOracleHome=trueが含まれていないことを確認してください。環境変数JDK_JAVA_OPTIONSからuseOracleHomeを削除するか、JDK_JAVA_OPTIONSを設定解除します。

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

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

2.1.4.1 継承接続を使用した非対話型(サイレント)ORDS操作

継承接続を使用して、データベースにOracle REST Data Servicesをインストールまたはアップグレード、修復およびアンインストールできます。

継承接続を使用する場合、管理者のユーザー名およびパスワードは必要ありません。継承接続を使用するには、次の環境変数を設定します:

ORACLE_HOME
ORACLE_SID
LD_LIBRARY_PATH ($ORACLE_HOME/libを指す)

--bequeathオプションを使用したORDSインストール・コマンドの使用例:

例2-2 基本接続

ords --java-options "-DuseOracleHome=true" --config <PATH TO CONFIG> install --db-pool <POOL NAME> --
bequeath-connect --db-hostname <DB HOST> --db-port <DB PORT> --
db-servicename <DB SERVICENAME> --proxy-user --feature-sdw true 
--log-folder <LOG FOLDER> --password-stdin < <PATH TO FILE>

例2-3 TNS接続

ords --java-options "-DuseOracleHome=true" --config <PATH TO CONFIG> install --db-pool <POOL NAME> --
bequeath-connect --db-tns-alias <TNS ALIAS> --db-tns-dir <TNS 
FOLDER> --proxy-user --feature-sdw true --log-folder <LOG 
FOLDER> --password-stdin < <PATH TO FILE>

例2-4 カスタムURL接続

ords --java-options "-DuseOracleHome=true" --config <PATH TO CONFIG> install --db-pool <POOL NAME> --
bequeath-connect --db-custom-url <Custom URL> --proxy-user --
feature-sdw true --log-folder <LOG FOLDER> --password-stdin < 
<PATH TO FILE>

ノート:

--db-poolオプションを省略すると、設定はdefaultプール設定ファイルに書き込まれます。

既存のデータベース・プールをアップグレードするords install --db-onlyコマンドの例。

ords --java-options "-DuseOracleHome=true" --config <PATH TO CONFIG> install --db-pool <POOL NAME> --bequeath-connect --db-only

ノート:

--db-poolオプションを省略すると、defaultプールを使用してアップグレードが実行されます。

既存のデータベース・プールを使用したords install repairコマンドの例:

ords --java-options "-DuseOracleHome=true" --config <PATH TO CONFIG> install repair --db-pool <POOL NAME> --bequeath-connect

ノート:

--db-poolオプションを省略すると、defaultプールを使用して修復が行われます。

既存のデータベース・プールを使用したords uninstallコマンドの使用例:

ords --java-options "-DuseOracleHome=true" --config <PATH TO CONFIG> uninstall --db-pool <POOL NAME> --bequeath-connect

ノート:

--db-poolオプションを省略すると、defaultプールを使用してアンインストールが実行されます。

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

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

オプション	説明
`--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.3 入力リダイレクションの使用

この項では、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は、<<リダイレクション演算子と、その後に続くデリミタ・トークンで構成されます。

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

例:

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
    [S] 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 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スキーマに対する問合せを強制的に再構築します。

次のコマンドを実行して、データベース・プールのORDS構成にPL/SQLゲートウェイ・モード設定が含まれておりproxiedが設定されていることを確認します:

ords --config <config_path> --db-pool <pool_name> get plsql.gateway.mode

次のコマンドを実行して、plsql.gateway.mode値をproxiedに設定します:

ords --config <config_path> config --db-pool <pool_name> set plsql.gateway.mode proxied

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

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

表2-22 修復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-23 対話型のアップグレード・コマンド

コマンド・オプション	説明
`--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

Oracle REST Data Services 24.x.x.rNNNNNN - Migrate Configuration 
Migrating ORDS Configuration files located at /path/to/legacy/conf
...

Legacy configuration files located at /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 database pool to upgrade ORDS.
  Additional options to Generate script, or Create an additional database pool.
    [1] default      jdbc:oracle:thin:@//localhost:1521/orcl
    [2] db1          jdbc:oracle:thin:@//localhost:1521/pdb1
    [3] db2          jdbc:oracle:thin:@//localhost:1521/pdb2
    [G] Generate script to upgrade ORDS in all the database pools
    [C] Create an additional database pool
  Choose [1]:

移行されたデータベース・プールのリストが表示されます。apexという名前のレガシー構成のデータベース・プールが移行され、名前がデフォルトに変更されます。

アップグレードするデータベース・プールが複数ある場合は、「すべてのデータベース・プールでORDSをアップグレードするためのスクリプトを生成します」オプションを選択するか、構成がすでに移行されているため--legacy-configオプションを除外してinstallコマンドを再度繰り返すことができます。

例:

ords --config /path/to/new/conf install -i --log-folder /path/to/logs

関連項目:

シナリオ3: 複数のデータベース・プール

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.3.1.3 複数のデータベース・プールのアップグレード

PL/SQLゲートウェイ・ユーザーを使用するデータベース・プールが複数ある場合は、PL/SQLゲートウェイ・ユーザーがORDSスキーマで構成されるように、ORDSインストール・コマンドを使用してそれらのデータベース・プールもアップグレードすることをお薦めします。

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-24 対話型アンインストールのプロンプト

プロンプト番号	プロンプト	説明
1.	`Enter a number to select the database pool to use or create the database pool [1] default jdbc:oracle:thin:@//localhost:1521/orcl [S] 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 データベース・サービス名の入力

サービス名を指定します。サービス名のデフォルト値は、指定された順序で次のいずれかから取得されます。

ORDS構成ファイルのサービス名設定。存在しない場合は次が行われます
ORACLE_PDB環境変数がチェックされます。未定義の場合は次が行われます
ORACLE_SID環境変数がチェックされます。未定義の場合は次が行われます
orclがデフォルト値として使用されます。

2.4.1.6 TNSの場所の入力

tnsnames.oraファイルがある有効なフォルダを指定します。

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

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

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

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

URLフォーマットの例:

jdbc:oracle:<driver>:@//<host>:<port>/<servicename>
jdbc:oracle:thin:@//localhost:1521/orcl

jdbc:oracle:<drivertype>:@(DESCRIPTION=(ADDRESS=(PROTOCOL=TCP)(HOST=<host>)(PORT=<port>))(CONNECT_DATA=(SERVICE_NAME=<servicename>)))
jdbc:oracle:thin:@(DESCRIPTION=(ADDRESS=(PROTOCOL=TCP)(HOST=localhost)(PORT=1521))(CONNECT_DATA=(SERVICE_NAME=orcl)))

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-25 アンインストール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

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

関連項目: