インポート・データ・ポンプ・ジョブの作成
POST
/database/datapump/import
指定されたパラメータを使用してデータ・ポンプのインポート・ジョブを作成し、開始します。パラメータの詳細な説明は、Oracle Data Pumpのドキュメントを参照してください。クライアントは、このサービスを起動するにはSQL管理者ロールが必要です。
リクエスト
サポートされるメディア・タイプ
- application/json
ルート・スキーマ: schema
タイプ:
ソースの表示
object
- datapump_dir(optional): string
デフォルト値:
DATA_PUMP_DIR
使用するデータベース・ディレクトリを指定します。 - file_name: string
データ・ポンプ・インポートに使用するファイル名パターン。操作がIMPORTの場合は必須です。
- job_mode(optional): string
デフォルト値:
SCHEMA
指定できる値:[ "FULL", "SCHEMA", "TABLE", "TABLESPACE" ]
データ・ポンプのジョブ・モードを指定します。 - name_expressions(optional): array name_expressions
データ・ポンプ・ジョブのメタデータ・フィルタ・パラメータの定義に使用されます。
- remap_schemas(optional): array remap_schemas
インポート・ジョブの再マップ・スキーマ・パラメータの定義に使用されます。
- schema_expressions(optional): array schema_expressions
データ・ポンプ・ジョブのメタデータ・フィルタ・パラメータの定義に使用されます。
- tablespace_expressions(optional): array tablespace_expressions
データ・ポンプ・ジョブのメタデータ・フィルタ・パラメータの定義に使用されます。
- threads(optional): integer
ジョブに使用可能なワーカー・プロセスの最大数。このパラメータを設定して、ジョブに使用するリソースの量を調整します。
ネストされたスキーマ: items
タイプ:
ソースの表示
object
- source: string
再マップするソース・スキーマ。
- target: string
再マップ先のターゲット・スキーマ。
レスポンス
サポートされるメディア・タイプ
- application/json
201レスポンス
作成されたデータ・ポンプ・インポート・ジョブの説明。
ルート・スキーマ: DataPumpJobsItem
タイプ:
object
このオブジェクトは、データベース内の指定されたデータ・ポンプ・ジョブを表します。
ソースの表示
- attached_sessions(optional): integer
ジョブに接続されたセッションの数
- datapump_sessions(optional): integer
ジョブに含まれているデータ・ポンプのセッションの数
- degree(optional): integer
操作を実行しているワーカー・プロセス数
- job_mode(optional): string
ジョブのモード
- job_name(optional): string
ユーザーが指定したジョブの名前(またはサーバーによって生成されたデフォルト名)
- links(optional): array links
- operation(optional): string
ジョブのタイプ
- owner_name(optional): string
ジョブを起動したユーザー
- state(optional): string
現在のジョブの状態
例
次の例は、cURLを使用してRESTリソースに対するPOSTリクエストを発行することによって、Data Pumpインポート・ジョブを作成する方法を示しています。
curl -i -X POST -u username:password
-d @request_body.json
-H "Content-Type:application/json" https://rest_server_url/ords/orcl/pdbadmin/_/db-api/stable/database/datapump/import
リクエスト本文の例
ノート:
前述のコマンドで使用されるURL構造
https://rest_server_url/resource-path
には、次の要素があります。
rest_server_url
はOracle Rest Data Serverが実行されているRESTサーバーです- URLの残りの部分には、ORDSコンテキスト・ルート、データベース識別子、スキーマ識別子、使用するORDSデータベースAPIのバージョンおよびこの操作のパスが含まれます。
次に、USERS
表領域のオブジェクトをインポートし、SCOTTスキーマ・オブジェクトをHRスキーマに再マップするData Pumpリクエストを送信するためのリクエスト本文の例を示します。この例では、デフォルトのDATA_PUMP_DIR
データベース・ディレクトリが使用され、EXPDAT%U-13_12_45.DMP
ファイル名パターンに一致するダンプ・ファイルが存在することが想定されています。
{
"job_mode": "SCHEMA",
"file_name": "EXPDAT%U-13_12_45.DMP",
"tablespace_expressions": [
{"expression": "= 'USERS'"}
],
"remap_schemas": [
{"source": "SCOTT","target": "HR"}
]
}
レスポンス・ヘッダーの例
次の例に、レスポンス・ヘッダーを示します。Location
ヘッダーは、ジョブのステータスの表示に使用できるURIを返します。
HTTP/1.1 201 Created
Content-Type: application/json
Content-Location: https://rest_server_url/ords/orcl/pdbadmin/_/db-api/stable/database/datapump/jobs/PDBADMIN,DATAPUMP_REST_IMPORT_20190906154258/
ETag: "onyB9moowJVhrJQrJ80tk3VyP3HZ9QqXHvwsmKrvnhNk/mOZF9CRFKJXIXWkKAnLtmJHssYdJ83KBCJUgqBtbQ=="
Location: https://rest_server_url/ords/orcl/pdbadmin/_/db-api/stable/database/datapump/jobs/PDBADMIN,DATAPUMP_REST_IMPORT_20190906154258/
Transfer-Encoding: chunked
レスポンス本文の例
次の例は、JSON形式で返される201のレスポンス本文を示しています。
{
"job_name": "DATAPUMP_REST_IMPORT_20190906154258",
"owner_name": "PDBADMIN",
"operation": "IMPORT",
"job_mode": "SCHEMA",
"state": "EXECUTING",
"degree": 1,
"attached_sessions": 0,
"datapump_sessions": 2,
"job_state": "EXECUTING",
"links": [
{
"rel": "collection",
"href": "https://rest_server_url/ords/orcl/pdbadmin/_/db-api/stable/database/datapump/jobs/"
},
{
"rel": "describedby",
"href": "https://rest_server_url/ords/orcl/pdbadmin/_/db-api/stable/metadata-catalog/"
},
{
"rel": "related",
"href": "https://rest_server_url/ords/orcl/pdbadmin/_/db-api/stable/database/datapump/jobs/PDBADMIN,DATAPUMP_REST_IMPORT_20190906154258/EXPDAT-2019-04-19-14_11_39.LOG"
},
{
"rel": "related",
"href": "https://rest_server_url/ords/orcl/pdbadmin/_/db-api/stable/database/datapump/jobs/PDBADMIN,DATAPUMP_REST_IMPORT_20190906154258/IMPDAT-2019-09-06-15_42_58.LOG"
},
{
"rel": "self",
"href": "https://rest_server_url/ords/orcl/pdbadmin/_/db-api/stable/database/datapump/jobs/PDBADMIN,DATAPUMP_REST_IMPORT_20190906154258/"
}
]
}