Create an import data pump job
/database/datapump/import
Request
- application/json
-
Content-Type(optional): string
Allowed Values:
[ "application/json" ]
object
DatabaseDatapumpImportRequest
-
credential_name(optional):
string
Specify the name of the credential, owned by the database user, to be used to import from object storage.
-
datapump_dir(optional):
string
Default Value:
DATA_PUMP_DIR
Specify the database directory to use. -
file_name:
string
The file name pattern to use for Data Pump import. Required when operation is IMPORT. When credential_name is specified the file_name must be a URI format for an Oracle Object Store location.
-
job_mode(optional):
object job_mode
-
name_expressions(optional):
array name_expressions
Used to define Metadata Filter parameters for a Data Pump job.
-
remap_schemas(optional):
array remap_schemas
Used to define Remap Schema parameters for an import job.
-
schema_expressions(optional):
array schema_expressions
Used to define Metadata Filter parameters for a Data Pump job.
-
tablespace_expressions(optional):
array tablespace_expressions
Used to define Metadata Filter parameters for a Data Pump job.
-
threads(optional):
integer(int32)
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.
object
-
string
Title:
JobMode
Allowed Values:[ "FULL", "SCHEMA", "TABLE", "TABLESPACE" ]
Specify the Data Pump job mode. -
Default Value:
SCHEMA
Specify the Data Pump job mode.
array
-
Array of:
object NameExpression
Title:
NameExpression
array
-
Array of:
object RemapSchema
Title:
RemapSchema
array
-
Array of:
object SchemaExpression
Title:
SchemaExpression
array
-
Array of:
object TablespaceExpression
Title:
TablespaceExpression
object
NameExpression
-
expression:
string
An SQL clause to be used as a Name Expression filter.
object
RemapSchema
-
source:
string
Source schema to remap from.
-
target:
string
Target schema to remap to.
object
SchemaExpression
-
expression:
string
An SQL clause to be used as a Schema Expression filter.
object
TablespaceExpression
-
expression:
string
An SQL clause to be used as a Tablespace Expression filter.
Response
- application/json
201 Response
object
DataPumpJobsItem
-
attached_sessions(optional):
integer(int32)
Number of sessions attached to the job.
-
datapump_sessions(optional):
integer(int32)
Number of Data Pump sessions participating in the job.
-
degree(optional):
integer(int32)
Number of worker processes performing the operation.
-
job_mode(optional):
string
Mode of job.
-
job_name(optional):
string
User-supplied name for the job (or the default name generated by the server).
-
links(optional):
array links
-
operation(optional):
string
Type of job.
-
owner_name(optional):
string
User that initiated the job.
-
state(optional):
string
Current job state.
Examples
The following example shows how to create Data Pump import job by submitting a POST request on the REST resource using cURL.
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
Example of Request Body
Note:
https://rest_server_url/resource-path
, used in the preceding command has the following components:
rest_server_url
is the REST server where Oracle Rest Data Server is running- The remainder of the URL includes the ORDS context root, the database identifier, the schema identifier, the version of ORDS Database API to use, and the path for this operation.
The following is an example of a request body for submitting a Data Pump request to import objects from the USERS
tablespace and remap SCOTT schema objects to HR schema. In this example, the default DATA_PUMP_DIR
database directory is used and it is expected that there are dump files matching the EXPDAT%U-13_12_45.DMP
file name pattern.
{
"job_mode": "SCHEMA",
"file_name": "EXPDAT%U-13_12_45.DMP",
"tablespace_expressions": [
{"expression": "= 'USERS'"}
],
"remap_schemas": [
{"source": "SCOTT","target": "HR"}
]
}
Example of Response Header
The following example shows the response header. The Location
header returns the URI that can be used to view the status of the job:
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
Example of Response Body
The following example shows the response body with 201 returned in JSON format:
{
"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/"
}
]
}