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 12c, Release 1 (12.1), there is a sys.ku$_Status1210 type, and in the next Oracle Database release, there could be a sys.ku$_Status1310 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$_Status1210 is defined for the sys.ku$_Status1210 type.
The generic synonym always describes the latest version of that type. For example, in Oracle Database 12c, Release 1 (12.1), the generic synonym ku$_Status is defined as ku$_Status1210. In a future release, there might be a ku$_Status1310 synonym for sys.ku$Status1310. Because the ku$_Status generic synonym always points to the latest definition, it would then point to ku$_Status1310 rather than to ku$_Status1210.
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.
Data Structures â Object Types
The DBMS_DATAPUMP package defines the following kinds of OBJECT types:
Worker Status Types
Log Entry and Error Types
Job Status Types
Job Description Types
Status Types
Worker Status 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, -- 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
)
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 TYPE sys.ku$_WorkerStatus1120 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
instance_id NUMBER -- Instance ID where running
)
CREATE OR REPLACE PUBLIC SYNONYM ku$_WorkerStatus1120 FOR sys.ku$_WorkerStatus1120;
CREATE TYPE sys.ku$_WorkerStatus1210 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
instance_id NUMBER, -- Instance ID where running
instance_name VARCHAR2(60), -- Instance Name where running
host_name VARCHAR2(64) -- Host name where running
)
CREATE OR REPLACE PUBLIC SYNONYM ku$_WorkerStatus1210 FOR sys.ku$_WorkerStatus1210;
CREATE TYPE sys.ku$_WorkerStatus1220 AS OBJECT
(
worker_number NUMBER, -- Worker process identifier
process_name VARCHAR2(128),-- Worker process name
state VARCHAR2(30), -- Worker process state
schema VARCHAR2(128),-- Schema name
name VARCHAR2(4000),-- Object name
object_type VARCHAR2(200),-- Object type
partition VARCHAR2(128),-- 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
instance_id NUMBER, -- Instance ID where running
instance_name VARCHAR2(60), -- Instance Name where running
host_name VARCHAR2(101), -- Host name where running
access_method VARCHAR2(16), -- Access Method of object
obj_start_time DATE, -- Object start time
obj_status DATE -- Object status at current time
)
CREATE OR REPLACE PUBLIC SYNONYM ku$_WorkerStatus1220 FOR sys.ku$_WorkerStatus1220;
CREATE OR REPLACE PUBLIC SYNONYM ku$_WorkerStatus FOR ku$_WorkerStatus1220; CREATE TYPE sys.ku$_WorkerStatusList1010 AS TABLE OF sys.ku$_WorkerStatus1010 CREATE TYPE sys.ku$_WorkerStatusList1020 AS TABLE OF sys.ku$_WorkerStatus1020 CREATE TYPE sys.ku$_WorkerStatusList1120 AS TABLE OF sys.ku$_WorkerStatus1120 CREATE TYPE sys.ku$_WorkerStatusList1210 AS TABLE OF sys.ku$_WorkerStatus1210 CREATE TYPE sys.ku$_WorkerStatusList1220 AS TABLE OF sys.ku$_WorkerStatus1220 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$_WorkerStatusList1120 FOR sys.ku$_WorkerStatusList1120; CREATE OR REPLACE PUBLIC SYNONYM ku$_WorkerStatusList1210 FOR sys.ku$_WorkerStatusList1210; CREATE OR REPLACE PUBLIC SYNONYM ku$_WorkerStatusList1220 FOR sys.ku$_WorkerStatusList1220; CREATE OR REPLACE PUBLIC SYNONYM ku$_WorkerStatusList FOR ku$_WorkerStatusList1220;
Log Entry and Error Types
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;
Job Status Types
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$_JobStatus1010 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$_WorkerStatusList1010, -- For (non-idle)
-- job worker processes
files ku$_DumpFileSet1010 -- Dump file info
)
CREATE OR REPLACE 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, -- For (non-idle)
-- job worker processes
files ku$_DumpFileSet1010 -- Dump file info
)
CREATE OR REPLACE PUBLIC SYNONYM ku$_JobStatus1020 FOR sys.ku$_JobStatus1020;
CREATE TYPE sys.ku$_JobStatus1120 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$_WorkerStatusList1120, -- For (non-idle)
-- job worker processes
files ku$_DumpFileSet1010 -- Dump file info
)
CREATE OR REPLACE PUBLIC SYNONYM ku$_JobStatus1120 FOR sys.ku$_JobStatus1120;
CREATE TYPE sys.ku$_JobStatus1210 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$_WorkerStatusList1210, -- For (non-idle)
-- job worker processes
files ku$_DumpFileSet1010 -- Dump file info
)
CREATE OR REPLACE PUBLIC SYNONYM ku$_JobStatus1210 FOR sys.ku$_JobStatus1210;
CREATE TYPE sys.ku$_JobStatus1220 IS OBJECT
(
job_name VARCHAR2(128), -- 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
heartbeat NUMBER, -- Job heartbeat
worker_status_list ku$_WorkerStatusList1220, -- For (non-idle)
-- job worker processes
files ku$_DumpFileSet1010 -- Dump file info
)
CREATE OR REPLACE PUBLIC SYNONYM ku$_JobStatus1220 FOR sys.ku$_JobStatus1220;
CREATE OR REPLACE PUBLIC SYNONYM ku$_JobStatus FOR ku$_JobStatus1220;
Job Description Types
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$_JobDesc1010 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
instance VARCHAR2(16), -- The instance name
db_version VARCHAR2(30), -- Version of objects
creator_privs VARCHAR2(30), -- Privs of job
start_time DATE, -- This job start time
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$_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), -- Current global name
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 TYPE sys.ku$_JobDesc1210 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), -- Current global name
exp_global_name VARCHAR2(4000), -- Export global name
instance VARCHAR2(16), -- The instance name
db_version VARCHAR2(30), -- Cur. server software version
exp_db_version VARCHAR2(30), -- Export svr. software version
job_version VARCHAR2(30), -- Negotiated data 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
timezone VARCHAR2(64), -- Cur. server timezone
exp_timezone VARCHAR2(64), -- Exp. server timezone
tstz_version NUMBER, -- Cur. server timezone version
exp_tstz_version NUMBER, -- Exp. server timezone
endianness VARCHAR2(16), -- Cur. platform's endianness
exp_endianness VARCHAR2(16), -- Exp. platform's endianness
-- endianness is 'BIG' or 'LITTLE'
charset VARCHAR2(28), -- Cur. server charset
exp_charset VARCHAR2(28), -- Exp. server charset
ncharset VARCHAR2(28), -- Cur. server national charset
exp_ncharset VARCHAR2(28), -- Exp. server national charset
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$_JobDesc1210 FOR sys.ku$_JobDesc1210;
CREATE TYPE sys.ku$_JobDesc1220 IS OBJECT
(
job_name VARCHAR2(128), -- 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(128), -- Job owner
platform VARCHAR2(101), -- Current job platform
exp_platform VARCHAR2(101), -- Export platform
global_name VARCHAR2(4000), -- Current global name
exp_global_name VARCHAR2(4000), -- Export global name
instance VARCHAR2(60), -- The instance name
db_version VARCHAR2(60), -- Cur. server software version
exp_db_version VARCHAR2(60), -- Export svr. software version
job_version VARCHAR2(60), -- Negotiated data 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
timezone VARCHAR2(64), -- Cur. server timezone
exp_timezone VARCHAR2(64), -- Exp. server timezone
tstz_version NUMBER, -- Cur. server timezone version
exp_tstz_version NUMBER, -- Exp. server timezone
endianness VARCHAR2(16), -- Cur. platform's endianness
exp_endianness VARCHAR2(16), -- Exp. platform's endianness
-- endianness is 'BIG' or 'LITTLE'
charset VARCHAR2(28), -- Cur. server charset
exp_charset VARCHAR2(28), -- Exp. server charset
ncharset VARCHAR2(28), -- Cur. server national charset
exp_ncharset VARCHAR2(28), -- Exp. server national charset
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$_JobDesc1220 FOR sys.ku$_JobDesc1220;
CREATE OR REPLACE PUBLIC SYNONYM ku$_JobDesc FOR ku$_JobDesc1220;
Status Types
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 IS OBJECT
(
mask NUMBER, -- Status types present
wip ku$_LogEntry1010, -- Work in progress
job_description ku$_JobDesc1010, -- Complete job description
job_status ku$_JobStatus1010,-- Detailed job status
error ku$_LogEntry1010 -- Multi-level context 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 TYPE sys.ku$_Status1120 IS OBJECT
(
mask NUMBER, -- Status types present
wip ku$_LogEntry1010, -- Work in progress
job_description ku$_JobDesc1020, -- Complete job description
job_status ku$_JobStatus1120,-- Detailed job status
error ku$_LogEntry1010 -- Multi-level context errors
)
CREATE OR REPLACE PUBLIC SYNONYM ku$_Status1120 FOR sys.ku$_Status1120;
CREATE TYPE sys.ku$_Status1210 IS OBJECT
(
mask NUMBER, -- Status types present
wip ku$_LogEntry1010, -- Work in progress
job_description ku$_JobDesc1210, -- Complete job description
job_status ku$_JobStatus1210,-- Detailed job status
error ku$_LogEntry1010 -- Multi-level context errors
)
CREATE OR REPLACE PUBLIC SYNONYM ku$_Status1210 FOR sys.ku$_Status1210;
CREATE TYPE sys.ku$_Status1220 IS OBJECT
(
mask NUMBER, -- Status types present
wip ku$_LogEntry1010, -- Work in progress
job_description ku$_JobDesc1220, -- Complete job description
job_status ku$_JobStatus1220,-- Detailed job status
error ku$_LogEntry1010 -- Multi-level context errors
)
CREATE OR REPLACE PUBLIC SYNONYM ku$_Status1220 FOR sys.ku$_Status1220;
CREATE OR REPLACE PUBLIC SYNONYM ku$_Status FOR ku$_Status1220;
RetroSearch is an open source project built by @garambo | Open a GitHub Issue
Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo
HTML:
3.2
| Encoding:
UTF-8
| Version:
0.7.4