ジャンプ先

• リクエスト
• レスポンス
• 例

エクスポート・データ・ポンプ・ジョブの作成

POST

/database/datapump/export

指定されたパラメータを使用してデータ・ポンプのエクスポート・ジョブを作成し、開始します。データおよびオブジェクト構造は、Oracleデータベース・サーバーのディレクトリまたはOracle Object Storeにエクスポートできます。パラメータの詳細な説明は、Oracle Data Pumpのドキュメントを参照してください。クライアントは、このサービスを起動するにはSQL管理者ロールまたはSQL開発者ロールが必要です。

リクエスト

この操作のリクエスト・パラメータはありません。

サポートされるメディア・タイプ

• application/json

リクエスト本文 - application/json ()

ルート・スキーマ: schema

タイプ: object

ソースの表示

• credential_name: string
  オブジェクト・ストレージへのエクスポートに使用される、データベース・ユーザーが所有する資格証明の名前を指定します。
• datapump_dir: string
  デフォルト値: DATA_PUMP_DIR

  使用するデータベース・ディレクトリを指定します。
• file_name: string
  データ・ポンプ・エクスポートに使用するファイル名パターン。名前にタイムスタンプがあるパターンにデフォルト設定されます。credential_nameが指定されている場合は必須です。credential_nameが指定されている場合、file_nameはOracle Object Storeの場所のURI形式である必要があります。
• filter: string
  エクスポート対象のデータベース・オブジェクトを識別するために適用されるフィルタです。job_modeがFULLでない場合は必須です。
• job_mode: string
  デフォルト値: SCHEMA

  指定できる値: [ "FULL", "SCHEMA", "TABLE", "TABLESPACE" ]

  データ・ポンプのジョブ・モードを指定します。
• name_expressions: array name_expressions
  データ・ポンプ・ジョブのメタデータ・フィルタ・パラメータの定義に使用されます。
• schema_expressions: array schema_expressions
  データ・ポンプ・ジョブのメタデータ・フィルタ・パラメータの定義に使用されます。
• tablespace_expressions: array tablespace_expressions
  データ・ポンプ・ジョブのメタデータ・フィルタ・パラメータの定義に使用されます。
• threads: integer
  ジョブに使用可能なワーカー・プロセスの最大数。このパラメータを設定して、ジョブに使用するリソースの量を調整します。

{
    "type":"object",
    "properties":{
        "credential_name":{
            "type":"string",
            "description":"Specify the name of the credentials, owned by the database user, to be used to export to object storage."
        },
        "datapump_dir":{
            "type":"string",
            "description":"Specify the database directory to use.",
            "default":"DATA_PUMP_DIR"
        },
        "file_name":{
            "type":"string",
            "description":"The file name pattern to use for Data Pump export. Will default to a pattern with a timestamp in the name. Required when credential_name is specified. When credential_name is specified the file_name must be a URI format for an Oracle Object Store location."
        },
        "filter":{
            "type":"string",
            "description":"The filter to apply to identify database objects for export. Required when job_mode is not FULL."
        },
        "job_mode":{
            "type":"string",
            "description":"Specify the Data Pump job mode.",
            "default":"SCHEMA",
            "enum":[
                "FULL",
                "SCHEMA",
                "TABLE",
                "TABLESPACE"
            ]
        },
        "threads":{
            "type":"integer",
            "description":"The maximum number of worker processes that can be used for the job. Set this parameter to adjust the amount of resources used for a job."
        },
        "name_expressions":{
            "type":"array",
            "description":"Used to define Metadata Filter parameters for a Data Pump job.",
            "items":{
                "type":"object",
                "required":[
                    "expression"
                ],
                "properties":{
                    "expression":{
                        "type":"string",
                        "description":"An SQL clause to be used as a Name Expression filter."
                    }
                }
            }
        },
        "schema_expressions":{
            "type":"array",
            "description":"Used to define Metadata Filter parameters for a Data Pump job.",
            "items":{
                "type":"object",
                "required":[
                    "expression"
                ],
                "properties":{
                    "expression":{
                        "type":"string",
                        "description":"An SQL clause to be used as a Schema Expression filter."
                    }
                }
            }
        },
        "tablespace_expressions":{
            "type":"array",
            "description":"Used to define Metadata Filter parameters for a Data Pump job.",
            "items":{
                "type":"object",
                "required":[
                    "expression"
                ],
                "properties":{
                    "expression":{
                        "type":"string",
                        "description":"An SQL clause to be used as a Tablespace Expression filter."
                    }
                }
            }
        }
    }
}

ネストされたスキーマ : name_expressions

タイプ: array

データ・ポンプ・ジョブのメタデータ・フィルタ・パラメータの定義に使用されます。

ソースの表示

• 配列: オブジェクト items

{
    "type":"array",
    "description":"Used to define Metadata Filter parameters for a Data Pump job.",
    "items":{
        "type":"object",
        "required":[
            "expression"
        ],
        "properties":{
            "expression":{
                "type":"string",
                "description":"An SQL clause to be used as a Name Expression filter."
            }
        }
    }
}

ネストされたスキーマ : schema_expressions

タイプ: array

データ・ポンプ・ジョブのメタデータ・フィルタ・パラメータの定義に使用されます。

ソースの表示

• 配列: オブジェクト items

{
    "type":"array",
    "description":"Used to define Metadata Filter parameters for a Data Pump job.",
    "items":{
        "type":"object",
        "required":[
            "expression"
        ],
        "properties":{
            "expression":{
                "type":"string",
                "description":"An SQL clause to be used as a Schema Expression filter."
            }
        }
    }
}

ネストされたスキーマ : tablespace_expressions

タイプ: array

データ・ポンプ・ジョブのメタデータ・フィルタ・パラメータの定義に使用されます。

ソースの表示

• 配列: オブジェクト items

{
    "type":"array",
    "description":"Used to define Metadata Filter parameters for a Data Pump job.",
    "items":{
        "type":"object",
        "required":[
            "expression"
        ],
        "properties":{
            "expression":{
                "type":"string",
                "description":"An SQL clause to be used as a Tablespace Expression filter."
            }
        }
    }
}

ネストされたスキーマ: items

タイプ: object

ソースの表示

• expression(required): string
  名前式のフィルタとして使用されるSQL句。

{
    "type":"object",
    "required":[
        "expression"
    ],
    "properties":{
        "expression":{
            "type":"string",
            "description":"An SQL clause to be used as a Name Expression filter."
        }
    }
}

ネストされたスキーマ: items

タイプ: object

ソースの表示

• expression(required): string
  スキーマ式のフィルタとして使用されるSQL句。

{
    "type":"object",
    "required":[
        "expression"
    ],
    "properties":{
        "expression":{
            "type":"string",
            "description":"An SQL clause to be used as a Schema Expression filter."
        }
    }
}

ネストされたスキーマ: items

タイプ: object

ソースの表示

• expression(required): string
  表領域式のフィルタとして使用されるSQL句。

{
    "type":"object",
    "required":[
        "expression"
    ],
    "properties":{
        "expression":{
            "type":"string",
            "description":"An SQL clause to be used as a Tablespace Expression filter."
        }
    }
}

例

例の選択 名前がEMPで始まるがEMPという名前ではない表をSCOTTスキーマからエクスポートします。

先頭に戻る

レスポンス

サポートされるメディア・タイプ

• application/json

201レスポンス

作成されたデータ・ポンプのエクスポート・ジョブの説明。

本文 ()

ルート・スキーマ: DataPumpJobsItem

タイプ: object

このオブジェクトは、データベース内の指定されたデータ・ポンプ・ジョブを表します。

ソースの表示

• attached_sessions: integer
  ジョブに接続されたセッションの数
• datapump_sessions: integer
  ジョブに含まれているデータ・ポンプのセッションの数
• degree: integer
  操作を実行しているワーカー・プロセス数
• job_mode: string
  ジョブのモード
• job_name: string
  ユーザーが指定したジョブの名前(またはサーバーによって生成されたデフォルト名)
• links: array links
• operation: string
  ジョブのタイプ
• owner_name: string
  ジョブを起動したユーザー
• state: string
  現在のジョブの状態

{
    "type":"object",
    "description":"This object represents a specified Data Pump job in the database.",
    "properties":{
        "owner_name":{
            "type":"string",
            "description":"User that initiated the job."
        },
        "job_name":{
            "type":"string",
            "description":"User-supplied name for the job (or the default name generated by the server)."
        },
        "operation":{
            "type":"string",
            "description":"Type of job."
        },
        "job_mode":{
            "type":"string",
            "description":"Mode of job."
        },
        "state":{
            "type":"string",
            "description":"Current job state."
        },
        "degree":{
            "type":"integer",
            "description":"Number of worker processes performing the operation."
        },
        "attached_sessions":{
            "type":"integer",
            "description":"Number of sessions attached to the job."
        },
        "datapump_sessions":{
            "type":"integer",
            "description":"Number of Data Pump sessions participating in the job."
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/LinkRelation"
            }
        }
    }
}

ネストされたスキーマ: links

タイプ: array

ソースの表示

• 配列: オブジェクト LinkRelation

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/LinkRelation"
    }
}

ネストされたスキーマ: LinkRelation

タイプ: object

ソースの表示

• href(required): string
• rel(required): string

{
    "type":"object",
    "properties":{
        "rel":{
            "type":"string"
        },
        "href":{
            "type":"string"
        }
    },
    "required":[
        "rel",
        "href"
    ]
}

先頭に戻る

例

次の例は、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/export

リクエスト本文の例

ノート:

前述のコマンドで使用されるURL構造https://rest_server_url/resource-pathには、次の要素があります。

• rest_server_urlはOracle Rest Data Serverが実行されているRESTサーバーです
• URLの残りの部分には、ORDSコンテキスト・ルート、データベース識別子、スキーマ識別子、使用するORDSデータベースAPIのバージョンおよびこの操作のパスが含まれます。

次に、EMPで始まるがEMPという名前ではない表をSCOTTスキーマからエクスポートするData Pumpリクエストを送信するためのリクエスト本文の例を示します。

{
  "job_mode": "TABLE",
  "name_expressions": [
    {"expression": "!='EMP'"},
    {"expression": "LIKE 'EMP%'"}
  ],
  "schema_expressions": [
    {"expression": "IN ('SCOTT')"}
  ]
}

レスポンス・ヘッダーの例

次の例に、レスポンス・ヘッダーを示します。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_EXPORT_20190706144505/"
ETag:""nXEnxxIZe/tJIO5rgD+qkCggJtIVIMvKJG6T2dqhJ8Wy2Cr5u+anrmgez/2+3BWR3FKx0TlVjR2RRfITHZnFxQ==""
Location:"https://rest_server_url/ords/orcl/pdbadmin/_/db-api/stable/database/datapump/jobs/PDBADMIN,DATAPUMP_REST_EXPORT_20190907144505/"
Transfer-Encoding:"chunked"

レスポンス本文の例

次の例は、JSON形式で返される201のレスポンス本文を示しています。

{
    "job_name": "DATAPUMP_REST_EXPORT_20190706144505",
    "owner_name": "PDBADMIN",
    "operation": "EXPORT",
    "job_mode": "TABLE",
    "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_EXPORT_20190706144505/EXPDAT-2019-07-06-14_45_05.LOG"
        },
        {
            "rel": "self",
            "href": "https://rest_server_url/ords/orcl/pdbadmin/_/db-api/stable/database/datapump/jobs/PDBADMIN,DATAPUMP_REST_EXPORT_20190706144505/"
        }
    ]
}

先頭に戻る