The DBMS_DATAPUMP package is used to move all, or part of, a database between databases, including both data and metadata.
See Also:
Oracle Database Utilities for more information on the concepts behind theDBMS_DATAPUMP API, how it works, and how it is implemented in the Data Pump Export and Import utilitiesThis chapter contains the following topics:
Overview
Security Model
Constants
Data Structures - Object Types
This section contains topics that relate to using the DBMS_DATAPUMP package.
The support and functionality provided by DBMS_DATAPUMP is as follows:
The source and target databases can have different hardware, operating systems, character sets, and time zones.
All object types and data types existing in Oracle Database 11g are supported.
Data and metadata can be transferred between databases without using any intermediary files.
A subset of a database can be moved based upon object type and names of objects.
Schema names, datafile names, and tablespace names can be transformed at import time.
Previously aborted export and import jobs can be restarted without duplicating or omitting any data or metadata from the original job.
The resources applied to an export or import job can be modified.
Data in an Oracle proprietary format can be unloaded and loaded.
Security for the DBMS_DATAPUMP package is implemented through roles.
The DATAPUMP_EXP_FULL_DATABASE and DATAPUMP_IMP_FULL_DATABASE roles allow privileged users to take full advantage of the API. The Data Pump API will use these roles to determine whether privileged application roles should be assigned to the processes comprising the job.
The DATAPUMP_EXP_FULL_DATABASE role affects only Export operations. It allows users running these operations to do the following:
Perform the operation outside of the scope of their schema
Monitor jobs that were initiated by another user
Export objects (for example, TABLESPACE definitions) that unprivileged users cannot reference
Although the SYS schema does not have the DATAPUMP_EXP_FULL_DATABASE role assigned to it, all security checks performed by Data Pump that require the DATAPUMP_EXP_FULL_DATABASE role will also grant access to the SYS schema.
The DATAPUMP_IMP_FULL_DATABASE role affects only Import and SQL_FILE operations. It allows users running these operations to do the following:
Perform the operation outside of the scope of their schema
Monitor jobs that were initiated by another user
Import objects (for example, DIRECTORY definitions) that unprivileged users cannot create
Although the SYS schema does not have the DATAPUMP_IMP_FULL_DATABASE role assigned to it, all security checks performed by Data Pump that require the DATAPUMP_IMP_FULL_DATABASE role will also grant access to the SYS schema.
There are several public constants defined for use with the DBMS_DATAPUMP.GET_STATUS procedure. All such constants are defined as part of the DBMS_DATAPUMP package. Any references to these constants must be prefixed by DBMS_DATAPUMP. and followed by the symbols in the following lists:
The following mask bit definitions are used for controlling the return of data through the DBMS_DATAPUMP.GET_STATUS procedure.
KU$_STATUS_WIP CONSTANT BINARY_INTEGER := 1;
KU$_STATUS_JOB_DESC CONSTANT BINARY_INTEGER := 2;
KU$_STATUS_JOB_STATUS CONSTANT BINARY_INTEGER := 4;
KU$_STATUS_JOB_ERROR CONSTANT BINARY_INTEGER := 8;
The DBMS_DATAPUMP package defines OBJECT types. The types described in this section are defined in the SYS schema for use by the GET_STATUS function. The way in which these types are defined and used may be different than what you are accustomed to. Be sure to read this section carefully.
The collection of types defined for use with the GET_STATUS procedure are version-specific and include version information in the names of the types. Once introduced, these types will always be provided and supported in future versions of Oracle Database and will not change. However, in future releases of Oracle Database, new versions of these types might be created that provide new or different information. The new versions of these types will have different version information embedded in the type names.
For example, in Oracle Database 10g, release 1 (10.1), there is a sys.ku$_Status1010 type, and in the next Oracle Database release, there could be a sys.ku$_Status1110 type defined. Both types could be used with the GET_STATUS procedure.
Public synonyms have been defined for each of the types used with the GET_STATUS procedure. This makes it easier to use the types and means that you do not have to be concerned with changes to the actual type names or schemas where they reside. Oracle recommends that you use these synonyms whenever possible.
For each of the types, there is a version-specific synonym and a generic synonym. For example, the version-specific synonym ku$_Status1010 is defined for the sys.ku$_Status1010 type.
The generic synonym always describes the latest version of that type. For example, in Oracle Database 10g, release 1, the generic synonym ku$_Status is defined as ku$_Status1010. In a future release, there might be a ku$_Status1110 synonym for sys.ku$Status1110. Because the ku$_Status generic synonym always points to the latest definition, it would now point to ku$_Status1110 rather than to ku$_Status1010.
The choice of whether to use version-specific synonyms or generic synonyms makes a significant difference in how you work. Using version-specific names protects your code from changes in future releases of Oracle Database because those types will continue to exist and be supported. However, access to new information will require code changes to use new synonym names for each of the types. Using the generic names implies that you always want the latest definition of the types and are prepared to deal with changes in different releases of Oracle Database.
When the version of Oracle Database that you are using changes, any C code that accesses types through generic synonym names will need to be recompiled.
Note:
Languages other than PL/SQL must ensure that their type definitions are properly aligned with the version-specific definitions.See Also:
GET_STATUS Procedure for additional information about how types are usedThe DBMS_DATAPUMP package defines the following kinds of OBJECT types:
The worker status types describe what each worker process in a job is doing. The schema, object name, and object type of an object being processed will be provided. For workers processing user data, the partition name for a partitioned table (if any), the number of bytes processed in the partition, and the number of rows processed in the partition are also returned. Workers processing metadata provide status on the last object that was processed. No status for idle threads is returned.
The percent_done refers to the amount completed for the current data item being processed. It is not updated for metadata objects.
The worker status types are defined as follows:
CREATE TYPE sys.ku$_WorkerStatus1010 AS OBJECT (
worker_number NUMBER,
process_name VARCHAR2(30),
state VARCHAR2(30),
schema VARCHAR2(30),
name VARCHAR2(4000),
object_type VARCHAR2(200),
partition VARCHAR2(30),
completed_objects NUMBER,
total_objects NUMBER,
completed_rows NUMBER,
completed_bytes NUMBER,
percent_done NUMBER)
CREATE OR REPLACE PUBLIC SYNONYM ku$_WorkerStatus1010
FOR sys.ku$_WorkerStatus1010;
CREATE TYPE sys.ku$_WorkerStatus1020 AS OBJECT (
worker_number NUMBER, -- Worker process identifier
process_name VARCHAR2(30), -- Worker process name
state VARCHAR2(30), -- Worker process state
schema VARCHAR2(30), -- Schema name
name VARCHAR2(4000),-- Object name
object_type VARCHAR2(200), -- Object type
partition VARCHAR2(30), -- Partition name
completed_objects NUMBER, -- Completed number of objects
total_objects NUMBER, -- Total number of objects
completed_rows NUMBER, -- Number of rows completed
completed_bytes NUMBER, -- Number of bytes completed
percent_done NUMBER, -- Percent done current object
degree NUMBER -- Degree of parallelism)
CREATE OR REPLACE PUBLIC SYNONYM ku$_WorkerStatus1020
FOR sys.ku$_WorkerStatus1020;
CREATE OR REPLACE PUBLIC SYNONYM ku$_WorkerStatus FOR ku$_WorkerStatus1020;
CREATE TYPE sys.ku$_WorkerStatusList1010 AS TABLE OF sys.ku$_WorkerStatus1010
CREATE TYPE sys.ku$_WorkerStatusList1020 AS TABLE OF sys.ku$_WorkerStatus1020
CREATE OR REPLACE PUBLIC SYNONYM ku$_WorkerStatusList1010
FOR sys.ku$_WorkerStatusList1010;
CREATE OR REPLACE PUBLIC SYNONYM ku$_WorkerStatusList1020
FOR sys.ku$_WorkerStatusList1020;
CREATE OR REPLACE PUBLIC SYNONYM ku$_WorkerStatusList
FOR ku$_WorkerStatusList1020;
These types provide informational and error text to attached clients and the log stream. The ku$LogLine.errorNumber type is set to NULL for informational messages but is specified for error messages. Each log entry may contain several lines of text messages.
The log entry and error types are defined as follows:
CREATE TYPE sys.ku$_LogLine1010 AS OBJECT (
logLineNumber NUMBER,
errorNumber NUMBER,
LogText VARCHAR2(2000))
CREATE OR REPLACE PUBLIC SYNONYM ku$_LogLine1010 FOR sys.ku$_LogLine1010;
CREATE OR REPLACE PUBLIC SYNONYM ku$_LogLine1020 FOR sys.ku$_LogLine1010;
CREATE OR REPLACE PUBLIC SYNONYM ku$_LogLine FOR ku$_LogLine1010;
CREATE TYPE sys.ku$_LogEntry1010 AS TABLE OF sys.ku$_LogLine1010
CREATE OR REPLACE PUBLIC SYNONYM ku$_LogEntry1010 FOR sys.ku$_LogEntry1010;
CREATE OR REPLACE PUBLIC SYNONYM ku$_LogEntry1020 FOR sys.ku$_LogEntry1010;
CREATE OR REPLACE PUBLIC SYNONYM ku$_LogEntry FOR ku$_LogEntry1010;
The job status type returns status about a job. Usually, the status concerns a running job but it could also be about a stopped job when a client attaches. It is typically requested at attach time, when the client explicitly requests status from interactive mode and every N seconds when the client has requested status periodically.
The job status types are defined as follows (percent_done applies to data only):
CREATE TYPE sys.ku$_DumpFile1010 IS OBJECT (
file_name VARCHAR2(4000), -- Fully-qualified name
file_type NUMBER, -- 0=Disk, 1=Pipe, etc.
file_size NUMBER, -- Its length in bytes
file_bytes_written NUMBER -- Bytes written so far)
CREATE OR REPLACE PUBLIC SYNONYM ku$_DumpFile1010 FOR sys.ku$_DumpFile1010;
CREATE OR REPLACE PUBLIC SYNONYM ku$_DumpFile1020 FOR sys.ku$_DumpFile1010;
CREATE OR REPLACE PUBLIC SYNONYM ku$_DumpFile FOR ku$_DumpFile1010;
CREATE TYPE sys.ku$_DumpFileSet1010 AS TABLE OF sys.ku$_DumpFile1010;
CREATE OR REPLACE PUBLIC SYNONYM ku$_DumpFileSet1010 FOR
sys.ku$_DumpFileSet1010;
CREATE OR REPLACE PUBLIC SYNONYM ku$_DumpFileSet1020 FOR
sys.ku$_DumpFileSet1010;
CREATE OR REPLACE PUBLIC SYNONYM ku$_DumpFileSet FOR ku$_DumpFileSet1010;
CREATE TYPE sys.ku$_JobStatus1010 IS OBJECT (
job_name VARCHAR2(30),
operation VARCHAR2(30),
job_mode VARCHAR2(30),
bytes_processed NUMBER,
percent_done NUMBER,
degree NUMBER,
error_count NUMBER,
state VARCHAR2(30),
phase NUMBER,
restart_count NUMBER,
worker_status_list ku$_WorkerStatusList1010,
files ku$_DumpFileSet1010)
CREATE PUBLIC SYNONYM ku$_JobStatus1010 FOR
sys.ku$_JobStatus1010;
CREATE TYPE sys.ku$_JobStatus1020 IS OBJECT (
job_name VARCHAR2(30), -- Name of the job
operation VARCHAR2(30), -- Current operation
job_mode VARCHAR2(30), -- Current mode
bytes_processed NUMBER, -- Bytes so far
total_bytes NUMBER, -- Total bytes for job
percent_done NUMBER, -- Percent done
degree NUMBER, -- Of job parallelism
error_count NUMBER, -- #errors so far
state VARCHAR2(30), -- Current job state
phase NUMBER, -- Job phase
restart_count NUMBER, -- #Job restarts
worker_status_list ku$_WorkerStatusList1020, -- job worker processes
files ku$_DumpFileSet1010 -- Dump file info)
CREATE OR REPLACE PUBLIC SYNONYM ku$_JobStatus1020 FOR sys.ku$_JobStatus1020;
CREATE OR REPLACE PUBLIC SYNONYM ku$_JobStatus FOR ku$_JobStatus1020;
The job description type holds all the environmental information about the job such as parameter settings and dump file set members. There are a couple of subordinate types required as well.
The job description types are defined as follows:
CREATE TYPE sys.ku$_ParamValue1010 AS OBJECT (
param_name VARCHAR2(30),
param_op VARCHAR2(30),
param_type VARCHAR2(30),
param_length NUMBER,
param_value_n NUMBER,
param_value_t VARCHAR2(4000));
CREATE OR REPLACE PUBLIC SYNONYM ku$_ParamValue1010 FOR sys.ku$_ParamValue1010;
CREATE OR REPLACE PUBLIC SYNONYM ku$_ParamValue1020 FOR sys.ku$_ParamValue1010;
CREATE OR REPLACE PUBLIC SYNONYM ku$_ParamValue FOR ku$_ParamValue1010;
CREATE TYPE sys.ku$_ParamValues1010 AS TABLE OF sys.ku$_ParamValue1010;
CREATE OR REPLACE PUBLIC SYNONYM ku$_ParamValues1010 FOR
sys.ku$_ParamValues1010;
CREATE OR REPLACE PUBLIC SYNONYM ku$_ParamValues1020 FOR
sys.ku$_ParamValues1010;
CREATE OR REPLACE PUBLIC SYNONYM ku$_ParamValues FOR ku$_ParamValues1010;
CREATE TYPE sys.ku$_JobDesc1010 AS OBJECT (
job_name VARCHAR2(30),
guid RAW(16),
operation VARCHAR2(30),
job_mode VARCHAR2(30),
remote_link VARCHAR2(4000),
owner VARCHAR2(30),
instance VARCHAR2(16),
db_version VARCHAR2(30),
creator_privs VARCHAR2(30),
start_time DATE,
max_degree NUMBER,
log_file VARCHAR2(4000),
sql_file VARCHAR2(4000),
params ku$_ParamValues1010)
CREATE OR REPLACE PUBLIC SYNONYM ku$_JobDesc1010 FOR sys.ku$_JobDesc1010;
CREATE TYPE sys.ku$_JobDesc1020 IS OBJECT (
job_name VARCHAR2(30), -- The job name
guid RAW(16), -- The job GUID
operation VARCHAR2(30), -- Current operation
job_mode VARCHAR2(30), -- Current mode
remote_link VARCHAR2(4000), -- DB link, if any
owner VARCHAR2(30), -- Job owner
platform VARCHAR2(101), -- Current job platform
exp_platform VARCHAR2(101), -- Export platform
global_name VARCHAR2(4000), -- Global name of DB
exp_global_name VARCHAR2(4000), -- Export global name
instance VARCHAR2(16), -- The instance name
db_version VARCHAR2(30), -- Version of objects
exp_db_version VARCHAR2(30), -- Export version
scn NUMBER, -- Job SCN
creator_privs VARCHAR2(30), -- Privs of job
start_time DATE, -- This job start time
exp_start_time DATE, -- Export start time
term_reason NUMBER, -- Job termination code
max_degree NUMBER, -- Max. parallelism
log_file VARCHAR2(4000), -- Log file name
sql_file VARCHAR2(4000), -- SQL file name
params ku$_ParamValues1010 -- Parameter list)
CREATE OR REPLACE PUBLIC SYNONYM ku$_JobDesc1020 FOR sys.ku$_JobDesc1020;
CREATE OR REPLACE PUBLIC SYNONYM ku$_JobDesc FOR ku$_JobDesc1020;
The status type is an aggregate of some the previous types defined and is the return value for the GET_STATUS call. The mask attribute indicates which types of information are being returned to the caller. It is created by a client's shadow process from information it retrieves off the status queue or directly from the master table.
For errors, the ku$_LogEntry that is returned has already had its log lines ordered for proper output. That is, the original ku$_LogEntry objects have been ordered from outermost context to innermost.
The status types are defined as follows:
CREATE TYPE sys.ku$_Status1010 AS OBJECT ( mask NUMBER, /* Indicates which status types are present*/ wip ku$_LogEntry1010, /* Work-In-Progress: std. exp/imp msgs */ job_description ku$_JobDesc1010, /* Complete job description */ job_status ku$_JobStatus1010, /* Detailed job status + per-worker sts */ error ku$_LogEntry1010 /* Multi-level contextual errors */ )
CREATE OR REPLACE PUBLIC SYNONYM ku$_Status1010 FOR sys.ku$_Status1010;
CREATE TYPE sys.ku$_Status1020 IS OBJECT
(
mask NUMBER, -- Status types present
wip ku$_LogEntry1010, -- Work in progress
job_description ku$_JobDesc1020, -- Complete job description
job_status ku$_JobStatus1020, -- Detailed job status
error ku$_LogEntry1010 -- Multi-level context errors
)
CREATE OR REPLACE PUBLIC SYNONYM ku$_Status1020 FOR sys.ku$_Status1020;
CREATE OR REPLACE PUBLIC SYNONYM ku$_Status FOR ku$_Status1020;
Table 46-1 DBMS_DATAPUMP Package Subprograms
| Subprogram | Description |
|---|---|
|
Adds dump files to the dump file set for an Export, Import, or SQL_FILE operation. In addition to dump files, other types of files can also be added by using the |
|
|
Used to gain access to a Data Pump job that is in the Defining, Executing, Idling, or Stopped state |
|
|
Specifies restrictions on the rows that are to be retrieved |
|
|
Specifies that the user has no further interest in using the handle |
|
|
Retrieves information about a specified dump file |
|
|
Monitors the status of a job or waits for the completion of a job or for more details on API errors |
|
|
Inserts a message into the log file |
|
|
Provides filters that allow you to restrict the items that are included in a job |
|
|
Specifies a remapping to be applied to objects as they are processed in the specified job |
|
|
Specifies transformations to be applied to objects as they are processed in the specified job |
|
|
Declares a new job using the Data Pump API, the handle returned being used as a parameter for calls to all other procedures (but not to the |
|
|
Adjusts the degree of parallelism within a job |
|
|
Specifies job-processing options |
|
|
Begins or resumes execution of a job |
|
|
Terminates a job, but optionally, preserves the state of the job |
|
|
Runs a job until it either completes normally or stops for some other reason |
This procedure adds files to the dump file set for an Export, Import, or SQL_FILE operation or specifies the log file or the output file for a SQL_FILE operation.
DBMS_DATAPUMP.ADD_FILE ( handle IN NUMBER, filename IN VARCHAR2, directory IN VARCHAR2, filesize IN VARCHAR2 DEFAULT NULL, filetype IN NUMBER DEFAULT DBMS_DATAPUMP.KU$_FILE_TYPE_DUMP_FILE), reusefile IN NUMBER DEFAULT NULL;
Table 46-2 ADD_FILE Procedure Parameters
| Parameter | Description |
|---|---|
|
|
The handle of a job. The current session must have previously attached to the handle through a call to either the |
|
|
The name of the file being added. |
|
|
The name of a directory object within the database that is used to locate |
|
|
The size of the dump file that is being added. It may be specified as the number of bytes, number of kilobytes (if followed by K), number of megabytes (if followed by M) or number of gigabytes (if followed by G). An Export operation will write no more than the specified number of bytes to the file. Once the file is full, it will be closed. If there is insufficient space on the device to write the specified number of bytes, the Export operation will fail, but it can be restarted. If not specified, |
|
|
The type of the file to be added. The legal values are as follows and must be preceded by
|
|
|
If 0, a preexisting file will cause an error. If 1, a preexisting file will be overwritten. If NULL, the default action for the file type will be applied (that is, dump files will not be overwritten). This parameter should only be non-NULL for dump files. The |
INVALID_HANDLE. The specified handle is not attached to a Data Pump job.
INVALID_ARGVAL. An invalid value was supplied for an input parameter.
INVALID_STATE. The job is completing, or the job is past the defining state for an import or SQL_FILE job or is past the defining state for LOG and SQL files.
INVALID_OPERATION. A dump file was specified for a Network Import or ESTIMATE_ONLY export operation.
SUCCESS_WITH_INFO. The procedure succeeded, but further information is available through the GET_STATUS procedure.
NO_SUCH_JOB. The specified job does not exist.
Adds files to a Data Pump job. Three types of files may be added to jobs: Dump files to contain the data that is being moved, log files to record the messages associated with an operation, and SQL files to record the output of a SQL_FILE operation. Log and SQL files will overwrite previously existing files. Dump files will never overwrite previously existing files. Instead, an error will be generated.
Import and SQL_FILE operations require that all dump files be specified during the definition phase of the job. For Export operations, dump files can be added at any time. For example, if the user ascertains that the file space is running low during an Export, additional dump files may be added through this API. If the specified dump file already exists for an Export operation and reusefile is not set to 1, an error will be returned.
For Export operations, the parallelism setting should be less than or equal to the number of dump files in the dump file set. If there are not enough dump files, the job will not be able to maximize parallelism to the degree specified by the SET_PARALLEL procedure.
For Import operations, the parallelism setting should also be less than or equal to the number of dump files in the dump file set. If there are not enough dump files, the performance will not be optimal as multiple threads of execution try to access the same dump file.
If the substitution variable (%U) is included in a filename, multiple dump files may be specified through a single call to ADD_FILE. For Export operations, the new dump files will be created as they are needed. Enough dump files will be created to allow all of the processes specified by the current SET_PARALLEL value to be active. If one of the dump files fills, it will be closed and a new dump file (with a new generated name) will be created to take its place. If multiple ADD_FILEs with substitution variables have been specified for dump files in a job, they will be used to generate dump files in a round robin fashion. For example, if expa%U, expb%U and expc%U were all specified for a job having a parallelism of 6, the initial dump files created would look like: expa01, expb01, expc01, expa02, expb02, and expc02.
If presented with dump file specifications, expa%U, expb%U and expc%U, an Import or SQL_FILE operation will begin by attempting to open the dump files, expa01, expb01, and expc01.If the dump file containing the master table is not found in this set, the operation will expand its search for dump files by incrementing the substitution variable and looking up the new filenames (for example, expa02, expb02, and expc02). The DataPump API will keep expanding the search until it locates the dump file containing the master table. If the DataPump API determines that the dump file does not exist or is not part of the current dump set at any iteration, the DataPump API will stop incrementing the substitution variable for the dump file specification that was in error. Once the master table is found, the master table will be used to ascertain when all of dump files in the dump file set have been located.
This function gains access to a previously-created job.
DBMS_DATAPUMP.ATTACH( job_name IN VARCHAR2 DEFAULT NULL, job_owner IN VARCHAR2 DEFAULT NULL) RETURN NUMBER;
Table 46-3 ATTACH Function Parameters
| Parameter | Description |
|---|---|
|
|
The name of the job. The default is the job name owned by the user who is specified in the |
|
|
The user who originally started the job. If NULL, the value defaults to the owner of the current session. To specify a job owner other than yourself, you must have either the |
An opaque handle for the job. This handle is used as input to the following procedures: ADD_FILE, DATA_FILTER, DETACH, GET_STATUS, LOG_ENTRY, METADATA_FILTER, METADATA_REMAP, METADATA_TRANSFORM, SET_PARALLEL, SET_PARAMETER,START_JOB, STOP_JOB, and WAIT_FOR_JOB.
INVALID_ARGVAL. An invalid value was supplied for an input parameter.
OBJECT_NOT_FOUND. The specified job no longer exists or the user specified a job owned by another schema, but the user did not have the DATAPUMP_EXP_FULL_DATABASE or DATAPUMP_IMP_FULL_DATABASE role.
SUCCESS_WITH_INFO. The function succeeded, but further information is available through the GET_STATUS procedure.
NO_SUCH_JOB. The specified job does not exist.
If the job was in the Stopped state, the job is placed into the Idling state. Once the ATTACH succeeds, you can monitor the progress of the job or control the job. The stream of KU$_STATUS_WIP and KU$_STATUS_JOB_ERROR messages returned through the GET_STATUS procedure will be returned to the newly attached job starting at the approximate time of the client's attachment. There will be no repeating of status and error messages that were processed before the client attached to a job.
If you want to perform a second attach to a job, you must do so from a different session.
If the ATTACH fails, use a null handle in a subsequent call to GET_STATUS for more information about the failure.
This procedure specifies restrictions on the rows that are to be retrieved.
DBMS_DATAPUMP.DATA_FILTER ( handle IN NUMBER, name IN VARCHAR2, value IN NUMBER, table_name IN VARCHAR2 DEFAULT NULL, schema_name IN VARCHAR2 DEFAULT NULL); DBMS_DATAPUMP.DATA_FILTER( handle IN NUMBER, name IN VARCHAR2, value IN VARCHAR2, table_name IN VARCHAR2 DEFAULT NULL, schema_name IN VARCHAR2 DEFAULT NULL); DBMS_DATAPUMP.DATA_FILTER( handle IN NUMBER, name IN VARCHAR2, value IN CLOB, table_name IN VARCHAR2 DEFAULT NULL, schema_name IN VARCHAR2 DEFAULT NULL);
Table 46-4 DATA_FILTER Procedure Parameters
| Parameter | Description |
|---|---|
|
|
The handle that is returned from the |
|
|
The name of the filter |
|
|
The value of the filter |
|
|
The name of the table on which the data filter is applied. If no table name is supplied, the filter applies to all tables in the job. |
|
|
The name of the schema that owns the table on which the filter is applied. If no schema name is specified, the filter applies to all schemas in the job. If you supply a schema name you must also supply a table name. |
INVALID_ARGVAL. There can be several reasons for this message:
A bad filter name is specified
The mode is TRANSPORTABLE, which does not support data filters
The specified table does not exist
The filter has already been set for the specified values of schema_name and table_name
INVALID_STATE. The user called DATA_FILTER when the job was not in the Defining state.
INCONSISTENT_ARGS. The value parameter is missing or its datatype does not match the filter name. Or a schema name was supplied, but not a table name.
PRIVILEGE_ERROR. A schema name was supplied, but the user did not have the DATAPUMP_EXP_FULL_DATABASE or DATAPUMP_IMP_FULL_DATABASE role.
SUCCESS_WITH_INFO. The procedure succeeded, but further information is available through the GET_STATUS procedure.
NO_SUCH_JOB. The specified job does not exist.
Each data filter can only appear once in each table (for example, you cannot supply multiple SUBQUERY filters to a table) or once in each job. If different filters using the same name are applied to both a particular table and to the whole job, the filter parameter supplied for the specific table will take precedence.
With the exception of the INCLUDE_ROWS filter, data filters are not supported on tables having nested tables or domain indexes defined upon them. Data filters are not supported in jobs performed in Transportable Tablespace mode.
The available data filters are described in Table 46-5.
| Name | Datatype | Operations that Support Filter | Description |
|---|---|---|---|
|
|
|
EXPORT, IMPORT |
If nonzero, this filter specifies that user data for the specified table should be included in the job. The default is 1. |
|
|
text |
EXPORT, IMPORT |
For Export jobs, these filters specify which partitions are unloaded from the database. For Import jobs, they specify which table partitions are loaded into the database. Partition names are included in the job if their names satisfy the specified expression (for Double quotation marks around partition names are required only if the partition names contain special characters.
Default=All partitions are processed |
|
|
|
EXPORT, IMPORT |
For Export jobs, specifies a percentage for sampling the data blocks to be moved. This filter allows subsets of large tables to be extracted for testing purposes. |
|
|
text |
EXPORT, IMPORT |
Specifies a subquery that is added to the end of the |
This procedure specifies transformations to be applied to column data as it is exported from, or imported into, a database.
DBMS_DATAPUMP.DATA_REMAP( handle IN NUMBER, name IN VARCHAR2, table_name IN VARCHAR2, column IN VARCHAR2, remap_function IN VARCHAR2), schema IN VARCHAR2 DEFAULT NULL);
Table 46-6 DATA_REMAP Procedure Parameters
| Parameter | Description |
|---|---|
|
|
The handle of the current job. The current session must have previously attached to the handle through a call to an |
|
|
The name of the remap |
|
|
The table containing the column to be remapped |
|
|
The name of the column to be remapped |
|
|
The meaning of remap_function is dependent upon the value of name. See Table 46-7 for a list of possible names. |
|
|
The schema containing the column to be remapped. If NULL, the remapping applies to all schemas moved in the job that contain the specified table. |
INVALID_ARGVAL. The mode is transportable (which does not support data modifications) or it has specified that no data to be included in the job. An invalid remap name was supplied.
INVALID_OPERATION. Data remaps are only supported for Export and Import operations.
INVALID_STATE. The DATA_REMAP procedure was called after the job started (that is, it was not in the defining state).
NO_SUCH_JOB. The job handle is no longer valid.
The DATA_REMAP procedure is only supported for Export and Import operations. It allows you to manipulate user data being exported or imported. The name of the remap determines the remap operation to be performed.
For export operations, you might wish to define a data remap to obscure sensitive data such as credit card numbers from a dump file, but leave the remainder of the data so that it can be read. To accomplish this, the remapping should convert each unique source number into a distinct generated number. So that the mapping is consistent across the dump file set, the same function should be called for every column that contains the credit card number.
For import operations, you might wish to define a data remap to reset the primary key when data is being merged into an existing table that contains colliding primary keys. A single remapping function should be provided for all columns defining or referencing the primary key to ensure that remapping is consistent.
Note:
If the called function uses package state variables, then to ensure that remapping is performed consistently across all tables, the job should be run with a SET_PARALLEL value of 1 and no restart operations should be performed.The Data Remap functions are listed in Table 46-7.
Table 46-7 Names of Data Remap Functions
| Name | Meaning of remap_function |
Meaning |
|---|---|---|
|
|
String having the format:
|
The |
This procedure specifies that the user has no further interest in using the handle.
INVALID_HANDLE. The specified handle is not attached to a Data Pump job.
SUCCESS_WITH_INFO. The procedure succeeded, but further information is available through the GET_STATUS procedure.
NO_SUCH_JOB. The specified job does not exist.
Through this call, you specify that you have no further interest in using the handle. Resources associated with a completed job cannot be reclaimed until all users are detached from the job. An implicit detach from a handle is performed when the user's session is exited or aborted. An implicit detach from a handle is also performed upon the expiration of the timeout associated with a STOP_JOB that was applied to the job referenced by the handle. All previously allocated DBMS_DATAPUMP handles are released when an instance is restarted.
This procedure retrieves information about a specified dump file.
DBMS_DATAPUMP.GET_DUMPFILE_INFO( filename IN VARCHAR2, directory IN VARCHAR2, info_table OUT ku$_dumpfile_info, filetype OUT NUMBER);
Table 46-9 GET_DUMPFILE_INFO Procedure Parameters
| Parameter | Description |
|---|---|
|
|
A simple filename with no directory path information |
|
|
A directory object that specifies where the file can be found |
|
|
A PL/SQL table for storing information about the dump file |
|
|
The type of file (Data Pump dump file, original Export dump file, external tables dump file, or unknown) |
The GET_DUMPFILE_INFO procedure is a utility routine that operates outside the context of any Data Pump job. Exceptions are handled differently for this procedure than for procedures associated in some way with a Data Pump job. A full exception stack should be available directly, without the need to call the GET_STATUS procedure to retrieve the detailed information. The exception for this procedure is as follows:
NO_DUMPFILE_INFO. Unable to retrieve dump file information as specified.
You can use the GET_DUMPFILE_INFO procedure to request information about a specific file. If the file is not recognized as any type of dump file, then a filetype of 0 (zero) is returned and the dump file info_table remains empty.
A filetype value of 1 indicates a Data Pump dump file. A filetype value of 2 indicates an original Export dump file. A filetype value of 3 indicates an external tables dump file. In all cases, the dump file info_table will be populated with information retrieved from the dump file header. Rows of this table consist of item code and value pairs, where the item code indicates the type of information and the value column is a VARCHAR2 containing the actual data (converted to a string in some cases). The table is defined as follows:
CREATE TYPE sys.ku$_dumpfile_item IS OBJECT (
item_code NUMBER, -- Identifies header item
value VARCHAR2(2048) -- Text string value)/
GRANT EXECUTE ON sys.ku$_dumpfile_item TO PUBLIC;
CREATE OR REPLACE PUBLIC SYNONYM ku$_dumpfile_item FOR sys.ku$_dumpfile_item;
CREATE TYPE sys.ku$_dumpfile_info AS TABLE OF sys.ku$_dumpfile_item/
GRANT EXECUTE ON sys.ku$_dumpfile_info TO PUBLIC;
CREATE OR REPLACE PUBLIC SYNONYM ku$_dumpfile_info FOR sys.ku$_dumpfile_info;
The item codes, which can easily be extended to provide more information as needed, are currently defined as shown inTable 46-10 (prepended with the package name, DBMS_DATAPUMP.). Assume the following with regard to these item codes:
Unless otherwise stated, all item codes may be returned only for Oracle Data Pump and external tables dump files (filetypes 1 and 3).
Unless otherwise stated, all item codes have been available since Oracle Database 10g Release 2 (10.2).
Table 46-10 Item Codes for the DBMS_DATAPUMP.GET_DUMPFILE_INFO Procedure
| Item Code | Description |
|---|---|
|
|
The internal file version of the dump file. |
|
|
If the Data Pump master table is present in the dump file, then the value for this item code is 1; otherwise the value is 0. Returned only for filetype 1. |
|
|
A unique identifier assigned to the Data Pump export job or the external tables unload job that produced the dump file. For a multifile dump set, each file in the set has the same value for this item code. |
|
|
A numeric identifier assigned to the dump file.Each dump file in a multifile dump set has its own identifier, unique only within the dump set. |
|
|
A numeric code that represents the character set in use at the source system when the dump file was created. Returned for all filetypes. |
|
|
The date and time that the dump file was created. |
|
|
Internal flag values. |
|
|
The name assigned to the export job that created the dump file. Returned only for filetype 1. |
|
|
The operating system name of the source system on which the dump file was created. |
|
|
The instance name of the source system on which the dump file was created. |
|
|
The language name that corresponds to the character set of the source system where the export dump file was created. |
|
|
The blocksize, in bytes, of the dump file. |
|
|
If direct path mode was used when the dump file was created, then the value for this item code is 1, otherwise the value is 0. Returned only for filetype 2. |
|
|
If the system metadata is stored in the dump file in compressed format, then the value for this item code is 1, otherwise the value is 0. Returned only for filetype 1. |
|
|
The database job version used to create the dump file. Returned for all filetypes. |
|
|
The Data Pump master table may be split into multiple pieces and written to multiple dump files in the set, one piece per file. The value returned for this item code indicates the number of dump files that contain pieces of the master table. The value for this item code is only meaningful if the Data Pump master table is present in the dump file, as indicated by the item code Returned only for filetype 1. Only available since Oracle Database 11g Release 1 (11.1). |
|
|
The Data Pump master table may be split into multiple pieces and written to multiple dump files in the set, one piece per file. The value returned for this item code indicates which master table piece is contained in the dump file. The value for this item code is only meaningful if the Data Pump master table is present in the dump file, as indicated by the item code Returned only for filetype 1. Only available since Oracle Database 11g Release 1 (11.1). |
|
|
If the table data is stored in the dump file in compressed format, then the value for this item code is 1, otherwise the value is 0. Only available since Oracle Database 11g Release 1 (11.1). |
|
|
If the system metadata is stored in the dump file in encrypted format, then the value for this item code is 1, otherwise the value is 0. Returned only for filetype 1. Only available since Oracle Database 11g Release 1 (11.1). |
|
|
If the table data is stored in the dump file in encrypted format, then the value for this item code is 1, otherwise the value is 0. Only available since Oracle Database 11g Release 1 (11.1). |
|
|
If encrypted column data is stored in the dump file in encrypted format, then the value for this item code is 1, otherwise the value is 0. Returned only for filetype 1. Only available since Oracle Database 11g Release 1 (11.1). |
|
|
The encryption mode indicates whether a user-provided password or the Oracle Encryption Wallet was used to encrypt data written to the dump file. The possible values returned for this item code are:
Only available since Oracle Database 11g Release 1 (11.1). |
This procedure monitors the status of a job or waits for the completion of a job.
DBMS_DATAPUMP.GET_STATUS( handle IN NUMBER, mask IN BINARY_INTEGER, timeout IN NUMBER DEFAULT NULL, job_state OUT VARCHAR2, status OUT ku$_Status1010);
Table 46-11 GET_STATUS Procedure Parameters
| Parameter | Description |
|---|---|
|
|
The handle of a job. The current session must have previously attached to the handle through a call to either the |
|
|
A bit mask that indicates which of four types of information to return:
Each status has a numerical value. You can request multiple types of information by adding together different combinations of values. See Data Structures - Object Types. |
|
|
Maximum number of seconds to wait before returning to the user. A value of 0 requests an immediate return. A value of -1 requests an infinite wait. If |
|
|
Current state of the job. If only the job state is needed, it is much more efficient to use this parameter than to retrieve the full ku$_Status structure. |
|
|
A ku$_Status is returned. The ku$_Status mask indicates what kind of information is included. This could be none if only |
INVALID_HANDLE. The specified handle is not attached to a Data Pump job.
INVALID_VALUE. The mask or timeout contains an illegal value.
SUCCESS_WITH_INFO. The procedure succeeded, but further information is available through the GET_STATUS procedure.
NO_SUCH_JOB. The specified job does not exist.
The GET_STATUS procedure is used to monitor the progress of an ongoing job and to receive error notification. You can request various type of information using the mask parameter. The KU$_STATUS_JOB_DESC and KU$_STATUS_JOB_STATUS values are classified as synchronous information because the information resides in the master table. The KU$_STATUS_WIP and KU$_STATUS_JOB_ERROR values are classified as asynchronous because the messages that embody these types of information can be generated at any time by various layers in the Data Pump architecture.
If synchronous information only is requested, the interface will ignore the timeout parameter and simply return the requested information.
If asynchronous information is requested, the interface will wait a maximum of timeout seconds before returning to the client. If a message of the requested asynchronous information type is received, the call will complete prior to timeout seconds. If synchronous information was also requested, it will be returned whenever the procedure returns.
If the job_state returned by GET_STATUS does not indicate a terminating job, it is possible that the job could still terminate before the next call to GET_STATUS. This would result in an INVALID_HANDLE exception. Alternatively, the job could terminate during the call to GET_STATUS, which would result in a NO_SUCH_JOB exception. Callers should be prepared to handle these cases.
There are two types of error scenarios that need to be handled using the GET_STATUS procedure:
Errors resulting from other procedure calls: For example, the SET_PARAMETER procedure may produce an INCONSISTENT_ARGS exception. The client should immediately call GET_STATUS with mask=8 (errors) and timeout=0. The returned ku$_Status.error will contain a ku$_LogEntry that describes the inconsistency in more detail.
Errors resulting from events asynchronous to the client(s): An example might be Table already exists when trying to create a table. The ku$_Status.error will contain a ku$_LogEntry with all error lines (from all processing layers that added context about the error) properly ordered.
After a job has begun, a client's main processing loop will typically consist of a call to GET_STATUS with an infinite timeout (-1) "listening" for KU$_STATUS_WIP and KU$_STATUS_JOB_ERROR messages. If status was requested, then JOB_STATUS information will also be in the request.
When the ku$_Status is interpreted, the following guidelines should be used:
ku$_Status.ku$_JobStatus.percent_done refers only to the amount of data that has been processed in a job. Metadata is not considered in the calculation. It is determined using the following formulas:
EXPORT or network IMPORT--(bytes_processed/estimated_bytes) * 100
IMPORT--(bytes_processed/total_expected_bytes) * 100
SQL_FILE or estimate-only EXPORT--0.00 if not done or 100.00 if done
The effects of the QUERY and PARTITION_EXPR data filters are not considered in computing percent_done.
It is expected that the status returned will be transformed by the caller into more user-friendly status. For example, when percent done is not zero, an estimate of completion time could be produced using the following formula:
((SYSDATE - start time) / ku$_Status.ku$_JobStatus.percent_done) * 100
The caller should not use ku$_Status.ku$_JobStatus.percent_done for determining whether the job has completed. Instead, the caller should only rely on the state of the job as found in job_state.
This procedure inserts a message into the log file.
DBMS_DATAPUMP.LOG_ENTRY( handle IN NUMBER, message IN VARCHAR2 log_file_only IN NUMBER DEFAULT 0);
Table 46-12 LOG_ENTRY Procedure Parameters
| Parameter | Description |
|---|---|
|
|
The handle of a job. The current session must have previously attached to the handle through a call to either the |
|
|
A text line to be added to the log file |
|
|
Specified text should be written only to the log file. It should not be returned in |
INVALID_HANDLE. The specified handle is not attached to a Data Pump job.
SUCCESS_WITH_INFO. The procedure succeeded, but further information is available through the GET_STATUS procedure.
NO_SUCH_JOB. The specified job does not exist.
The message is added to the log file. If log_file_only is zero (the default), the message is also broadcast as a KU$_STATUS_WIP message through the GET_STATUS procedure to all users attached to the job.
The LOG_ENTRY procedure allows applications to tailor the log stream to match the abstractions provided by the application. For example, the command-line interface supports INCLUDE and EXCLUDE parameters defined by the user. Identifying these values as calls to the underlying METADATA_FILTER procedure would be confusing to users. Instead, the command-line interface can enter text into the log describing the settings for the INCLUDE and EXCLUDE parameters.
Lines entered in the log stream from LOG_ENTRY are prefixed by the string, ";;; "
This procedure provides filters that allow you to restrict the items that are included in a job.
DBMS_DATAPUMP.METADATA_FILTER( handle IN NUMBER, name IN VARCHAR2, value IN VARCHAR2, object_path IN VARCHAR2 DEFAULT NULL); DBMS_DATAPUMP.METADATA_FILTER( handle IN NUMBER, name IN VARCHAR2, value IN CLOB, object_path IN VARCHAR2 DEFAULT NULL);
Table 46-13 METADATA_FILTER Procedure Parameters
| Parameter | Description |
|---|---|
|
|
The handle returned from the |
|
|
The name of the filter. See Table 46-14 for descriptions of the available filters. |
|
|
The value of the filter |
|
|
The object path to which the filter applies. If the default is used, the filter applies to all applicable objects. Lists of the object paths supported for each mode are contained in the catalog views for For an import operation, object paths reference the mode used to create the dump file rather than the mode being used for the import. |
Table 46-14 describes the name, the object type, and the meaning of the filters available with the METADATA_FILTER procedure. The datatype for all the filters is a text expression. All operations support all filters.
Table 46-14 Filters Provided by METADATA_FILTER Procedure
| Name | Object Type | Meaning |
|---|---|---|
|
|
Named objects |
Defines which object names are included in the job. You use the object type parameter to limit the filter to a particular object type. For Table mode, identifies which tables are to be processed. |
|
|
Schema objects |
Restricts the job to objects whose owning schema name is satisfied by the expression. For Table mode, only a single For Schema mode, identifies which users are to be processed. |
|
|
|
Restricts the job to objects stored in a tablespace whose name is satisfied by the expression. For Tablespace mode, identifies which tablespaces are to be processed. If a partition of an object is stored in the tablespace, the entire object is added to the job. For Transportable mode, identifies which tablespaces are to be processed. If a table has a single partition in the tablespace set, all partitions must be in the tablespace set. An index is not included within the tablespace set unless all of its partitions are in the tablespace set. A domain index is not included in the tablespace set unless all of its secondary objects are included in the tablespace set. |
|
|
All |
Defines which object paths are included in, or excluded from, the job. You use these filters to select only certain object types from the database or dump file set. Objects of paths satisfying the condition are included ( |
INVALID_HANDLE. The specified handle is not attached to a Data Pump job.
INVALID_ARGVAL. This exception can indicate any of the following conditions:
An object_path was specified for an INCLUDE_PATH_EXPR or EXCLUDE_PATH_EXPR filter.
The specified object_path is not supported for the current mode.
The SCHEMA_EXPR filter specified multiple schemas for a Table mode job.
INVALID_STATE. The user called the METADATA_FILTER procedure after the job left the defining state.
INCONSISTENT_ARGS. The filter value is of the wrong datatype or is missing.
SUCCESS_WITH_INFO. The procedure succeeded but further information is available through the GET_STATUS procedure.
NO_SUCH_JOB. The specified job does not exist.
Metadata filters identify a set of objects to be included or excluded from a Data Pump operation. Except for EXCLUDE_PATH_EXPR and INCLUDE_PATH_EXPR, dependent objects of an identified object will be processed along with the identified object. For example, if an index is identified for inclusion by a filter, grants upon that index will also be included by the filter. Likewise, if a table is excluded by a filter, then indexes, constraints, grants and triggers upon the table will also be excluded by the filter.
Two versions of each filter are supported: SQL expression and List. The SQL expression version of the filters offer maximum flexibility for identifying objects (for example the use of LIKE to support use of wild cards). The names of the expression filters are as follows:
NAME_EXPR
SCHEMA_EXPR
TABLESPACE_EXPR
INCLUDE_PATH_EXPR
EXCLUDE_PATH_EXPR
The list version of the filters allow maximum validation of the filter. An error will be reported if one of the elements in the filter is not found within the source database (for Export and network-based jobs) or is not found within the dump file (for file-based Import and SQLFILE jobs). The names of the list filters are as follows:
NAME_LIST
SCHEMA_LIST
TABLESPACE_LIST
INCLUDE_PATH_LIST
EXCLUDE_PATH_LIST
Filters allow a user to restrict the items that are included in a job. For example, a user could request a full export, but without Package Specifications or Package Bodies.
If multiple filters are specified for a object type, they are implicitly 'ANDed' together (that is, objects participating in the job must pass all of the filters applied to their object types).
The same filter name can be specified multiple times within a job. For example, specifying NAME_EXPR as '!=''EMP''' and NAME_EXPR as '!=''DEPT''' on a Table mode export would produce a file set containing all of the tables except for EMP and DEPT.
This procedure specifies a remapping to be applied to objects as they are processed in the specified job.
DBMS_DATAPUMP.METADATA_REMAP ( handle IN NUMBER, name IN VARCHAR2, old_value IN VARCHAR2, value IN VARCHAR2, object_type IN VARCHAR2 DEFAULT NULL);
Table 46-15 METADATA_REMAP Procedure Parameters
| Parameter | Description |
|---|---|
|
|
The handle for the current job. The current session must have previously attached to the handle through a call to the |
|
|
The name of the remap. See Table 46-16 for descriptions of the available remaps. |
|
|
Specifies which value in the dump file set should be reset to |
|
|
The value of the parameter for the remap. This signifies the new value that |
|
|
Designates the object type to which the remap applies. The list of object types supported for each mode are contained in the By default, the remap applies to all applicable objects within the job. The |
Table 46-16 describes the remaps provided by the METADATA_REMAP procedure.
Table 46-16 Remaps Provided by the METADATA_REMAP Procedure
| Name | Datatype | Object Type | Meaning |
|---|---|---|---|
|
|
Text |
Schema objects |
Any schema object in the job that matches the Privileged users can perform unrestricted schema remaps. Nonprivileged users can perform schema remaps only if their schema is the target schema of the remap. For example, |
|
|
Text |
|
Any storage segment in the job that matches the |
|
|
Text |
|
Any datafile reference in the job that matches the |
|
|
Text |
|
Any reference to a table in the job that matches the |
INVALID_HANDLE. The specified handle is not attached to a Data Pump job.
INVALID_ARGVAL. This message can indicate any of the following:
The job's mode does not include the specified object_type.
The remap has already been specified for the specified old_value and object_type.
INVALID_OPERATION. Remaps are only supported for SQL_FILE and Import operations. The job's operation was Export, which does not support the use of metadata remaps.
INVALID_STATE. The user called METADATA_REMAP after the job had started (that is, the job was not in the defining state).
INCONSISTENT_ARGS. There was no value supplied or it was of the wrong datatype for the remap.
PRIVILEGE_ERROR. A nonprivileged user attempted to do a REMAP_SCHEMA to a different user's schema or a REMAP_DATAFILE.
SUCCESS_WITH_INFO. The procedure succeeded, but further information is available through the GET_STATUS procedure.
NO_SUCH_JOB. The specified job does not exist.
The METADATA_REMAP procedure is only supported for Import and SQL_FILE operations. It enables you to apply commonly desired, predefined remappings to the definition of objects as part of the transfer. If you need remaps that are not supported within this procedure, you should do a preliminary SQL_FILE operation to produce a SQL script corresponding to the dump file set. By editing the DDL directly and then executing it, you can produce any remappings that you need.
Transforms for the DataPump API are a subset of the remaps implemented by the DBMS_METADATA.SET_TRANSFORM_PARAMETER API. Multiple remaps can be defined for a single job. However, each remap defined must be unique according its parameters. That is, two remaps cannot specify conflicting or redundant remaps.
This procedure specifies transformations to be applied to objects as they are processed in the specified job.
DBMS_DATAPUMP.METADATA_TRANSFORM ( handle IN NUMBER, name IN VARCHAR2, value IN VARCHAR2, object_type IN VARCHAR2 DEFAULT NULL);
DBMS_DATAPUMP.METADATA_TRANSFORM ( handle IN NUMBER, name IN VARCHAR2, value IN NUMBER, object_type IN VARCHAR2 DEFAULT NULL);
Table 46-17 METADATA_TRANSFORM Procedure Parameters
| Parameter | Description |
|---|---|
|
|
The handle for the current job. The current session must have previously attached to the handle through a call to the |
|
|
The name of the transformation. See Table 46-18 for descriptions of the available transforms. |
|
|
The value of the parameter for the transform |
|
|
Designates the object type to which the transform applies. The list of object types supported for each mode are contained in the By default, the transform applies to all applicable objects within the job. The |
Table 46-18 describes the transforms provided by the METADATA_TRANSFORM procedure.
Table 46-18 Transforms Provided by the METADATA_TRANFORM Procedure
| Name | Datatype | Object Type | Meaning |
|---|---|---|---|
|
|
|
|
Specifies a percentage multiplier used to alter extent allocations and datafile sizes. Used to shrink large tablespaces for testing purposes. Defaults to 100. |
|
|
|
|
If nonzero ( Defaults to 1. |
|
|
|
|
If Defaults to nonzero ( |
|
|
|
|
If zero, inhibits the assignment of the exported OID during type or table creation. Instead, a new OID will be assigned. Use of this transform on Object Tables will cause breakage in REF columns that point to the table. Defaults to 1. |
|
|
|
|
If nonzero ( If the value is Defaults to nonzero ( (This functionality is available starting with Oracle Database 11g Release 2 (11.2.0.2).) |
INVALID_HANDLE. The specified handle is not attached to a Data Pump job.
INVALID_ARGVAL. This message can indicate any of the following:
The mode is transportable, which doesn't support transforms.
The job's mode does not include the specified object_type.
The transform has already been specified for the specified value and object_type.
INVALID_OPERATION. Transforms are only supported for SQL_FILE and Import operations. The job's operation was Export which does not support the use of metadata transforms.
INVALID_STATE. The user called METADATA_TRANSFORM after the job had started (that is, the job was not in the defining state).
INCONSISTENT_ARGS. There was no value supplied or it was of the wrong datatype for the transform.
PRIVILEGE_ERROR. A nonprivileged user attempted to do a REMAP_SCHEMA to a different user's schema or a REMAP_DATAFILE.
SUCCESS_WITH_INFO. The procedure succeeded, but further information is available through the GET_STATUS procedure.
NO_SUCH_JOB. The specified job does not exist.
The METADATA_TRANSFORM procedure is only supported for Import and SQL_FILE operations. It enables you to apply commonly desired, predefined transformations to the definition of objects as part of the transfer. If you need transforms that are not supported within this procedure, you should do a preliminary SQL_FILE operation to produce a SQL script corresponding to the dump file set. By editing the DDL directly and then executing it, you can produce any transformations that you need.
Transforms for the DataPump API are a subset of the transforms implemented by the DBMS_METADATA.SET_TRANSFORM_PARAMETER API. Multiple transforms can be defined for a single job. However, each transform defined must be unique according its parameters. That is, two transforms cannot specify conflicting or redundant transformations.
This function is used to declare a new job using the Data Pump API. The handle that is returned is used as a parameter for calls to all other procedures (but not to the ATTACH function).
DBMS_DATAPUMP.OPEN ( operation IN VARCHAR2, job_mode IN VARCHAR2, remote_link IN VARCHAR2 DEFAULT NULL, job_name IN VARCHAR2 DEFAULT NULL, version IN VARCHAR2 DEFAULT 'COMPATIBLE' RETURN NUMBER;
Table 46-19 OPEN Function Parameters
| Parameter | Meaning |
|---|---|
|
|
The type of operation to be performed. Table 46-20 contains descriptions of valid operation types. |
|
|
The scope of the operation to be performed. Table 46-21 contains descriptions of valid modes. Specifying NULL generates an error. |
|
|
If the value of this parameter is non-null, it provides the name of a database link to the remote database that will be the source of data and metadata for the current job. |
|
|
The name of the job. The name is limited to 30 characters; it will be truncated if more than 30 characters are used. It may consist of printable characters and spaces. It is implicitly qualified by the schema of the user executing the The name is used to identify the job both within the API and with other database components such as identifying the job in the The default job name is formed where |
|
|
The version of database objects to be extracted. This option is only valid for Export, network Import, and SQL_FILE operations. Database objects or attributes that are incompatible with the version will not be extracted. Legal values for this parameter are as follows:
|
Table 46-20 describes the valid operation types for the OPEN function.
Table 46-20 Valid Operation Types for the OPEN Function
| Operation | Description |
|---|---|
|
|
Saves data and metadata to a dump file set or obtains an estimate of the size of the data for an operation. |
|
|
Restores data and metadata from a dump file set or across a database link. |
|
|
Displays the metadata within a dump file set, or from across a network link, as a SQL script. The location of the SQL script is specified through the |
Table 46-21 describes the valid modes for the OPEN function.
Table 46-21 Valid Modes for the OPEN Function
| Mode | Description |
|---|---|
|
|
Operates on the full database or full dump file set except for the |
|
|
Operates on a set of selected schemas. Defaults to the schema of the current user. All objects in the selected schemas are processed. Users cannot specify |
|
|
Operates on a set of selected tables. Defaults to all of the tables in the current user's schema. Only tables and their dependent objects are processed. |
|
|
Operates on a set of selected tablespaces. No defaulting is performed. Tables that have storage in the specified tablespaces are processed in the same manner as in Table mode. |
|
|
Operates on metadata for tables (and their dependent objects) within a set of selected tablespaces to perform a transportable tablespace export/import. |
An opaque handle for the job. This handle is used as input to the following procedures: ADD_FILE, CREATE_JOB_VIEW, DATA_FILTER, DETACH, GET_STATUS, LOG_ENTRY, LOG_ERROR,METADATA_FILTER, METADATA_REMAP, METADATA_TRANSFORM, SET_PARALLEL,SET_PARAMETER, START_JOB,STOP_JOB, and WAIT_FOR_JOB
INVALID_ARGVAL. An invalid operation or mode was specified. A NULL or invalid value was supplied for an input parameter. The error message text identifies the parameter.
JOB_EXISTS. A table already exists with the specified job name.
PRIVILEGE_ERROR. The user does not have the necessary privileges or roles to use the specified mode.
INTERNAL_ERROR. The job was created under the wrong schema or the master table was of the wrong format.
SUCCESS_WITH_INFO. The function succeeded, but further information is available through the GET_STATUS procedure.
NO_SUCH_JOB. The specified job does not exist.
When the job is created, a master table is created for the job under the caller's schema within the caller's default tablespace. A handle referencing the job is returned that attaches the current session to the job. Once attached, the handle remains valid until either an explicit or implicit detach occurs. The handle is only valid in the caller's session. Other handles can be attached to the same job from a different session by using the ATTACH function.
If the call to the OPEN function fails, call the GET_STATUS procedure with a null handle to retrieve additional information about the failure.
This procedure adjusts the degree of parallelism within a job.
Table 46-22 SET_PARALLEL Procedure Parameters
| Parameter | Description |
|---|---|
|
|
The handle of a job. The current session must have previously attached to the handle through a call to either the |
|
|
The maximum number of worker processes that can be used for the job. You use this parameter to adjust the amount of resources used for a job. |
INVALID_HANDLE. The specified handle is not attached to a Data Pump job.
INVALID_OPERATION. The SET_PARALLEL procedure is only valid for export and import operations.
INVALID_ARGVAL. An invalid value was supplied for an input parameter.
SUCCESS_WITH_INFO. The procedure succeeded, but further information is available through the GET_STATUS procedure.
NO_SUCH_JOB. The specified job does not exist.
The SET_PARALLEL procedure is only available in the Enterprise Edition of the Oracle database.
The SET_PARALLEL procedure can be executed by any session attached to a job. The job must be in one of the following states: Defining, Idling, or Executing.
The effect of decreasing the degree of parallelism may be delayed because ongoing work needs to find an orderly completion point before SET_PARALLEL can take effect.
Decreasing the parallelism will not result in fewer worker processes associated with the job. It will only decrease the number of worker processes that will be executing at any given time.
Increasing the parallelism will take effect immediately if there is work that can be performed in parallel.
The degree of parallelism requested by a user may be decreased based upon settings in the resource manager or through limitations introduced by the PROCESSES or SESSIONS initialization parameters in the init.ora file.
To parallelize an Export job to a degree of n, the user should supply n files in the dump file set or specify a substitution variable in a file specification. Otherwise, some of the worker processes will be idle while waiting for files.
SQL_FILE operations always operate with a degree of 1. Jobs running in the Transportable mode always operate with a degree of 1.
This procedure is used to specify job-processing options.
DBMS_DATAPUMP.SET_PARAMETER( handle IN NUMBER, name IN VARCHAR2, value IN VARCHAR2); DBMS_DATAPUMP.SET_PARAMETER ( handle IN NUMBER, name IN VARCHAR2, value IN NUMBER);
Table 46-23 SET_PARAMETER Procedure Parameters
| Parameter | Description |
|---|---|
|
|
The handle of a job. The current session must have previously attached to the handle through a call to the |
|
|
The name of the parameter. Table 46-24 describes the valid parameter names. |
|
|
The value for the specified parameter |
Table 46-24 describes the valid options for the name parameter of the SET_PARAMETER procedure.
Table 46-24 Valid Options for the name Parameter in the SET_PARAMETER Procedure
| Parameter Name | Datatype | Supported Operations | Meaning |
|---|---|---|---|
|
|
Text |
All |
An opaque string used to describe the current operation from the client's perspective. The command-line procedures will use this string to store the original command used to invoke the job. |
|
|
Text |
Export |
Allows you to trade off the size of the dump file set versus the time it takes to perform export and import operations. The The The The The Default= |
|
|
Number |
Export and Import |
A bitmask to supply special options for processing the job. The possible values are as follows:
Export supports the value Import supports the value Import also supports the value Use of this parameter requires that the Default=0 |
|
|
Text |
Export |
Specifies what to encrypt in the dump file set, as follows:
This parameter requires a job version of 11.1 or later. The default value depends upon the combination of encryption-related parameters that are used. To enable encryption, either To specify NOTE: If the data being exported includes SecureFiles that you want to be encrypted, then you must specify |
|
|
Text |
Export |
Identifies which cryptographic algorithm should be used to perform encryption. Possible values are The This parameter requires a job version of 11.1 or later. Default= |
|
|
Text |
Export |
Identifies the types of security used for encryption and decryption. The values are as follows:
When you use the To use The default mode depends on which other encryption-related parameters are used. If only |
|
|
Text |
Export and Import |
Specifies a key for re-encrypting encrypted table columns, metadata, or table data so that they are not written as clear text in the dump file set. If the export operation involves encrypted table columns, but an encryption password is not supplied, then the encrypted columns will be written to the dump file set as clear text and a warning will be issued. NOTE: Data Pump encryption functionality has changed as of Oracle Database 11g release 1 (11.1). Prior to release 11.1, the For export operations, this parameter is required if If The To use the For network exports, the Encryption attributes for all columns must match between the exported table definition and the target table. This parameter requires a job version of 10.2 or later. |
|
|
Text |
Export and Import |
Specifies that the estimate method for the size of the tables should be performed before starting the job. If If The Default= |
|
|
Number |
Export |
Specifies that only the estimation portion of an export job should be performed. This option is useful for estimating the size of dump files when the size of the export is unknown. |
|
|
|
Export and network Import |
System change number (SCN) to serve as transactionally consistent point for reading user data. If neither |
|
|
Text |
Export and network Import |
Either the date and time used to determine a consistent point for reading user data or a string of the form If neither
|
|
|
|
Export and Import |
If nonzero, metadata for objects will be moved in addition to user table data. If zero, metadata for objects will not moved. This parameter converts an Export operation into an unload of user data and an Import operation into a load of user data.
Default=1 |
|
|
Text |
Import |
Specifies how partitioned tables should be handled during an import operation. The options are as follows:
This parameter requires a job version of 11.1 or later. Default= |
|
|
|
Import |
If nonzero, rows will be inserted into tables having unusable indexes. Default=1 |
|
|
Text |
Export and network Import |
The application edition that will be used for determining the objects that will be unloaded for export and for network import. |
|
|
Text |
Import |
Specifies the action to be performed when data is loaded into a preexisting table. The possible actions are: If If Note that if If If If
The default is |
|
|
Text |
Import |
Specifies the full file specification for a datafile in the transportable tablespace set.
|
|
|
Text |
Import |
The application edition that will be used for determining where the objects will be loaded for import and for network import. |
|
|
Text |
Export |
For export operations done in table mode, allows the data to be moved using transportable tablespaces. Storage segments in the moved tablespaces that are not associated with the parent schemas (tables) will be reclaimed at import time. If individual partitions are selected in a table-mode job, only the tablespaces referenced by those partitions will be moved. During import, the moved partitions can only be reconstituted as tables by using the Use of the The possible values for this parameter are as follows:
This parameter requires a job version of 11.1 or later Default= |
|
|
|
Export |
If nonzero, verifies that a transportable tablespace set has no dependencies (specifically, IN pointers) on objects outside the set, and vice versa. Only valid for Transportable mode Exports. Default=0 |
|
|
|
Export and network Import |
For schema-mode operations, specifies that the metadata to re-create the users' schemas (for example, privilege grants to the exported schemas) should also be part of the operation if set to nonzero. Users must be privileged to explicitly set this parameter. The Default=1 if user has |
INVALID_HANDLE. The specified handle is not attached to a Data Pump job.
INVALID_ARGVAL. This exception could be due to any of the following causes:
An invalid name was supplied for an input parameter
The wrong datatype was used for value
A value was not supplied
The supplied value was not allowed for the specified parameter name
A flashback parameter had been established after a different flashback parameter had already been established
A parameter was specified that did not support duplicate definitions
INVALID_OPERATION. The operation specified is invalid in this context.
INVALID_STATE. The specified job is not in the Defining state.
INCONSISTENT_ARGS. Either the specified parameter is not supported for the current operation type or it is not supported for the current mode.
PRIVILEGE_ERROR. The user does not have the DATAPUMP_EXP_FULL_DATABASE or DATAPUMP_IMP_FULL_DATABASE role required for the specified parameter.
SUCCESS_WITH_INFO. The procedure succeeded, but further information is available through the GET_STATUS procedure.
NO_SUCH_JOB. The specified job does not exist.
The SET_PARAMETER procedure is used to specify optional features for the current job. See Table 46-24 for a list of supported options.
This procedure begins or resumes execution of a job.
DBMS_DATAPUMP.START_JOB ( handle IN NUMBER, skip_current IN NUMBER DEFAULT 0, abort_step IN NUMBER DEFAULT 0, cluster_ok IN NUMBER DEFAULT 1, service_name IN VARCHAR2 DEFAULT NULL);
Table 46-25 START_JOB Procedure Parameters
| Parameter | Description |
|---|---|
|
|
The handle of a job. The current session must have previously attached to the handle through a call to either the |
|
|
If nonzero, causes actions that were 'in progress' on a previous execution of the job to be skipped when the job restarts. The skip will only be honored for Import jobs. This mechanism allows the user to skip actions that trigger fatal bugs and cause the premature termination of a job. Multiple actions can be skipped on a restart. The log file will identify which actions are skipped. If a domain index was being processed, all pieces of the domain index are skipped even if the error occurred in only a subcomponent of the domain index. A description of the actions skipped is entered into the log file. If zero, no data or metadata is lost upon a restart. |
|
|
Value must be 0. Inserting values other than 0 into this argument will have unintended consequences. |
|
|
If = 0, all workers are started on the current instance. Otherwise, workers are started on instances usable by the job. |
|
|
If specified, indicates a service name used to constrain the job to specific instances or to a specific resource group. |
INVALID_HANDLE. The specified handle is not attached to a Data Pump job.
INVALID_STATE. The causes of this exception can be any of the following:
No files have been defined for an Export, non-network Import, or SQL_FILE job
An ADD_FILE procedure has not been called to define the output for a SQL_FILE job
A TABLESPACE_DATAFILE parameter has not been defined for a Transportable Import job
A TABLESPACE_EXPR metadata filter has not been defined for a Transportable or Tablespace mode Export or Network job
The dump file set on an Import or SQL_FILE job was either incomplete or missing a master table specification
INVALID_OPERATION. Unable to restore master table from a dump file set.
INTERNAL_ERROR. An inconsistency was detected when the job was started. Additional information may be available through the GET_STATUS procedure.
SUCCESS_WITH_INFO. The procedure succeeded, but further information is available through the GET_STATUS procedure.
NO_SUCH_JOB. The specified job does not exist.
When this procedure is called to request that the corresponding job be started or restarted, the state of the job is changed from either the Defining or Idling state to the Executing state.
If the SET_PARALLEL procedure was not called prior to the START_JOB procedure, the initial level of parallelism used in the job will be 1. If SET_PARALLEL was called prior to the job starting, the degree specified by the last SET_PARALLEL call determines the parallelism for the job. On restarts, the parallelism is determined by the previous parallel setting for the job, unless it is overridden by another SET_PARALLEL call.
To restart a stopped job, an ATTACH function must be performed prior to executing the START_JOB procedure.
This procedure terminates a job, but optionally, preserves the state of the job.
DBMS_DATAPUMP.STOP_JOB ( handle IN NUMBER, immediate IN NUMBER DEFAULT 0, keep_master IN NUMBER DEFAULT NULL, delay IN NUMBER DEFAULT 60);
Table 46-26 STOP_JOB Procedure Parameters
| Parameter | Description |
|---|---|
|
|
The handle of a job. The current session must have previously attached to the handle through a call to either the |
|
|
If nonzero, the worker processes are aborted immediately. This halts the job quickly, but parts of the job will have to be rerun if the job is ever restarted. If zero, the worker processes are allowed to complete their current work item (either metadata or table data) before they are terminated. The job is placed in a Stop Pending state while the workers finish their current work. |
|
|
If nonzero, the master table is retained when the job is stopped. If zero, the master table is dropped when the job is stopped. If the master table is dropped, the job will not be restartable. If the master table is dropped during an export job, the created dump files are deleted. |
|
|
The number of seconds to wait until other attached sessions are forcibly detached. The delay allows other sessions attached to the job to be notified that a stop has been performed. The job keeps running until either all clients have detached or the delay has been satisfied. If no delay is specified, then the default delay is 60 seconds. If a shorter delay is used, clients might not be able to retrieve the final messages for the job through the |
INVALID_HANDLE. The specified handle is not attached to a Data Pump job.
INVALID STATE. The job is already in the process of being stopped or completed.
SUCCESS_WITH_INFO. The procedure succeeded, but further information is available through the GET_STATUS procedure.
NO_SUCH_JOB. The specified job does not exist.
This procedure is used to request that the corresponding job stop executing.
The termination of a job that is in an Executing state may take several minutes to complete in an orderly fashion.
For jobs in the Defining, Idling, or Completing states, this procedure is functionally equivalent to the DETACH procedure.
Once a job is stopped, it can be restarted using the ATTACH function and START_JOB procedures, provided the master table and the dump file set are left intact.
If the KEEP_MASTER parameter is not specified, and the job is in the Defining state or has a mode of Transportable, the master table is dropped. Otherwise, the master table is retained.
This procedure runs a job until it either completes normally or stops for some other reason.
Table 46-27 WAIT_FOR_JOB Procedure Parameters
| Parameter | Description |
|---|---|
|
|
The handle of the job. The current session must have previously attached to the handle through a call to either the |
|
|
The state of the job when it has stopped executing. This will be either Stopped or Completed. |
SUCCESS_WITH_INFO. The procedure succeeded, but further information is available through the GET_STATUS API.
INVALID_HANDLE. The job handle is no longer valid.
This procedure provides the simplest mechanism for waiting for the completion of a Data Pump job. The job should be started before calling WAIT_FOR_JOB. When WAIT_FOR_JOB returns, the job will no longer be executing. If the job completed normally, the final status will be Completed. If the job stopped executing because of a STOP_JOB request or an internal error, the final status will be Stopped.