11.17 REST

RESTコマンドを使用すると、Oracle REST Data Services 3.xサービスをエクスポートできます。これは、Oracle REST Data Servicesリリース3.0.5以降で適用可能です。

Oracle REST Data Servicesの旧バージョンの場合は、アップグレードする必要があります。詳細は、『REST Data Servicesインストレーション、構成および開発ガイド』の、Oracle REST Data Servicesのインストールに関する項を参照してください。

RESTコマンドには次のサブコマンドが含まれています:

リスト・コマンド

コマンド	説明
modules	スキーマ内のモジュールをリストします。
clients	スキーマ内のOAuthクライアントをリストします。
schemas	REST対応スキーマをリストします。
privileges	スキーマ内の権限をリストします。

エクスポート・コマンド

コマンド	説明
export module	名前または接頭辞で特定してRESTモジュールをエクスポートします。
export client	名前で特定してOAuthクライアントをエクスポートします。
export schema	REST対応スキーマをエクスポートします。

インポート・コマンド

コマンド	説明
import	JSONファイル形式のREST定義をインポートします。

11.17.1 modules

現在のスキーマまたは指定したスキーマにあるモジュールをすべてリストします。

構文

REST modules {OPTIONS}

オプション

オプション	説明
-schema-name	モジュールをリストするスキーマの名前を指定します。このパラメータを省略した場合、このコマンドでは、現在のスキーマにあるオブジェクトがリストされます。 このパラメータを使用するには、ORDS_ADMINISTRATOR_ROLEが必要です。

例1

現在のスキーマにあるモジュールをリストするには、次のように入力します:

SQL> REST modules

例2

my_other_schemaという名前のスキーマにあるモジュールをリストするには、次のように入力します:

SQL> REST modules -schema-name my_other_schema

11.17.2 clients

現在のスキーマまたは指定したスキーマにあるOAuthクライアントをすべてリストします。

構文

REST clients {OPTIONS}

オプション

オプション	説明
-schema-name	OAuthクライアントをリストするスキーマの名前を指定します。このパラメータを省略した場合、このコマンドでは、現在のスキーマにあるオブジェクトがリストされます。 このパラメータを使用するには、ORDS_ADMINISTRATOR_ROLEが必要です。

例1

現在のスキーマにあるOAuthクライアントをリストするには、次のように入力します:

SQL> REST clients

例2

my_other_schemaという名前のスキーマにあるOAuthクライアントをリストするには、次のように入力します:

SQL> REST clients -schema-name my_other_schema

11.17.3 schemas

REST対応スキーマをすべてリストします。ORDS_ADMINISTRATOR_ROLEを使用してこのコマンドを実行した場合は、REST対応スキーマがすべてリストされます。それ以外の場合は、現在のREST対応スキーマのみがリストされます。

構文

REST schemas

例

REST対応スキーマをリストするには、次のように入力します:

SQL> REST schemas

11.17.4 privileges

現在のスキーマまたは指定したスキーマにある権限をすべてリストします。

構文

REST privileges {OPTIONS}

オプション

オプション	説明
-schema-name	権限をリストするスキーマの名前を指定します。このパラメータを省略した場合、このコマンドでは、現在のスキーマにあるオブジェクトがリストされます。 このパラメータを使用するには、ORDS_ADMINISTRATOR_ROLEが必要です。

例1

現在のスキーマにある権限をリストするには、次のように入力します:

SQL> REST privileges

例2

my_other_schemaという名前のスキーマにある権限をリストするには、次のように入力します:

SQL> REST privileges -schema-name my_other_schema

11.17.5 export module

現在のスキーマまたは指定したスキーマにあるRESTモジュールを、名前または接頭辞で特定してエクスポートします。Oracle REST Data Services (ORDS) 25.1.0以降が必要です。

構文

REST export module <item_name> {OPTIONS}

パラメータ

パラメータ	説明
必須
<item_name>	次のどちらかを使用して、エクスポートするモジュールを指定します: RESTモジュールの名前(たとえば、my-module1やhr-module)。 RESTモジュールの接頭辞(たとえば、/module1/や/hr/)。

オプション

オプション	説明
-schema-name	そのモジュールを所有するスキーマの名前を指定します。 このパラメータを使用するには、ORDS_ADMINISTRATOR_ROLEが必要です。
-runnable-as-admin	フラグ・オプション。 存在する場合は、ORDS_ADMINパッケージを使用してスクリプトを生成します。この場合は、接続されたスキーマ以外のスキーマでオブジェクトを作成できます。 存在しない場合は、標準ORDSパッケージを使用してスクリプトを生成します。この場合は、操作が現在のスキーマに限定されます。 このパラメータを使用するには、ORDS_ADMINISTRATOR_ROLEが必要です。

例1

現在のスキーマにあるモジュールをエクスポートするには、次のように入力します:

SQL> REST export module my-module1

または

SQL> REST export module /module1/

例2

出力において標準ORDSパッケージを使用してmy_other_schemaという名前のスキーマにあるモジュールをエクスポートするには、次のように入力します:

SQL> REST export module my-module1 -schema-name my_other_schema

または

SQL> REST export module /module1/ -schema-name my_other_schema

例3

出力においてORDS_ADMINパッケージを使用してmy_other_schemaという名前のスキーマにあるモジュールをエクスポートするには、次のように入力します:

SQL> REST export module my-module1 -schema-name my_other_schema -runnable-as-admin

または

SQL> REST export module /module1/ -schema-name my_other_schema -runnable-as-admin

11.17.6 export client

現在のスキーマまたは指定したスキーマにあるOAuthクライアントをエクスポートします。Oracle REST Data Services (ORDS) 25.3.0以降が必要です。

構文

REST export client <item_name> {OPTIONS}

パラメータ

パラメータ	説明
必須
<item_name>	エクスポートするOAuthクライアントの名前を指定します。

オプション

オプション	説明
-schema-name	そのOAuthクライアントを所有するスキーマの名前を指定します。 このパラメータを使用するには、ORDS_ADMINISTRATOR_ROLEが必要です。
-runnable-as-admin	フラグ・オプション。 存在する場合は、ORDS_ADMINパッケージを使用してスクリプトを生成します。この場合は、接続されたスキーマ以外のスキーマでオブジェクトを作成できます。 存在しない場合は、標準ORDSパッケージを使用してスクリプトを生成します。この場合は、操作が現在のスキーマに限定されます。 このパラメータを使用するには、ORDS_ADMINISTRATOR_ROLEが必要です。

例1

現在のスキーマにあるOAuthクライアントをエクスポートするには、次のように入力します:

SQL> REST export client client_name

例2

出力において標準ORDSパッケージを使用してmy_other_schemaという名前のスキーマにあるOAuthクライアントをエクスポートするには、次のように入力します:

SQL> REST export client client_name -schema-name my_other_schema

例3

出力においてORDS_ADMINパッケージを使用してmy_other_schemaという名前のスキーマにあるOAuthクライアントをエクスポートするには、次のように入力します:

SQL> REST export client client_name -schema-name my_other_schema -runnable-as-admin

11.17.7 export schema

スキーマ全体をエクスポートします。Oracle REST Data Services (ORDS) 25.1.0以降が必要です。

構文

REST export schema {OPTIONS}

オプション

オプション	説明
-schema-name	エクスポートするスキーマの名前を指定します。 このパラメータを使用するには、ORDS_ADMINISTRATOR_ROLEが必要です。
-runnable-as-admin	フラグ・オプション。 存在する場合は、ORDS_ADMINパッケージを使用してスクリプトを生成します。この場合は、接続されたスキーマ以外のスキーマでオブジェクトを作成できます。 存在しない場合は、標準ORDSパッケージを使用してスクリプトを生成します。この場合は、操作が現在のスキーマに限定されます。 このパラメータを使用するには、ORDS_ADMINISTRATOR_ROLEが必要です。

例1

現在のスキーマをエクスポートするには、次のように入力します:

SQL> REST export schema

例2

出力において標準ORDSパッケージを使用してmy_other_schemaという名前のスキーマをエクスポートするには、次のように入力します:

SQL> REST export schema -schema-name my_other_schema

例3

出力においてORDS_ADMINパッケージを使用してmy_other_schemaという名前のスキーマをエクスポートするには、次のように入力します:

SQL> REST export schema -schema-name my_other_schema -runnable-as-admin

11.17.8 import

JSONファイル形式のREST定義をインポートします。

このコマンドは、Swagger 2.0またはOpenAPI 3.0仕様ファイルをインポートし、ORDSで同様のサービスを再作成可能な、スケルトン・コールを生成します。

構文

REST import json_file_path

パラメータ

パラメータ	説明
必須
json_file_path	そのJSONファイルへの絶対パスを指定します。

例

JSONファイル形式のREST定義をインポートするには、次のように入力します:

SQL> REST import /path/to/file.json