30 DBMS_CAPTURE_ADM

The DBMS_CAPTURE_ADM package, one of a set of Oracle Streams packages, provides subprograms for starting, stopping, and configuring a capture process. The source of the captured changes is the redo logs, and the repository for the captured changes is a queue.

See Also:

Oracle Streams Concepts and Administration and Oracle Streams Replication Administrator's Guide for more information about this package and capture processes

This chapter contains the following topic:

Summary of DBMS_CAPTURE_ADM Subprograms

Summary of DBMS_CAPTURE_ADM Subprograms

Table 30-1 DBMS_CAPTURE_ADM Package Subprograms

Subprogram	Description
ABORT_GLOBAL_INSTANTIATION Procedure	Reverses the effects of running the `PREPARE_GLOBAL_INSTANTIATION`, `PREPARE_SCHEMA_INSTANTIATION`, and `PREPARE_TABLE_INSTANTIATION` procedures
ABORT_SCHEMA_INSTANTIATION Procedure	Reverses the effects of running the `PREPARE_SCHEMA_INSTANTIATION` and `PREPARE_TABLE_INSTANTIATION` procedures
ABORT_SYNC_INSTANTIATION Procedure	Reverses the effects of running the `PREPARE_SYNC_INSTANTIATION` procedure
ABORT_TABLE_INSTANTIATION Procedure	Reverses the effects of running the `PREPARE_TABLE_INSTANTIATION` procedure
ALTER_CAPTURE Procedure	Alters a capture process
ALTER_SYNC_CAPTURE Procedure	Alters a synchronous capture
BUILD Procedure	Extracts the data dictionary of the current database to the redo logs and automatically specifies database supplemental logging for all primary key and unique key columns
CREATE_CAPTURE Procedure	Creates a capture process
CREATE_SYNC_CAPTURE Procedure	Creates a synchronous capture
DROP_CAPTURE Procedure	Drops a capture process
INCLUDE_EXTRA_ATTRIBUTE Procedure	Includes or excludes an extra attribute in logical change records (LCRs) captured by the specified capture process or synchronous capture
PREPARE_GLOBAL_INSTANTIATION Procedure	Performs the synchronization necessary for instantiating all the tables in the database at another database and can enable supplemental logging for key columns or all columns in these tables
PREPARE_SCHEMA_INSTANTIATION Procedure	Performs the synchronization necessary for instantiating all tables in the schema at another database and can enable supplemental logging for key columns or all columns in these tables
PREPARE_SYNC_INSTANTIATION Function	Performs the synchronization necessary for instantiating one or more tables at another database and returns the prepare SCN
PREPARE_TABLE_INSTANTIATION Procedure	Performs the synchronization necessary for instantiating the table at another database and can enable supplemental logging for key columns or all columns in the table
SET_PARAMETER Procedure	Sets a capture process parameter to the specified value
START_CAPTURE Procedure	Starts the capture process, which mines redo logs and enqueues the mined redo information into the associated queue
STOP_CAPTURE Procedure	Stops the capture process from mining redo logs

Note:

All subprograms commit unless specified otherwise.

ABORT_GLOBAL_INSTANTIATION Procedure

This procedure reverses the effects of running the PREPARE_GLOBAL_INSTANTIATION, PREPARE_SCHEMA_INSTANTIATION, and PREPARE_TABLE_INSTANTIATION procedures.

Specifically, this procedure performs the following actions:

Removes data dictionary information related to the database, schema, and table instantiations
Removes any supplemental logging enabled by the PREPARE_GLOBAL_INSTANTIATION, PREPARE_SCHEMA_INSTANTIATION, and PREPARE_TABLE_INSTANTIATION procedures

Syntax

DBMS_CAPTURE_ADM.ABORT_GLOBAL_INSTANTIATION();

ABORT_SCHEMA_INSTANTIATION Procedure

This procedure reverses the effects of running the PREPARE_SCHEMA_INSTANTIATION procedure. It also reverses the effects of running the PREPARE_TABLE_INSTANTIATION procedure on tables in the specified schema.

Specifically, this procedure performs the following actions:

Removes data dictionary information related to schema instantiations and table instantiations of tables in the schema
Removes any supplemental logging enabled by the PREPARE_SCHEMA_INSTANTIATION procedure
Removes any supplemental logging enabled by the PREPARE_TABLE_INSTANTIATION procedure for tables in the specified schema

Syntax

DBMS_CAPTURE_ADM.ABORT_SCHEMA_INSTANTIATION(
   schema_name  IN  VARCHAR2);

Parameter

Table 30-2 ABORT_SCHEMA_INSTANTIATION Procedure Parameter

Parameter	Description
`schema_name`	The name of the schema for which to abort the effects of preparing instantiation

ABORT_SYNC_INSTANTIATION Procedure

This procedure reverses the effects of running the PREPARE_SYNC_INSTANTIATION procedure. Specifically, this procedure removes data dictionary information related to the table instantiation.

This procedure is overloaded. The table_names parameter is VARCHAR2 data type in one version and DBMS_UTILITY.UNCL_ARRAY data type in the other version.

Syntax

DBMS_CAPTURE_ADM.ABORT_SYNC_INSTANTIATION(
   table_names IN VARCHAR2);

DBMS_CAPTURE_ADM.ABORT_SYNC_INSTANTIATION(
   table_names IN DBMS_UTILITY.UNCL_ARRAY);

Parameters

Table 30-3 ABORT_SYNC_INSTANTIATION Procedure Parameter

Parameter Description

Parameter	Description
`table_names`	When the `table_names` parameter is `VARCHAR2` data type, a comma-delimited list of the tables for which to abort the effects of preparing instantiation. There must be no spaces between entries. When the `table_names` parameter is `DBMS_UTILITY.UNCL_ARRAY` data type, specify a PL/SQL index-by table of this type that contains the names of the tables for which to abort the effects of preparing instantiation. The first table name should be at position 1, the second at position 2, and so on. The table does not need to be `NULL` terminated. In either version of the procedure, specify the name of each table in the form `[schema_name.]table_name`. For example, `hr.employees`. If the schema is not specified, then the current user is the default.

table_names

When the table_names parameter is VARCHAR2 data type, a comma-delimited list of the tables for which to abort the effects of preparing instantiation. There must be no spaces between entries.

When the table_names parameter is DBMS_UTILITY.UNCL_ARRAY data type, specify a PL/SQL index-by table of this type that contains the names of the tables for which to abort the effects of preparing instantiation. The first table name should be at position 1, the second at position 2, and so on. The table does not need to be NULL terminated.

In either version of the procedure, specify the name of each table in the form [schema_name.]table_name. For example, hr.employees. If the schema is not specified, then the current user is the default.

ABORT_TABLE_INSTANTIATION Procedure

This procedure reverses the effects of running the PREPARE_TABLE_INSTANTIATION procedure.

Specifically, this procedure performs the following actions:

Removes data dictionary information related to the table instantiation
Removes any supplemental logging enabled by the PREPARE_TABLE_INSTANTIATION procedure

Syntax

DBMS_CAPTURE_ADM.ABORT_TABLE_INSTANTIATION(
   table_name  IN  VARCHAR2);

Parameter

Table 30-4 ABORT_TABLE_INSTANTIATION Procedure Parameter

Parameter	Description
`table_name`	The name of the table for which to abort the effects of preparing instantiation, specified as `[schema_name.]object_name`. For example, `hr.employees`. If the schema is not specified, then the current user is the default.

ALTER_CAPTURE Procedure

This procedure alters a capture process.

See Also:

Oracle Streams Concepts and Administration for more information about altering a capture process

Syntax

DBMS_CAPTURE_ADM.ALTER_CAPTURE(
   capture_name              IN  VARCHAR2,
   rule_set_name             IN  VARCHAR2  DEFAULT NULL,
   remove_rule_set           IN  BOOLEAN   DEFAULT FALSE,
   start_scn                 IN  NUMBER    DEFAULT NULL,
   use_database_link         IN  BOOLEAN   DEFAULT NULL,
   first_scn                 IN  NUMBER    DEFAULT NULL,
   negative_rule_set_name    IN  VARCHAR2  DEFAULT NULL,
   remove_negative_rule_set  IN  BOOLEAN   DEFAULT FALSE,
   capture_user              IN  VARCHAR2  DEFAULT NULL,
   checkpoint_retention_time IN  NUMBER    DEFAULT NULL);

Parameters

Table 30-5 ALTER_CAPTURE Procedure Parameters

Parameter	Description
`capture_name`	The name of the capture process being altered. You must specify an existing capture process name. Do not specify an owner.
`rule_set_name`	The name of the positive rule set for the capture process. The positive rule set contains the rules that instruct the capture process to capture changes. To change the positive rule set for the capture process, specify an existing rule set in the form `[schema_name.]rule_set_name`. For example, to specify a positive rule set in the `hr` schema named `job_capture_rules`, enter `hr.job_capture_rules`. If the schema is not specified, then the current user is the default. An error is returned if the specified rule set does not exist. You can create a rule set and add rules to it using the `DBMS_STREAMS_ADM` package or the `DBMS_RULE_ADM` package. If you specify `NULL` and the `remove_rule_set` parameter is set to `FALSE`, then the procedure retains any existing positive rule set. If you specify `NULL` and the `remove_rule_set` parameter is set to `TRUE`, then the procedure removes any existing positive rule set. See Also: Oracle Streams Concepts and Administration for more information about the changes that can be captured by a capture process
`remove_rule_set`	If `TRUE`, then the procedure removes the positive rule set for the specified capture process. If you remove a positive rule set for a capture process, and the capture process does not have a negative rule set, then the capture process captures all supported changes to all objects in the database, excluding database objects in the `SYS` and `SYSTEM` schemas. If you remove a positive rule set for a capture process, and the capture process has a negative rule set, then the capture process captures all supported changes that are not discarded by the negative rule set. If `FALSE`, then the procedure retains the positive rule set for the specified capture process. If the `rule_set_name` parameter is non-`NULL`, then this parameter should be set to `FALSE`.
`start_scn`	A valid SCN for the database from which the capture process should start capturing changes. The SCN value be greater than or equal to the first SCN for the capture process. Also, the capture process must be stopped before resetting its start SCN. An error is returned if an invalid SCN is specified or if the capture process is enabled.
`use_database_link`	If `TRUE`, then the capture process at a downstream database uses a database link to the source database for administrative purposes relating to the capture process. If you want a capture process that is not using a database link currently to begin using a database link, then specify `TRUE`. In this case, a database link with the same name as the global name of the source database must exist at the downstream database. If `FALSE`, then either the capture process is running on the source database, or the capture process at a downstream database does not use a database link to the source database. If you want a capture process that is using a database link currently to stop using a database link, then specify `FALSE`. In this case, you must prepare source database objects for instantiation manually when you add or change capture process rules that pertain to these objects. If `NULL`, then the current value of this parameter for the capture process is not changed.
`first_scn`	Specifies the lowest SCN in the redo log from which a capture process can capture changes. If you specify a new first SCN for the capture process, then the specified first SCN must meet the following requirements: It must be greater than the current first SCN for the capture process. It must be less than or equal to the current applied SCN for the capture process. However, this requirement does not apply if the current applied SCN for the capture process is zero. It must be less than or equal to the required checkpoint SCN for the capture process. An error is returned if the specified SCN does not meet the first three requirements. See "Usage Notes" for information about determining an SCN value that meets all of these conditions. When the first SCN is modified, the capture process purges information from its LogMiner data dictionary that is required to restart it at an earlier SCN. See BUILD Procedure for more information about a LogMiner data dictionary. If the specified first SCN is higher than the current start SCN for the capture process, then the start SCN is set automatically to the new value of the first SCN.
`negative_rule_set_name`	The name of the negative rule set for the capture process. The negative rule set contains the rules that instruct the capture process to discard changes. To change the negative rule set for the capture process, specify an existing rule set in the form `[schema_name.]rule_set_name`. For example, to specify a negative rule set in the `hr` schema named `neg_capture_rules`, enter `hr.neg_capture_rules`. If the schema is not specified, then the current user is the default. An error is returned if the specified rule set does not exist. You can create a rule set and add rules to it using the `DBMS_STREAMS_ADM` package or the `DBMS_RULE_ADM` package. If you specify `NULL` and the `remove_negative_rule_set` parameter is set to `FALSE`, then the procedure retains any existing negative rule set. If you specify `NULL` and the `remove_negative_rule_set` parameter is set to `TRUE`, then the procedure removes any existing negative rule set. If you specify both a positive and a negative rule set for a capture process, then the negative rule set is always evaluated first.
`remove_negative_rule_set`	If `TRUE`, then the procedure removes the negative rule set for the specified capture process. If you remove a negative rule set for a capture process, and the capture process does not have a positive rule set, then the capture process captures all supported changes to all objects in the database, excluding database objects in the `SYS` and `SYSTEM` schemas. If you remove a negative rule set for a capture process, and a positive rule set exists for the capture process, then the capture process captures all changes that are not discarded by the positive rule set. If `FALSE`, then the procedure retains the negative rule set for the specified capture process. If the `negative_rule_set_name` parameter is non-`NULL`, then this parameter should be set to `FALSE`.
`capture_user`	The user in whose security domain a capture process captures changes that satisfy its rule sets and runs custom rule-based transformations configured for capture process rules. If `NULL`, then the capture user is not changed. To change the capture user, the user who invokes the `ALTER_CAPTURE` procedure must be granted `DBA` role. Only the `SYS` user can set the `capture_user` to `SYS`. If you change the capture user, then this procedure grants the new capture user enqueue privilege on the queue used by the capture process and configures the user as a secure queue user of the queue. In addition, ensure that the capture user has the following privileges: `EXECUTE` privilege on the rule sets used by the capture process `EXECUTE` privilege on all rule-based transformation functions used in the rule set These privileges can be granted directly to the capture user, or they can be granted through roles. In addition, the capture user must be granted `EXECUTE` privilege on all packages, including Oracle-supplied packages, that are invoked in rule-based transformations run by the capture process. These privileges must be granted directly to the capture user. They cannot be granted through roles. The capture process is stopped and restarted automatically when you change the value of this parameter. Note: If the specified user is dropped using `DROP` `USER...` `CASCADE`, then the `capture_user` setting for the capture process is set to `NULL` automatically. You must specify a capture user before the capture process can run.
`checkpoint_retention_time`	Either the number of days that a capture process should retain checkpoints before purging them automatically, or `DBMS_CAPTURE_ADM.INFINITE` if checkpoints should not be purged automatically. If `NULL`, then the checkpoint retention time is not changed. If a number is specified, then a capture process purges a checkpoint the specified number of days after the checkpoint was taken. Partial days can be specified using decimal values. For example, `.25` specifies 6 hours. When a checkpoint is purged, LogMiner data dictionary information for the archived redo log file that corresponds to the checkpoint is purged, and the `first_scn` of the capture process is reset to the SCN value corresponding to the first change in the next archived redo log file. See Also: Oracle Streams Concepts and Administration for more information about checkpoint retention time

Usage Notes

If you want to alter the first SCN for a capture process, then the value specified must meet the conditions in the description for the first_scn parameter. The following query determines the current first SCN, applied SCN, and required checkpoint SCN for each capture process in a database:

SELECT CAPTURE_NAME, FIRST_SCN, APPLIED_SCN, REQUIRED_CHECKPOINT_SCN
   FROM DBA_CAPTURE;

ALTER_SYNC_CAPTURE Procedure

This procedure alters a synchronous capture.

See Also:

Oracle Streams Concepts and Administration for more information about altering a capture process

Syntax

DBMS_CAPTURE_ADM.ALTER_SYNC_CAPTURE(
   capture_name   IN  VARCHAR2,
   rule_set_name  IN  VARCHAR2  DEFAULT NULL,
   capture_user   IN  VARCHAR2  DEFAULT NULL);

Parameters

Table 30-6 ALTER_SYNC_CAPTURE Procedure Parameters

Parameter Description

Parameter	Description
`capture_name`	The name of the synchronous capture being altered. You must specify an existing synchronous capture name. Do not specify an owner.
`rule_set_name`	The name of the positive rule set for the synchronous capture. The positive rule set contains the rules that instruct the synchronous capture to capture changes. To change the rule set for the synchronous capture, specify an existing rule set in the form `[schema_name.]rule_set_name`. For example, to specify a positive rule set in the `strmadmin` schema named `sync_cap_rules`, enter `strmadmin.sync_cap_rules`. If the schema is not specified, then the current user is the default. An error is returned if the specified rule set does not exist. You should only specify a rule set that was created using the `DBMS_STREAMS_ADM` package. If `NULL`, then the rule set is not changed. See Also: Oracle Streams Concepts and Administration for more information about the changes that can be captured by a synchronous capture
`capture_user`	The user in whose security domain a synchronous capture captures changes that satisfy its rule set and runs custom rule-based transformations configured for synchronous capture rules. If `NULL`, then the capture user is not changed. To change the capture user, the user who invokes the `ALTER_SYNC_CAPTURE` procedure must be granted `DBA` role. Only the `SYS` user can set the `capture_user` to `SYS`. If you change the capture user, then this procedure grants the new capture user enqueue privilege on the queue used by the synchronous capture and configures the user as a secure queue user of the queue. In addition, ensure that capture user has the following privileges: `EXECUTE` privilege on the rule sets used by the synchronous capture `EXECUTE` privilege on all rule-based transformation functions used in the rule set These privileges can be granted directly to the capture user, or they can be granted through roles. In addition, the capture user must be granted `EXECUTE` privilege on all packages, including Oracle-supplied packages, that are invoked in rule-based transformations run by the synchronous capture. These privileges must be granted directly to the capture user. They cannot be granted through roles. Note: If the specified user is dropped using `DROP` `USER...` `CASCADE`, then the `capture_user` setting for the synchronous capture is set to `NULL` automatically. You must specify a capture user before the synchronous capture can capture changes.

capture_name

The name of the synchronous capture being altered. You must specify an existing synchronous capture name. Do not specify an owner.

rule_set_name

The name of the positive rule set for the synchronous capture. The positive rule set contains the rules that instruct the synchronous capture to capture changes.

To change the rule set for the synchronous capture, specify an existing rule set in the form [schema_name.]rule_set_name. For example, to specify a positive rule set in the strmadmin schema named sync_cap_rules, enter strmadmin.sync_cap_rules. If the schema is not specified, then the current user is the default.

An error is returned if the specified rule set does not exist. You should only specify a rule set that was created using the DBMS_STREAMS_ADM package.

If NULL, then the rule set is not changed.

See Also: Oracle Streams Concepts and Administration for more information about the changes that can be captured by a synchronous capture

capture_user

The user in whose security domain a synchronous capture captures changes that satisfy its rule set and runs custom rule-based transformations configured for synchronous capture rules. If NULL, then the capture user is not changed.

To change the capture user, the user who invokes the ALTER_SYNC_CAPTURE procedure must be granted DBA role. Only the SYS user can set the capture_user to SYS.

If you change the capture user, then this procedure grants the new capture user enqueue privilege on the queue used by the synchronous capture and configures the user as a secure queue user of the queue. In addition, ensure that capture user has the following privileges:

EXECUTE privilege on the rule sets used by the synchronous capture
EXECUTE privilege on all rule-based transformation functions used in the rule set

These privileges can be granted directly to the capture user, or they can be granted through roles.

In addition, the capture user must be granted EXECUTE privilege on all packages, including Oracle-supplied packages, that are invoked in rule-based transformations run by the synchronous capture. These privileges must be granted directly to the capture user. They cannot be granted through roles.

Note: If the specified user is dropped using DROP USER... CASCADE, then the capture_user setting for the synchronous capture is set to NULL automatically. You must specify a capture user before the synchronous capture can capture changes.

BUILD Procedure

This procedure extracts the data dictionary of the current database to the redo log and automatically specifies database supplemental logging by running the following SQL statement:

ALTER DATABASE ADD SUPPLEMENTAL LOG DATA;

This procedure is overloaded. One version of this procedure contains the OUT parameter first_scn, and the other does not.

Syntax

DBMS_CAPTURE_ADM.BUILD(
   first_scn  OUT  NUMBER);

DBMS_CAPTURE_ADM.BUILD();

Parameters

Table 30-7 BUILD Procedure Parameter

Parameter	Description
`first_scn`	Contains the lowest SCN value corresponding to the data dictionary extracted to the redo log that can be specified as a first SCN for a capture process

Usage Notes

If there are any in-flight transactions, then this procedure waits until these transactions commit before completing. An in-flight transaction is one that is active during the data dictionary build.

You can run this procedure multiple times at a source database.

If you plan to capture changes originating at a source database with a capture process, then this procedure must be executed at the source database at least once. When the capture process is started, either at a local source database or at a downstream database, the capture process uses the extracted information in the redo log to create a LogMiner data dictionary.

A LogMiner data dictionary is a separate data dictionary used by a capture process to determine the details of a change that it is capturing. The LogMiner data dictionary is necessary because the primary data dictionary of the source database might not be synchronized with the redo data being scanned by a capture process.

After executing this procedure, you can query the FIRST_CHANGE# column of the V$ARCHIVED_LOG dynamic performance view where the DICTIONARY_BEGIN column is YES to determine the lowest SCN value for the database that can be specified as a first SCN for a capture process. The first SCN for a capture process is the lowest SCN in the redo log from which the capture process can capture changes.You can specify the first SCN for a capture process when you run the CREATE_CAPTURE or ALTER_CAPTURE procedure in the DBMS_CAPTURE_ADM package.

CREATE_CAPTURE Procedure

This procedure creates a capture process.

See Also:

Oracle Streams Replication Administrator's Guide for more information about creating a capture process
Chapter 124, "DBMS_RULE_ADM" for more information about rules and rule sets

Syntax

DBMS_CAPTURE_ADM.CREATE_CAPTURE(
   queue_name                 IN  VARCHAR2,
   capture_name               IN  VARCHAR2,
   rule_set_name              IN  VARCHAR2  DEFAULT NULL,
   start_scn                  IN  NUMBER    DEFAULT NULL,
   source_database            IN  VARCHAR2  DEFAULT NULL,
   use_database_link          IN  BOOLEAN   DEFAULT FALSE,
   first_scn                  IN  NUMBER    DEFAULT NULL,
   logfile_assignment         IN  VARCHAR2  DEFAULT 'implicit',
   negative_rule_set_name     IN  VARCHAR2  DEFAULT NULL,
   capture_user               IN  VARCHAR2  DEFAULT NULL,
   checkpoint_retention_time  IN  NUMBER    DEFAULT 60);

Parameters

Table 30-8 CREATE_CAPTURE Procedure Parameters

Parameter	Description
`queue_name`	The name of the queue into which the capture process enqueues changes. You must specify an existing queue in the form `[schema_name.]queue_name`. For example, to specify a queue in the `hr` schema named `streams_queue`, enter `hr.streams_queue`. If the schema is not specified, then the current user is the default. Note: The `queue_name` setting cannot be altered after the capture process is created.
`capture_name`	The name of the capture process being created. A `NULL` specification is not allowed. Do not specify an owner. Note: The `capture_name` setting cannot be altered after the capture process is created.
`rule_set_name`	The name of the positive rule set for the capture process. The positive rule set contains the rules that instruct the capture process to capture changes. If you want to use a positive rule set for the capture process, then you must specify an existing rule set in the form `[schema_name.]rule_set_name`. For example, to specify a positive rule set in the `hr` schema named `job_capture_rules`, enter `hr.job_capture_rules`. If the schema is not specified, then the current user is the default. An error is returned if the specified rule set does not exist. You can create a rule set and add rules to it using the `DBMS_STREAMS_ADM` package or the `DBMS_RULE_ADM` package. If you specify `NULL`, and no negative rule set is specified, then the capture process captures all supported changes to all objects in the database, excluding database objects in the `SYS` and `SYSTEM` schemas. If you specify `NULL`, and a negative rule set exists for the capture process, then the capture process captures all changes that are not discarded by the negative rule set. See Also: Oracle Streams Concepts and Administration for more information about the changes that can be captured by a capture process
`start_scn`	A valid SCN for the database from which the capture process should start capturing changes. An error is returned if an invalid SCN is specified. See Also: "Usage Notes" for more information setting the `start_scn` parameter
`source_database`	The global name of the source database. The source database is where the changes to be captured originated. If you do not include the domain name, then the procedure appends it to the database name automatically. For example, if you specify `DBS1` and the domain is `.EXAMPLE.COM`, then the procedure specifies `DBS1.EXAMPLE.COM` automatically. If `NULL`, or if the specified name is the same as the global name of the current database, then local capture is assumed and only the default values for `use_database_link` and `first_scn` can be specified.
`use_database_link`	If `TRUE`, then the capture process at a downstream database uses a database link to the source database for administrative purposes relating to the capture process. A database link with the same name as the global name of the source database must exist at the downstream database. The capture process uses the database link to prepare database objects for instantiation at the source database and run the `DBMS_CAPTURE_ADM.BUILD` procedure at the source database, if necessary. During the creation of a downstream capture process, if the `first_scn` parameter is set to `NULL`, then the `use_database_link` parameter must be set to `TRUE`. Otherwise, an error is returned. If `FALSE`, then either the capture process is running on the source database, or the capture process at a downstream database does not use a database link to the source database. In this case, you must perform the following administrative tasks manually: Run the `DBMS_CAPTURE_ADM.BUILD` procedure at the source database to extract the data dictionary at the source database to the redo log when a capture process is created. Obtain the first SCN for the downstream capture process if the first SCN is not specified during capture process creation. The first SCN is needed to create and maintain a capture process. Prepare source database objects for instantiation.
`first_scn`	Specifies the lowest SCN in the redo log from which a capture process can capture changes. A non-`NULL` value for this parameter is valid only if the `DBMS_CAPTURE_ADM.BUILD` procedure has been run at least once at the source database. You can query the `FIRST_CHANGE#` column of the `V$ARCHIVED_LOG` dynamic performance view where the `DICTIONARY_BEGIN` column is `YES` to determine whether the `DBMS_CAPTURE_ADM.BUILD` procedure has been run on a source database. Any of the values returned by such a query can be used as a `first_scn` value if the redo log containing that SCN value is still available. See Also: "Usage Notes" for more information setting the `first_scn` parameter
`logfile_assignment`	If `implicit`, the default, then the capture process at a downstream database scans all redo log files added by redo transport services or manually from the source database to the downstream database. If `explicit`, then a redo log file is scanned by a capture process at a downstream database only if the capture process name is specified in the `FOR` `logminer_session_name` clause when the redo log file is added manually to the downstream database. If `explicit`, then redo transport services cannot be used to add redo log files to the capture process being created. If you specify `explicit` for this parameter for a local capture process, then the local capture process cannot use the online redo log to find changes. In this case, the capture process must use the archived redo log. See Also: "Usage Notes" for information about adding redo log files manually
`negative_rule_set_name`	The name of the negative rule set for the capture process. The negative rule set contains the rules that instruct the capture process to discard changes. If you want to use a negative rule set for the capture process, then you must specify an existing rule set in the form `[schema_name.]rule_set_name`. For example, to specify a negative rule set in the `hr` schema named `neg_capture_rules`, enter `hr.neg_capture_rules`. If the schema is not specified, then the current user is the default. If you specify `NULL`, and no positive rule set is specified, then the capture process captures all supported changes to all objects in the database, excluding database objects in the `SYS` and `SYSTEM` schemas. If you specify `NULL`, and a positive rule set exists for the capture process, then the capture process captures all changes that are not discarded by the positive rule set. An error is returned if the specified rule set does not exist. You can create a rule set and add rules to it using the `DBMS_STREAMS_ADM` package or the `DBMS_RULE_ADM` package. If you specify both a positive and a negative rule set for a capture process, then the negative rule set is always evaluated first.
`capture_user`	The user in whose security domain a capture process captures changes that satisfy its rule sets and runs custom rule-based transformations configured for capture process rules. If `NULL`, then the user who runs the `CREATE_CAPTURE` procedure is used. Only a user who is granted `DBA` role can set a capture user. Only the `SYS` user can set the `capture_user` to `SYS`. Note: If the specified user is dropped using `DROP` `USER...` `CASCADE`, then the `capture_user` setting for the capture process is set to `NULL` automatically. You must specify a capture user before the capture process can run. See Also: "Usage Notes" for more information about this parameter.
`checkpoint_retention_time`	Either the number of days that a capture process should retain checkpoints before purging them automatically, or `DBMS_CAPTURE_ADM.INFINITE` if checkpoints should not be purged automatically. If a number is specified, then a capture process purges a checkpoint the specified number of days after the checkpoint was taken. Partial days can be specified using decimal values. For example, `.25` specifies 6 hours. When a checkpoint is purged, LogMiner data dictionary information for the archived redo log file that corresponds to the checkpoint is purged, and the `first_scn` of the capture process is reset to the SCN value corresponding to the first change in the next archived redo log file. See Also: Oracle Streams Concepts and Administration for more information about checkpoint retention time

Usage Notes

Consider the following usage notes when you run this procedure:

DBA Role Required for User Who Invokes the CREATE_CAPTURE Procedure
Capture User Requirements
First SCN and Start SCN Settings
Explicit Log File Assignment

DBA Role Required for User Who Invokes the CREATE_CAPTURE Procedure

The user who invokes this procedure must be granted DBA role.

Capture User Requirements

The capture_user parameter specifies the user who captures changes that satisfy the capture process rule sets. This user must have the necessary privileges to capture changes. This procedure grants the capture user enqueue privilege on the queue used by the capture process and configures the user as a secure queue user of the queue.

In addition, ensure that the capture user has the following privileges:

EXECUTE privilege on the rule sets used by the capture process
EXECUTE privilege on all rule-based transformation functions used in the positive rule set

These privileges can be granted directly to the capture user, or they can be granted through roles.

In addition, the capture user must be granted EXECUTE privilege on all packages, including Oracle-supplied packages, that are invoked in rule-based transformations run by the capture process. These privileges must be granted directly to the capture user. They cannot be granted through roles.

Note:

A capture user does not require privileges on a database object to capture changes to the database object. The capture process can pass these changes to a rule-based transformation function. Therefore, ensure that you consider security implications when you configure a capture process.
Creation of the first capture process in a database might take some time because the data dictionary is duplicated during this creation.

First SCN and Start SCN Settings

When you create a capture process using this procedure, you can specify the first SCN and start SCN for the capture process. A capture process scans the redo data from the first SCN or an existing capture process checkpoint forward, even if the start SCN is higher than the first SCN or the checkpoint SCN. In this case, the capture process does not capture any changes in the redo data before the start SCN. Oracle recommends that, at capture process creation time, the difference between the first SCN and start SCN be as small as possible to keep the amount of redo scanned by the capture process to a minimum.

In some cases, the behavior of the capture process is different depending on the settings of these SCN values and on whether the capture process is local or downstream.

The following table describes capture process behavior for SCN value settings:

first_scn Setting	start_scn Setting	Capture Process Type	Description
Non-`NULL`	`NULL`	Local or Downstream	The new capture process is created at the local database with a new LogMiner session starting from the value specified for the `first_scn` parameter. The start SCN is set to the specified first SCN value automatically, and the new capture process does not capture changes that were made before this SCN. The `BUILD` procedure in the `DBMS_CAPTURE_ADM` package is not run automatically. This procedure must have been run at least once before on the source database, and the specified first SCN must correspond to the SCN value of a previous build that is still available in the redo log. When the new capture process is started for the first time, it creates a new LogMiner data dictionary using the data dictionary information in the redo log. If the `BUILD` procedure has not been run at least once on the source database, then an error is raised when the capture process is started. Capture process behavior is the same for a local capture process and a downstream capture process created with these SCN settings, except that a local capture process is created at the source database and a downstream capture process is created at the downstream database.
Non-`NULL`	Non-`NULL`	Local or Downstream	If the specified value for the `start_scn` parameter is greater than or equal to the specified value for the `first_scn` parameter, then the new capture process is created at the local database with a new LogMiner session starting from the specified first SCN. In this case, the new capture process does not capture changes that were made before the specified start SCN. If the specified value for the `start_scn` parameter is less than the specified value for the `first_scn` parameter, then an error is raised. The `BUILD` procedure in the `DBMS_CAPTURE_ADM` package is not run automatically. This procedure must have been called at least once before on the source database, and the specified `first_scn` must correspond to the SCN value of a previous build that is still available in the redo log. When the new capture process is started for the first time, it creates a new LogMiner data dictionary using the data dictionary information in the redo log. If the `BUILD` procedure has not been run at least once on the source database, then an error is raised. Capture process behavior is the same for a local capture process and a downstream capture process created with these SCN settings, except that a local capture process is created at the source database and a downstream capture process is created at the downstream database.
`NULL`	Non-`NULL`	Local	The new capture process creates a new LogMiner data dictionary if either one of the following conditions is true: There is no existing capture process for the local source database, and the specified value for the `start_scn` parameter is greater than or equal to the current SCN for the database. There are existing capture processes, but none of the capture processes have taken a checkpoint yet, and the specified value for the `start_scn` parameter is greater than or equal to the current SCN for the database. In either of these cases, the `BUILD` procedure in the `DBMS_CAPTURE_ADM` package is run during capture process creation. The new capture process uses the resulting build of the source data dictionary in the redo log to create a LogMiner data dictionary the first time it is started, and the first SCN corresponds to the SCN of the data dictionary build. If there are any in-flight transactions, then the `BUILD` procedure waits until these transactions commit before completing. An in-flight transaction is one that is active during capture process creation or a data dictionary build. However, if there is at least one existing local capture process for the local source database that has taken a checkpoint, then the new capture process shares an existing LogMiner data dictionary with one or more of the existing capture processes. In this case, a capture process with a first SCN that is lower than or equal to the specified start SCN must have been started successfully at least once. Also, if there are any in-flight transactions, then the capture process is created after these transactions commit. If there is no existing capture process for the local source database (or if no existing capture processes have taken a checkpoint yet), and the specified start SCN is less than the current SCN for the database, then an error is raised.
`NULL`	Non-`NULL`	Downstream	When the `CREATE_CAPTURE` procedure creates a downstream capture process, the `use_database_link` parameter must be set to `TRUE` when the `first_scn` parameter is set to `NULL`. Otherwise, an error is raised. The database link is used to obtain the current SCN of the source database. The new capture process creates a new LogMiner data dictionary if either one of the following conditions is true: There is no existing capture process that captures changes to the source database at the downstream database, and the specified value for the `start_scn` parameter is greater than or equal to the current SCN for the source database. There are existing capture processes that capture changes to the source database at the downstream database, but none of the capture processes have taken a checkpoint yet, and the specified value for the `start_scn` parameter is greater than or equal to the current SCN for the source database. In either of these cases, the `BUILD` procedure in the `DBMS_CAPTURE_ADM` package is run during capture process creation. The first time you start the new capture process, it uses the resulting build of the source data dictionary in the redo log files copied to the downstream database to create a LogMiner data dictionary. Here, the first SCN for the new capture process corresponds to the SCN of the data dictionary build. If there are any in-flight transactions, then the `BUILD` procedure waits until these transactions commit before completing. However, if at least one existing capture process has taken a checkpoint and captures changes to the source database at the downstream database, then the new capture process shares an existing LogMiner data dictionary with one or more of these existing capture processes. In this case, one of these existing capture processes with a first SCN that is lower than or equal to the specified start SCN must have been started successfully at least once. Also, if there are any in-flight transactions, then the capture process is created after these transactions commit. If there is no existing capture process that captures changes to the source database at the downstream database (or no existing capture process has taken a checkpoint), and the specified `start_scn` parameter value is less than the current SCN for the source database, then an error is raised.
`NULL`	`NULL`	Local or Downstream	The behavior is the same as setting the `first_scn` parameter to `NULL` and setting the `start_scn` parameter to the current SCN of the source database.

Note:

When you create a capture process using the DBMS_STREAMS_ADM package, both the first SCN and the start SCN are set to NULL during capture process creation.

See Also:

BUILD Procedure for more information about the BUILD procedure and the LogMiner data dictionary

Explicit Log File Assignment

If you specify explicit for the logfile_assignment parameter, then you add a redo log file manually to a downstream database using the following statement:

ALTER DATABASE REGISTER LOGICAL LOGFILE 
   file_name FOR capture_process;

Here, file_name is the name of the redo log file being added and capture_process is the name of the capture process that will use the redo log file at the downstream database. The capture_process is equivalent to the logminer_session_name and must be specified. The redo log file must be present at the site running the downstream database. You must transfer this file manually to the site running the downstream database using the DBMS_FILE_TRANSFER package, FTP, or some other transfer method.

See Also:

Oracle Database SQL Language Reference for more information about the ALTER DATABASE statement and Oracle Data Guard Concepts and Administration for more information registering redo log files

CREATE_SYNC_CAPTURE Procedure

This procedure creates a synchronous capture.

See Also:

Oracle Streams Replication Administrator's Guide for more information about creating a synchronous capture

Syntax

DBMS_CAPTURE_ADM.CREATE_SYNC_CAPTURE(
   queue_name     IN  VARCHAR2,
   capture_name   IN  VARCHAR2,
   rule_set_name  IN  VARCHAR2,
   capture_user   IN  VARCHAR2  DEFAULT NUL);

Parameters

Table 30-9 CREATE_SYNC_CAPTURE Procedure Parameters

Parameter	Description
`queue_name`	The name of the queue into which the synchronous capture enqueues changes. You must specify an existing queue in the form `[schema_name.]queue_name`. For example, to specify a queue in the `strmadmin` schema named `streams_queue`, enter `strmadmin.streams_queue`. If the schema is not specified, then the current user is the default. Note: The `queue_name` setting cannot be altered after the synchronous capture is created.
`capture_name`	The name of the synchronous capture being created. A `NULL` specification is not allowed. Do not specify an owner. Note: The `capture_name` setting cannot be altered after the synchronous capture is created.
`rule_set_name`	The name of the positive rule set for the synchronous capture. The positive rule set contains the rules that instruct the synchronous capture to capture changes. Specify an existing rule set in the form `[schema_name.]rule_set_name`. For example, to specify a positive rule set in the `strmadmin` schema named `sync_cap_rules`, enter `strmadmin.sync_cap_rules`. If the schema is not specified, then the current user is the default. An error is returned if the specified rule set does not exist. You should only specify a rule set that was created using the `DBMS_STREAMS_ADM` package. If `NULL`, then an error is returned. Note: Synchronous capture rules must be added to the synchronous capture rule set using the `ADD_TABLE_RULES` or `ADD_SUBSET_RULES` procedure in the `DBMS_STREAMS_ADM` package. A synchronous capture ignores rules added to the rule set with other procedures. See Also: Oracle Streams Concepts and Administration for more information about the changes that can be captured by a synchronous capture
`capture_user`	The user in whose security domain the synchronous capture captures changes that satisfy its rule set and runs custom rule-based transformations configured for synchronous capture rules. If `NULL`, then the user who runs the `CREATE_SYNC_CAPTURE` procedure is used. Only a user who is granted `DBA` role can set a capture user. Only the `SYS` user can set the `capture_user` to `SYS`. Note: If the specified user is dropped using `DROP` `USER...` `CASCADE`, then the `capture_user` setting for the synchronous capture is set to `NULL` automatically. You must specify a capture user before the synchronous capture can capture changes. See Also: "Usage Notes" for more information about this parameter.

Usage Notes

When the CREATE_SYNC_CAPTURE procedure creates a synchronous capture, the procedure must obtain an exclusive lock on each table for which it will capture changes. The rules in the specified rule set for the synchronous capture determine these tables. If there are outstanding transactions on a table for which the synchronous capture will capture changes, then the procedure waits until it can obtain a lock.

The capture_user parameter specifies the user who captures changes that satisfy the synchronous capture rule set. This user must have the necessary privileges to capture changes.

In addition, ensure that the capture user has the following privileges:

ENQUEUE privilege on the queue specified in the queue_name parameter
EXECUTE privilege on the rule set used by the synchronous capture
EXECUTE privilege on all rule-based transformation functions used in the rule set

These privileges can be granted directly to the capture user, or they can be granted through roles.

Note:

A capture user does not require privileges on a database object to capture changes to the database object. The synchronous capture can pass these changes to a rule-based transformation function. Therefore, ensure that you consider security implications when you configure a synchronous capture.

DROP_CAPTURE Procedure

This procedure drops a capture process.

Note:

A capture process must be stopped before it can be dropped.

See Also:

"STOP_CAPTURE Procedure"

Syntax

DBMS_CAPTURE_ADM.DROP_CAPTURE(
   capture_name           IN  VARCHAR2,
   drop_unused_rule_sets  IN  BOOLEAN  DEFAULT FALSE);

Parameters

Table 30-10 DROP_CAPTURE Procedure Parameters

Parameter Description

Parameter	Description
`capture_name`	The name of the capture process being dropped. Specify an existing capture process name. Do not specify an owner.
`drop_unused_rule_sets`	If `TRUE`, then the procedure drops any rule sets, positive and negative, used by the specified capture process if these rule sets are not used by any other Oracle Streams client. Oracle Streams clients include capture processes, propagations, apply processes, and messaging clients. If this procedure drops a rule set, then this procedure also drops any rules in the rule set that are not in another rule set. If `FALSE`, then the procedure does not drop the rule sets used by the specified capture process, and the rule sets retain their rules.

capture_name

The name of the capture process being dropped. Specify an existing capture process name. Do not specify an owner.

drop_unused_rule_sets

If TRUE, then the procedure drops any rule sets, positive and negative, used by the specified capture process if these rule sets are not used by any other Oracle Streams client. Oracle Streams clients include capture processes, propagations, apply processes, and messaging clients. If this procedure drops a rule set, then this procedure also drops any rules in the rule set that are not in another rule set.

If FALSE, then the procedure does not drop the rule sets used by the specified capture process, and the rule sets retain their rules.

Usage Notes

When you use this procedure to drop a capture process, rules-related information for the capture process created by the DBMS_STREAMS_ADM package is removed from the data dictionary views for Oracle Streams rules. Information about such a rule is removed even if the rule is not in either rule set for the capture process.

The following are the data dictionary views for Oracle Streams rules:

ALL_STREAMS_GLOBAL_RULES
DBA_STREAMS_GLOBAL_RULES
ALL_STREAMS_MESSAGE_RULES
DBA_STREAMS_MESSAGE_RULES
ALL_STREAMS_SCHEMA_RULES
DBA_STREAMS_SCHEMA_RULES
ALL_STREAMS_TABLE_RULES
DBA_STREAMS_TABLE_RULES
ALL_STREAMS_RULES
DBA_STREAMS_RULES

See Also:

Oracle Streams Concepts and Administration for more information about Oracle Streams data dictionary views

INCLUDE_EXTRA_ATTRIBUTE Procedure

This procedure includes or excludes an extra attribute in logical change records (LCRs) captured by the specified capture process or synchronous capture.

Syntax

DBMS_CAPTURE_ADM.INCLUDE_EXTRA_ATTRIBUTE(
   capture_name    IN  VARCHAR2,
   attribute_name  IN  VARCHAR2,
   include         IN  BOOLEAN   DEFAULT TRUE);

Parameters

Table 30-11 INCLUDE_EXTRA_ATTRIBUTE Procedure Parameters

Parameter Description

Parameter	Description
`capture_name`	The name of the capture process or synchronous capture. Specify an existing capture process name or synchronous capture name. Do not specify an owner.
`attribute_name`	The name of the attribute to be included in or excluded from LCRs captured by the capture process or synchronous capture. The following names are valid settings: `row_id` The rowid of the row changed in a row LCR. This attribute is not included in DDL LCRs, or in row LCRs for index-organized tables. The type is `VARCHAR2`. `serial#` The serial number of the session that performed the change captured in the LCR. The type is `NUMBER`. `session#` The identifier of the session that performed the change captured in the LCR. The type is `NUMBER`. `thread#` The thread number of the instance in which the change captured in the LCR was performed. Typically, the thread number is relevant only in an Oracle Real Application Clusters (Oracle RAC) environment. The type is `NUMBER`. `tx_name` The name of the transaction that includes the LCR. The type is `VARCHAR2`. `username` The name of the user who performed the change captured in the LCR. The type is `VARCHAR2`.
`include`	If `TRUE`, then the specified attribute is included in LCRs captured by the capture process or synchronous capture. If `FALSE`, then the specified attribute is excluded from LCRs captured by the capture process or synchronous capture.

capture_name

The name of the capture process or synchronous capture. Specify an existing capture process name or synchronous capture name. Do not specify an owner.

attribute_name

The name of the attribute to be included in or excluded from LCRs captured by the capture process or synchronous capture. The following names are valid settings:

row_id

The rowid of the row changed in a row LCR. This attribute is not included in DDL LCRs, or in row LCRs for index-organized tables. The type is VARCHAR2.
serial#

The serial number of the session that performed the change captured in the LCR. The type is NUMBER.
session#

The identifier of the session that performed the change captured in the LCR. The type is NUMBER.
thread#

The thread number of the instance in which the change captured in the LCR was performed. Typically, the thread number is relevant only in an Oracle Real Application Clusters (Oracle RAC) environment. The type is NUMBER.
tx_name

The name of the transaction that includes the LCR. The type is VARCHAR2.
username

The name of the user who performed the change captured in the LCR. The type is VARCHAR2.

include

If TRUE, then the specified attribute is included in LCRs captured by the capture process or synchronous capture.

If FALSE, then the specified attribute is excluded from LCRs captured by the capture process or synchronous capture.

Usage Notes

Some information is not captured by a capture process or synchronous capture unless you use this procedure to specify that the information should be captured. If you want to exclude an extra attribute that is being captured by a capture process or synchronous capture, then specify the attribute and specify FALSE for the include parameter.

PREPARE_GLOBAL_INSTANTIATION Procedure

This procedure performs the synchronization necessary for instantiating all the tables in the database at another database and can enable supplemental logging for key columns or all columns in these tables. This procedure should be used to prepare the tables in the database for instantiation when a capture process will be used to capture changes to the tables in the database.

This procedure records the lowest SCN of each object in the database for instantiation. SCNs subsequent to the lowest SCN for an object can be used for instantiating the object. Running this procedure prepares all current and future objects in the database for instantiation.

Syntax

DBMS_CAPTURE_ADM.PREPARE_GLOBAL_INSTANTIATION
   supplemental_logging  IN  VARCHAR2  DEFAULT 'keys');

Parameter

Table 30-12 PREPARE_GLOBAL_INSTANTIATION Procedure Parameter

Parameter Description

Parameter	Description
`supplemental_logging`	Either `none`, `keys`, or `all`. If `none` is specified, then this procedure does not enable supplemental logging for any columns in the tables in the database. This procedure does not remove existing supplemental logging specifications for these tables. If `keys` is specified, then this procedure enables supplemental logging for primary key, unique key, bitmap index, and foreign key columns in the tables in the database and for any table added to the database in the future. Primary key columns are logged unconditionally. Unique key, bitmap index, and foreign key columns are logged conditionally. Specifying `keys` does not enable supplemental logging of bitmap join index columns. If `all` is specified, then this procedure enables supplemental logging for all columns in the tables in the database and for any table added to the database in the future. The columns are logged unconditionally. Supplemental logging is not enabled for columns of the following types: LOB, `LONG`, `LONG` `RAW`, user-defined types, and Oracle-supplied types.

supplemental_logging

Either none, keys, or all.

If none is specified, then this procedure does not enable supplemental logging for any columns in the tables in the database. This procedure does not remove existing supplemental logging specifications for these tables.

If keys is specified, then this procedure enables supplemental logging for primary key, unique key, bitmap index, and foreign key columns in the tables in the database and for any table added to the database in the future. Primary key columns are logged unconditionally. Unique key, bitmap index, and foreign key columns are logged conditionally. Specifying keys does not enable supplemental logging of bitmap join index columns.

If all is specified, then this procedure enables supplemental logging for all columns in the tables in the database and for any table added to the database in the future. The columns are logged unconditionally. Supplemental logging is not enabled for columns of the following types: LOB, LONG, LONG RAW, user-defined types, and Oracle-supplied types.

Usage Notes

Run this procedure at the source database.

If you use a capture process to capture all of the changes to a database, then use this procedure to prepare the tables in the database for instantiation after the capture process has been configured.

PREPARE_SCHEMA_INSTANTIATION Procedure

This procedure performs the synchronization necessary for instantiating all tables in the schema at another database and can enable supplemental logging for key columns or all columns in these tables. This procedure should be used to prepare the tables in the schema for instantiation when a capture process will be used to capture changes to the tables in the schema.

This procedure records the lowest SCN of each object in the schema for instantiation. SCNs subsequent to the lowest SCN for an object can be used for instantiating the object. Running this procedure prepares all current and future objects in the schema for instantiation.

Syntax

DBMS_CAPTURE_ADM.PREPARE_SCHEMA_INSTANTIATION(
   schema_name           IN  VARCHAR2,
   supplemental_logging  IN  VARCHAR2  DEFAULT 'keys');

Parameters

Table 30-13 PREPARE_SCHEMA_INSTANTIATION Procedure Parameters

Parameter Description

Parameter	Description
`schema_name`	The name of the schema. For example, `hr`.
`supplemental_logging`	Either `none`, `keys`, or `all`. If `none` is specified, then this procedure does not enable supplemental logging for any columns in the tables in the schema. This procedure does not remove existing supplemental logging specifications for these tables. If `keys` is specified, then this procedure enables supplemental logging for primary key, unique key, bitmap index, and foreign key columns in the tables in the schema and for any table added to this schema in the future. Primary key columns are logged unconditionally. Unique key, bitmap index, and foreign key columns are logged conditionally. Specifying `keys` does not enable supplemental logging of bitmap join index columns. If `all` is specified, then this procedure enables supplemental logging for all columns in the tables in the schema and for any table added to this schema in the future. The columns are logged unconditionally. Supplemental logging is not enabled for columns of the following types: LOB, `LONG`, `LONG` `RAW`, user-defined types, and Oracle-supplied types.

schema_name

The name of the schema. For example, hr.

supplemental_logging

Either none, keys, or all.

If none is specified, then this procedure does not enable supplemental logging for any columns in the tables in the schema. This procedure does not remove existing supplemental logging specifications for these tables.

If keys is specified, then this procedure enables supplemental logging for primary key, unique key, bitmap index, and foreign key columns in the tables in the schema and for any table added to this schema in the future. Primary key columns are logged unconditionally. Unique key, bitmap index, and foreign key columns are logged conditionally. Specifying keys does not enable supplemental logging of bitmap join index columns.

If all is specified, then this procedure enables supplemental logging for all columns in the tables in the schema and for any table added to this schema in the future. The columns are logged unconditionally. Supplemental logging is not enabled for columns of the following types: LOB, LONG, LONG RAW, user-defined types, and Oracle-supplied types.

Usage Notes

Run this procedure at the source database. If you use a capture process to capture all of the changes to a schema, then use this procedure to prepare the tables in the schema for instantiation after the capture process has been configured.

PREPARE_SYNC_INSTANTIATION Function

This function performs the synchronization necessary for instantiating one or more tables at another database. This function returns the prepare system change number (SCN) for the table or tables being prepared for instantiation.

This function should be used to prepare one or more tables for instantiation when a synchronous capture will be used to capture changes to the tables.

This function records the lowest SCN of each table for instantiation (prepare SCN). SCNs subsequent to the lowest SCN for an object can be used for instantiating the object.

This function is overloaded. The table_names parameter is VARCHAR2 data type in one version and DBMS_UTILITY.UNCL_ARRAY data type in the other version.

See Also:

Oracle Streams Replication Administrator's Guide for more information about instantiation

Syntax

DBMS_CAPTURE_ADM.PREPARE_SYNC_INSTANTIATION(
   table_names IN VARCHAR2)
RETURN NUMBER;

DBMS_CAPTURE_ADM.PREPARE_SYNC_INSTANTIATION(
   table_names IN DBMS_UTILITY.UNCL_ARRAY)
RETURN NUMBER;

Parameters

Table 30-14 PREPARE_SYNC_INSTANTIATION Function Parameter

Parameter Description

Parameter	Description
`table_names`	When the `table_names` parameter is `VARCHAR2` data type, a comma-delimited list of the tables to prepare for instantiation. There must be no spaces between entries. When the `table_names` parameter is `DBMS_UTILITY.UNCL_ARRAY` data type, specify a PL/SQL index-by table of this type that contains the names of the tables to prepare for instantiation. The first table name should be at position 1, the second at position 2, and so on. The table does not need to be `NULL` terminated. In either version of the function, specify the name of each table in the form `[schema_name.]table_name`. For example, `hr.employees`. If the schema is not specified, then the current user is the default.

table_names

When the table_names parameter is VARCHAR2 data type, a comma-delimited list of the tables to prepare for instantiation. There must be no spaces between entries.

When the table_names parameter is DBMS_UTILITY.UNCL_ARRAY data type, specify a PL/SQL index-by table of this type that contains the names of the tables to prepare for instantiation. The first table name should be at position 1, the second at position 2, and so on. The table does not need to be NULL terminated.

In either version of the function, specify the name of each table in the form [schema_name.]table_name. For example, hr.employees. If the schema is not specified, then the current user is the default.

PREPARE_TABLE_INSTANTIATION Procedure

This procedure performs the synchronization necessary for instantiating the table at another database and can enable supplemental logging for key columns or all columns in the table. This procedure should be used to prepare the table for instantiation when a capture process will be used to capture changes to the table.

This procedure records the lowest SCN of the table for instantiation. SCNs subsequent to the lowest SCN for an object can be used for instantiating the object.

Syntax

DBMS_CAPTURE_ADM.PREPARE_TABLE_INSTANTIATION(
   table_name            IN  VARCHAR2,
   supplemental_logging  IN  VARCHAR2  DEFAULT 'keys');

Parameters

Table 30-15 PREPARE_TABLE_INSTANTIATION Procedure Parameters

Parameter Description

Parameter	Description
`table_name`	The name of the table specified as `[schema_name.]object_name`. For example, `hr.employees`. If the schema is not specified, then the current user is the default.
`supplemental_logging`	Either `none`, `keys`, or `all`. If `none` is specified, then this procedure does not enable supplemental logging for any columns in the table. This procedure does not remove existing supplemental logging specifications for the table. If `keys` is specified, then this procedure enables supplemental logging for primary key, unique key, bitmap index, and foreign key columns in the table. The procedure places the key columns for the table in three separate log groups: the primary key columns in an unconditional log group, the unique key columns and bitmap index columns in a conditional log group, and the foreign key columns in a conditional log group. Specifying `keys` does not enable supplemental logging of bitmap join index columns. If `all` is specified, then this procedure enables supplemental logging for all columns in the table. The procedure places all of the columns for the table in an unconditional log group. Supplemental logging is not enabled for columns of the following types: LOB, `LONG`, `LONG` `RAW`, user-defined types, and Oracle-supplied types.

table_name

The name of the table specified as [schema_name.]object_name. For example, hr.employees. If the schema is not specified, then the current user is the default.

supplemental_logging

Either none, keys, or all.

If none is specified, then this procedure does not enable supplemental logging for any columns in the table. This procedure does not remove existing supplemental logging specifications for the table.

If keys is specified, then this procedure enables supplemental logging for primary key, unique key, bitmap index, and foreign key columns in the table. The procedure places the key columns for the table in three separate log groups: the primary key columns in an unconditional log group, the unique key columns and bitmap index columns in a conditional log group, and the foreign key columns in a conditional log group. Specifying keys does not enable supplemental logging of bitmap join index columns.

If all is specified, then this procedure enables supplemental logging for all columns in the table. The procedure places all of the columns for the table in an unconditional log group. Supplemental logging is not enabled for columns of the following types: LOB, LONG, LONG RAW, user-defined types, and Oracle-supplied types.

Usage Notes

Run this procedure at the source database. If you use a capture process to capture all of the changes to a table, then use this procedure to prepare the table for instantiation after the capture process has been configured.

SET_PARAMETER Procedure

This procedure sets a capture process parameter to the specified value.

Syntax

DBMS_CAPTURE_ADM.SET_PARAMETER(
   capture_name  IN  VARCHAR2,
   parameter     IN  VARCHAR2,
   value         IN  VARCHAR2  DEFAULT NULL);

Parameters

Table 30-16 SET_PARAMETER Procedure Parameters

Parameter Description

Parameter	Description
`capture_name`	The name of the capture process. Do not specify an owner.
`parameter`	The name of the parameter you are setting. See "Capture Process Parameters" for a list of these parameters.
`value`	The value to which the parameter is set. If `NULL`, then the parameter is set to its default value.

capture_name

The name of the capture process. Do not specify an owner.

parameter

The name of the parameter you are setting. See "Capture Process Parameters" for a list of these parameters.

value

The value to which the parameter is set.

If NULL, then the parameter is set to its default value.

Usage Notes

When you alter a parameter value, a short amount of time might pass before the new value for the parameter takes effect.

Capture Process Parameters

The following table lists the parameters for the capture process.

Table 30-17 Capture Process Parameters

Parameter Name	Possible Values	Default	Description
`disable_on_limit`	`Y` or `N`	`N`	If `Y`, then the capture process is disabled because it reached a value specified by the `time_limit` parameter or `message_limit` parameter. If `N`, then the capture process is restarted immediately after stopping because it reached a limit. When a capture process is restarted, it starts to capture changes at the point where it last stopped. A restarted capture process gets a new session identifier, and the processes associated with the capture process also get new session identifiers. However, the capture process number (`CPnn`) remains the same.
`downstream_real_time_mine`	`Y` or `N`	`Y` for local capture processes `N` for downstream capture processes	If `Y`, then the capture process is a real-time downstream capture process. After setting this parameter to `y`, switch the redo log file at the source database using the SQL statement `ALTER` `SYSTEM` `ARCHIVE` `LOG` `CURRENT` to begin real-time downstream capture. If this parameter is set to `Y`, then redo data from the source database must be sent to the standby redo log at the downstream database. See Oracle Streams Replication Administrator's Guide for information about creating a real-time downstream capture process. If `N`, then the capture process is an archived-log downstream capture process. This parameter is ignored for local capture processes.
`maximum_scn`	A valid SCN or `INFINITE`	`INFINITE`	The capture process is disabled before capturing a change record with an SCN greater than or equal to the value specified. If `INFINITE`, then the capture process runs regardless of the SCN value.
`merge_threshold`	A negative integer, `0`, a positive integer, or `INFINITE`	`60`	The amount of time, in seconds, between the message creation time of the original capture process and the message creation time of the cloned capture process. Specifically, if the difference, in seconds, between the `CAPTURE_MESSAGE_CREATE_TIME` of the cloned capture process and the original capture process is less than or equal to the value specified for this parameter, then automatic merge begins by running the `MERGE_STREAMS` procedure. If the difference is greater than the value specified by this parameter, then automatic merge does not begin, and the value is recorded in the `LAG` column of the `DBA_STREAMS_SPLIT_MERGE` view. The `CAPTURE_MESSAGE_CREATE_TIME` is recorded in the `V$STREAMS_CAPTURE` view. This parameter is relevant only when changes captured by the capture process are applied by two or more apply processes and the `split_threshold` parameter is set to a value other than `INFINITE`. If a negative value is specified, then automatic merge is disabled. If `0` (zero) is specified, then there must be no lag between the original capture process and the cloned capture process to begin the merge. If `INFINITE` is specified, then automatic merging starts immediately. See Also: Oracle Streams Replication Administrator's Guide
`message_limit`	A positive integer or `INFINITE`	`INFINITE`	The capture process stops after capturing the specified number of messages. If `INFINITE`, then the capture process continues to run regardless of the number of messages captured.
`message_tracking_frequency`	`0` or a positive integer	`2000000`	The frequency at which messages captured by the capture process are tracked automatically. For example, if this parameter is set to the default value of `2000000`, then every two-millionth message is tracked automatically. The tracking label used for automatic message tracking is `capture_process_name:AUTOTRACK`, where `capture_process_name` is the name of the capture process. Only the first 20 bytes of the capture process name are used; the rest is truncated if it exceeds 20 bytes. If `0` (zero), then no messages are tracked automatically. See Oracle Streams Replication Administrator's Guide for more information about message tracking.
`parallelism`	A positive integer	`1`	The number of preparer servers that can concurrently mine the redo log for the capture process. A capture process consists of one reader server, one or more preparer servers, and one builder server. The preparer servers concurrently format changes found in the redo log into logical change records (LCRs). Each reader server, preparer server, and builder server is a process, and the number of preparer servers equals the number specified for the `parallelism` capture process parameter. So, if `parallelism` is set to 5, then a capture process uses a total of seven processes: one reader server, five preparer servers, and one builder server. Setting the `parallelism` parameter to a number higher than the number of available parallel execution servers might disable the capture process. Ensure that the `PROCESSES` initialization parameter is set appropriately when you set the `parallelism` capture process parameter. Note: When you change the value of this parameter, the capture process is stopped and restarted automatically. See Also: Oracle Streams Concepts and Administration for more information about capture process components
`skip_autofiltered_table_ddl`	`Y` or `N`	`Y`	If `Y`, then the capture process does not capture data definition language (DDL) changes to tables that are automatically filtered by the capture process. If `N`, then the capture process can capture DDL changes to tables that are automatically filtered by the capture process if the DDL changes satisfy the capture process rule sets. The `AUTO_FILTERED` column in the `DBA_STREAMS_UNSUPPORTED` data dictionary view shows which tables are automatically filtered by capture processes.
`split_threshold`	`0`, a positive integer, or `INFINITE`	`1800`	The amount of time, in seconds, that a stream is broken before the stream is automatically split from other streams that flow from the capture process. When a stream is split, the capture process, queue, and propagation are cloned. In this case, a stream is a flow of logical change records (LCRs) that flows from a capture process to an apply. A stream is broken when LCRs captured by the capture process cannot reach the apply process. For example, a stream is broken when the relevant propagation or apply process is disabled. This parameter is relevant only when changes captured by the capture process are applied by two or more apply processes. If `0` (zero), then automatic splitting starts immediately. If `INFINITE`, then automatic splitting is disabled. The stream is not split regardless of the amount of time that it is broken. This parameters is designed to be used with the `merge_threshold` parameter. You can monitor an automatic split and merge operation by querying the `DBA_STREAMS_SPLIT_MERGE` view. See Also: Oracle Streams Replication Administrator's Guide
`startup_seconds`	`0`, a positive integer, or `INFINITE`	`0`	The maximum number of seconds to wait for another instantiation of the same capture process to finish. If the other instantiation of the same capture process does not finish within this time, then the capture process does not start. This parameter is useful only if you are starting the capture process manually. If `INFINITE`, then the capture process does not start until another instantiation of the same capture process finishes.
`time_limit`	A positive integer or `INFINITE`	`INFINITE`	The capture process stops as soon as possible after the specified number of seconds since it started. If `INFINITE`, then the capture process continues to run until it is stopped explicitly.
`trace_level`	`0` or a positive integer	`0`	Set this parameter only under the guidance of Oracle Support Services.
`write_alert_log`	`Y` or `N`	`Y`	If `Y`, then the capture process writes a message to the alert log on exit. If `N`, then the capture process does not write a message to the alert log on exit. The message specifies the reason the capture process stopped.

Note:

For all parameters that are interpreted as positive integers, the maximum possible value is 4,294,967,295. Where applicable, specify INFINITE for larger values.
For parameters that require an SCN setting, any valid SCN value can be specified.

START_CAPTURE Procedure

This procedure starts the capture process, which mines redo logs and enqueues the mined redo information into the associated queue.

The start status is persistently recorded. Hence, if the status is ENABLED, then the capture process is started upon database instance startup.

The capture process is a background Oracle process and is prefixed by c.

The enqueue and dequeue state of DBMS_AQADM.START_QUEUE and DBMS_AQADM.STOP_QUEUE have no effect on the start status of a capture process.

See Also:

Chapter 141, "DBMS_STREAMS_ADM"

Syntax

DBMS_CAPTURE_ADM.START_CAPTURE(
   capture_name  IN  VARCHAR2);

Parameters

Table 30-18 START_CAPTURE Procedure Parameter

Parameter Description

Parameter	Description
`capture_name`	The name of the capture process. Do not specify an owner. The capture process uses LogMiner to capture changes in the redo information. A `NULL` setting is not allowed.

capture_name

The name of the capture process. Do not specify an owner.

The capture process uses LogMiner to capture changes in the redo information. A NULL setting is not allowed.

Usage Notes

The capture process status is persistently recorded. Hence, if the status is ENABLED, then the capture process is started upon database instance startup. A capture process (cnnn) is an Oracle background process.

STOP_CAPTURE Procedure

This procedure stops the capture process from mining redo logs.

The stop status is persistently recorded. Hence, if the status is DISABLED, then the capture process is not started upon database instance startup.

The enqueue and dequeue state of DBMS_AQADM.START_QUEUE and DBMS_AQADM.STOP_QUEUE have no effect on the stop status of a capture process.

Syntax

DBMS_CAPTURE_ADM.STOP_CAPTURE(
   capture_name  IN  VARCHAR2,
   force         IN  BOOLEAN  DEFAULT FALSE);

Parameters

Table 30-19 STOP_CAPTURE Procedure Parameters

Parameter Description

Parameter	Description
`capture_name`	The name of the capture process. A `NULL` setting is not allowed. Do not specify an owner.
`force`	If `TRUE`, then the procedure stops the capture process as soon as possible. If the capture process cannot stop normally, then it aborts. If `FALSE`, then the procedure stops the capture process as soon as possible. If the capture process cannot stop normally, then an ORA-26672 error is returned, and the capture process might continue to run.

capture_name

The name of the capture process. A NULL setting is not allowed. Do not specify an owner.

force

If TRUE, then the procedure stops the capture process as soon as possible. If the capture process cannot stop normally, then it aborts.

If FALSE, then the procedure stops the capture process as soon as possible. If the capture process cannot stop normally, then an ORA-26672 error is returned, and the capture process might continue to run.

Usage Notes

The capture process status is persistently recorded. Hence, if the status is DISABLED or ABORTED, then the capture process is not started upon database instance startup. A capture process (cnnn) is an Oracle background process.