2.5 Commands Available in Data Pump Export Interactive-Command Mode
Check which command options are available to you when using Data Pump Export in interactive mode.
- About Oracle Data Pump Export Interactive Command Mode
Learn about commands you can use with Oracle Data Pump Export in interactive command mode while your current job is running. - ADD_FILE
The Oracle Data Pump Export interactive command modeADD_FILE
parameter adds additional files or substitution variables to the export dump file set. - CONTINUE_CLIENT
The Oracle Data Pump Export interactive command modeCONTINUE_CLIENT
parameter changes the Export mode from interactive-command mode to logging mode. - EXIT_CLIENT
The Oracle Data Pump Export interactive command modeEXIT_CLIENT
parameter stops the export client session, exits Export, and discontinues logging to the terminal, but leaves the current job running. - FILESIZE
The Oracle Data Pump Export interactive command modeFILESIZE
parameter redefines the maximum size of subsequent dump files. - HELP
The Oracle Data Pump Export interactive command modeHELP
parameter provides information about Data Pump Export commands available in interactive-command mode. - KILL_JOB
The Oracle Data Pump Export interactive command modeKILL_JOB
parameter detaches all currently attached worker client sessions, and then terminates the current job. It exits Export, and returns to the terminal prompt. - PARALLEL
The Export Interactive-Command ModePARALLEL
parameter enables you to increase or decrease the number of active processes (child and parallel child processes) for the current job. - START_JOB
The Oracle Data Pump Export interactive command modeSTART_JOB
parameter starts the current job to which you are attached. - STATUS
The Oracle Data Pump Export interactive commandSTATUS
parameter displays status information about the export, and enables you to set the display interval for logging mode status. - STOP_JOB
The Oracle Data Pump Export interactive command modeSTOP_JOB
parameter stops the current job. It stops the job either immediately, or after an orderly shutdown, and exits Export.
Parent topic: Oracle Data Pump Export
2.5.1 About Oracle Data Pump Export Interactive Command Mode
Learn about commands you can use with Oracle Data Pump Export in interactive command mode while your current job is running.
In interactive command mode, the current job continues running, but logging to the terminal is suspended, and the Export prompt (Export>
) is displayed.
To start interactive-command mode, do one of the following:
-
From an attached client, press Ctrl+C.
-
From a terminal other than the one on which the job is running, specify the
ATTACH
parameter in anexpdp
command to attach to the job.ATTACH
is a useful feature in situations in which you start a job at one location, and need to check on it at a later time from a different location.
The following table lists the activities that you can perform for the current job from the Data Pump Export prompt in interactive-command mode.
Table 2-1 Supported Activities in Data Pump Export's Interactive-Command Mode
Activity | Command Used |
---|---|
Add additional dump files. |
|
Exit interactive mode and enter logging mode. |
|
Stop the export client session, but leave the job running. |
EXIT_CLIENT |
Redefine the default size to be used for any subsequent dump files. |
|
Display a summary of available commands. |
HELP |
Detach all currently attached client sessions and terminate the current job. |
KILL_JOB |
Increase or decrease the number of active worker processes for the current job. This command is valid only in the Enterprise Edition of Oracle Database 11g or later. |
PARALLEL |
Restart a stopped job to which you are attached. |
START_JOB |
Display detailed status for the current job and/or set status interval. |
STATUS |
Stop the current job for later restart. |
STOP_JOB |
2.5.2 ADD_FILE
The Oracle Data Pump Export interactive command mode
ADD_FILE
parameter adds additional files or substitution variables to
the export dump file set.
Purpose
Adds additional files or substitution variables to the export dump file set.
Syntax and Description
ADD_FILE=[directory_object:]file_name [,...]
Each file name can have a different directory object. If no directory object is specified, then the default is assumed.
The file_name
must not
contain any directory path information. However, it can include a substitution
variable, %U
, which indicates that multiple files can be generated
using the specified file name as a template.
The size of the file being added is determined by the setting of the
FILESIZE
parameter.
Example
The following example adds two dump files to the dump file set. A directory object is not specified for the dump file named hr2.dmp
, so the default directory object for the job is assumed. A different directory object, dpump_dir2
, is specified for the dump file named hr3.dmp
.
Export> ADD_FILE=hr2.dmp, dpump_dir2:hr3.dmp
Related Topics
2.5.3 CONTINUE_CLIENT
The Oracle Data Pump Export interactive command mode
CONTINUE_CLIENT
parameter changes the Export mode from
interactive-command mode to logging mode.
Purpose
Changes the Export mode from interactive-command mode to logging mode.
Syntax and Description
CONTINUE_CLIENT
In logging mode, status is continually output to the terminal. If the job is currently stopped, then CONTINUE_CLIENT
also causes the client to attempt to start the job.
Example
Export> CONTINUE_CLIENT
2.5.4 EXIT_CLIENT
The Oracle Data Pump Export interactive command mode
EXIT_CLIENT
parameter stops the export client session, exits Export,
and discontinues logging to the terminal, but leaves the current job running.
Purpose
Stops the export client session, exits Export, and discontinues logging to the terminal, but leaves the current job running.
Syntax and Description
EXIT_CLIENT
Because EXIT_CLIENT
leaves the job running, you can attach to the job at a later time. To see the status of the job, you can monitor the log file for the job, or you can query the USER_DATAPUMP_JOBS
view, or the V$SESSION_LONGOPS
view.
Example
Export> EXIT_CLIENT
2.5.5 FILESIZE
The Oracle Data Pump Export interactive command mode
FILESIZE
parameter redefines the maximum size of subsequent dump
files.
Purpose
Redefines the maximum size of subsequent dump files. If the size is reached for any member of the dump file set, then that file is closed and an attempt is made to create a new file, if the file specification contains a substitution variable or if additional dump files have been added to the job.
Syntax and Description
FILESIZE=integer[B | KB | MB | GB | TB]
The integer
can be immediately followed (do not insert a space) by B
, KB
, MB
, GB
, or TB
(indicating bytes, kilobytes, megabytes, gigabytes, and terabytes respectively). Bytes is the default. The actual size of the resulting file may be rounded down slightly to match the size of the internal blocks used in dump files.
A file size of 0 is equivalent to the maximum file size of 16 TB.
Restrictions
- The minimum size for a file is ten times the default Oracle Data Pump block size, which is 4 kilobytes.
- The maximum size for a file is 16 terabytes.
Example
Export> FILESIZE=100MB
2.5.6 HELP
The Oracle Data Pump Export interactive command mode HELP
parameter provides information about Data Pump Export commands available in
interactive-command mode.
Purpose
Provides information about Oracle Data Pump Export commands available in interactive-command mode.
Syntax and Description
HELP
Displays information about the commands available in interactive-command mode.
Example
Export> HELP
2.5.7 KILL_JOB
The Oracle Data Pump Export interactive command mode
KILL_JOB
parameter detaches all currently attached worker client
sessions, and then terminates the current job. It exits Export, and returns to the terminal
prompt.
Purpose
Detaches all currently attached child client sessions, and then terminates the current job. It exits Export and returns to the terminal prompt.
Syntax and Description
KILL_JOB
A job that is terminated using KILL_JOB
cannot be restarted. All
attached clients, including the one issuing the KILL_JOB
command,
receive a warning that the job is being terminated by the current user and are then
detached. After all child clients are detached, the job's process structure is
immediately run down and the Data Pump control job table and dump files are deleted.
Log files are not deleted.
Example
Export> KILL_JOB
2.5.8 PARALLEL
The Export Interactive-Command Mode PARALLEL
parameter
enables you to increase or decrease the number of active processes (child and parallel child
processes) for the current job.
Purpose
Enables you to increase or decrease the number of active processes (child and parallel child processes) for the current job.
Syntax and Description
PARALLEL=integer
PARALLEL
is available as both a command-line parameter, and as an
interactive-command mode parameter. You set it to the desired number of parallel
processes (child and parallel child processes). An increase takes effect immediately
if there are sufficient files and resources. A decrease does not take effect until
an existing process finishes its current task. If the value is decreased, then child
processes are idled but not deleted until the job exits.
Restrictions
- This parameter is valid only in the Enterprise Edition of Oracle Database 11g or later releases.
- Transportable tablespace metadata cannot be imported in parallel.
- Metadata cannot be imported in parallel when the
NETWORK_LINK
parameter is used.
In addition, the following objects cannot be imported in parallel:
TRIGGER
VIEW
OBJECT_GRANT
SEQUENCE
CONSTRAINT
REF_CONSTRAINT
Example
Export> PARALLEL=10
Related Topics
2.5.9 START_JOB
The Oracle Data Pump Export interactive command mode
START_JOB
parameter starts the current job to
which you are attached.
Purpose
Starts the current job to which you are attached.
Syntax and Description
START_JOB
The START_JOB
command restarts the current job to which you are
attached. The job cannot be running at the time that
you enter the command. The job is restarted with no
data loss or corruption after an unexpected failure
or after you issued a STOP_JOB
command, provided the dump file set and
parent job table have
not been altered in any way.
Example
Export> START_JOB
2.5.10 STATUS
The Oracle Data Pump Export interactive command STATUS
parameter displays status information about the export, and enables you to set the display
interval for logging mode status.
Purpose
Displays cumulative status of the job, a description of the current operation, and an estimated completion percentage. It also allows you to reset the display interval for logging mode status.
Syntax and Description
STATUS[=integer]
You have the option of specifying how frequently, in seconds, this status should be displayed in logging mode. If no value is entered, or if the default value of 0 is used, then the periodic status display is turned off, and status is displayed only once.
This status information is written only to your standard output device, not to the log file (even if one is in effect).
Example
The following example displays the current job status, and changes the logging mode display interval to five minutes (300 seconds):
Export> STATUS=300
2.5.11 STOP_JOB
The Oracle Data Pump Export interactive command mode
STOP_JOB
parameter stops the current job. It stops the job either
immediately, or after an orderly shutdown, and exits Export.
Purpose
Stops the current job, either immediately, or after an orderly shutdown, and exits Export.
Syntax and Description
STOP_JOB[=IMMEDIATE]
If the Data Pump control job table and dump file set are not disturbed when or after
the STOP_JOB
command is issued, then the job can be attached to and
restarted at a later time with the START_JOB
command.
To perform an orderly shutdown, use STOP_JOB
(without any associated value). A warning requiring confirmation will be issued. An orderly shutdown stops the job after worker processes have finished their current tasks.
To perform an immediate shutdown, specify
STOP_JOB
=IMMEDIATE
. A warning requiring
confirmation will be issued. All attached clients, including the one issuing the
STOP_JOB
command, receive a warning that the job is being
stopped by the current user and they will be detached. After all clients are
detached, the process structure of the job is immediately run down. That is, the
Data Pump control job process will not wait for the
child processes to finish their current tasks. There is no risk of corruption or
data loss when you specify STOP_JOB=IMMEDIATE
. However, some tasks
that were incomplete at the time of shutdown may have to be redone at restart
time.
Example
Export> STOP_JOB=IMMEDIATE