Oracle DBMS_XSTREAM_GG_ADM
Version 20c

General Information
Library Note Morgan's Library Page Header
Which has the higher priority in your organization: Deploying a new database or securing the ones you already have? Looking for a website, and resources, dedicated solely to securing Oracle databases? Check out DBSecWorx.
Purpose This package, for GoldenGate Integrated Capture and Replicat has the operational code not found within the GoldenGate executables.

Note: This page has been posted prior to the GA release of 20c. It will be completed once we have access to the release version.
AUTHID CURRENT_USER
Dependencies
ANYDATA DBMS_STANDARD DBMS_STREAMS_RPC
DBMS_APPLY_ADM DBMS_STREAMS_ADM DBMS_UTILITY
DBMS_APPLY_ADM_INTERNAL DBMS_STREAMS_ADM_IVK DBMS_XSTREAM_ADM
DBMS_CAPTURE_ADM DBMS_STREAMS_ADM_UTL DBMS_XSTREAM_ADM_INTERNAL
DBMS_CAPTURE_ADM_INTERNAL DBMS_STREAMS_ADM_UTL_INVOK DBMS_XSTREAM_ADM_UTL
DBMS_CAPTURE_ADM_IVK DBMS_STREAMS_DECL DBMS_XSTREAM_GG_INTERNAL
DBMS_LOGREP_UTIL DBMS_STREAMS_LCR_INT DBMS_XSTREAM_UTL_IVK
Documented No
Exceptions
Error Code Reason
ORA-26701 Streams process <string> does not exist
First Available 12.1
Security Model Owned by SYS with EXECUTE granted to the EXECUTE_CATALOG_ROLE role
Source {ORACLE_HOME}/rdbms/admin/prvthxstr.plb
Subprograms
ADD_COLUMN DELETE_REPLICATION_EVENTS REMOVE_QUEUE
ADD_CONTAINER_RULE DROP_INBOUND REMOVE_RULE
ADD_GLOBAL_PROPAGATION_RULES DROP_OUTBOUND REMOVE_SUBSET_OUTBOUND_RULES
ADD_GLOBAL_RULES GET_LCR_CONTENT REMOVE_XSTREAM_CONFIGURATION
ADD_OUTBOUND GET_MDH_FOR_PDBNAME_SCN RENAME_COLUMN
ADD_PROCEDURE_RULE GET_MESSAGE_TRACKING RENAME_SCHEMA
ADD_SCHEMA_PROPAGATION_RULES GET_PDBNAME_FOR_MDH RENAME_TABLE
ADD_SCHEMA_RULES GET_PDB_INFO RESET_CONFIGURATION
ADD_SUBSET_OUTBOUND_RULES GET_TAG SET_CHECKPOINT_SCNS
ADD_SUBSET_PROPAGATION_RULES HANDLE_COLLISIONS SET_DML_CONFLICT_HANDLER
ADD_SUBSET_RULES KEEP_COLUMNS SET_MESSAGE_TRACKING
ADD_TABLE_PROPAGATION_RULES MERGE_STREAMS SET_PARAMETER
ADD_TABLE_RULES MERGE_STREAMS_JOB SET_REPERROR_HANDLER
ALTER_INBOUND POPULATE_APPLY_PROGRESS SET_TAG
ALTER_OUTBOUND PURGE_CDR_INFO SET_UP_QUEUE
BUILD_PDBSET_DICTIONARY PURGE_SOURCE_CATALOG SPLIT_STREAMS
CREATE_CAPTURE RECOVER_OPERATION START_OUTBOUND
CREATE_INBOUND REMOVE_CONTAINER_RULE STOP_OUTBOUND
CREATE_OUTBOUND REMOVE_CONTAINER_RULE_BY_ID UPDATE_ERROR_TXN
DELETE_COLUMN REMOVE_DBNAME_MAPPING  
 
ADD_COLUMN
Either adds or removes a declarative rule-based transformation which adds a column to a row logical change record (row LCR) that satisfies the specified rule.

Overload 1
dbms_xstream_gg_adm.add_column(
rule_name    IN VARCHAR2,
table_name   IN VARCHAR2,
column_name  IN VARCHAR2,
column_value IN ANYDATA,
value_type   IN VARCHAR2 DEFAULT 'NEW',
step_number  IN NUMBER   DEFAULT 0,
operation    IN VARCHAR2 DEFAULT 'ADD');
TBD
Overload 2 dbms_xstream_gg_adm.add_column(
rule_name       IN VARCHAR2,
table_name      IN VARCHAR2,
column_name     IN VARCHAR2,
column_function IN VARCHAR2,
value_type      IN VARCHAR2 DEFAULT 'NEW',
step_number     IN NUMBER   DEFAULT 0,
operation       IN VARCHAR2 DEFAULT 'ADD');
TBD
 
ADD_CONTAINER_RULE
Either adds a container rule to the positive rule set for propagation, or adds to the negtive rule set for a propagation, and creates the specified propagation if it does not exist dbms_xstream_gg_adm.add_container_rule(
capture_name      IN VARCHAR2,
canon_filter_rule IN VARCHAR2,
inclusion_rule    IN BOOLEAN,
escape_char       IN CHAR,
wildcard_flag     IN BOOLEAN);
TBD
 
ADD_GLOBAL_PROPAGATION_RULES
either adds global rules to the positive rule set for a propagation, or adds global rules to the negative rule set for a propagation, and creates the specified propagation if it does not exist

Overload 1
dbms_xstream_gg_adm.add_global_propagation_rules(
streams_name           IN VARCHAR2 DEFAULT NULL,
source_queue_name      IN VARCHAR2,
destination_queue_name IN VARCHAR2,
include_dml            IN BOOLEAN  DEFAULT TRUE,
include_ddl            IN BOOLEAN  DEFAULT FALSE,
include_tagged_lcr     IN BOOLEAN  DEFAULT FALSE,
source_database        IN VARCHAR2 DEFAULT NULL,
inclusion_rule         IN BOOLEAN  DEFAULT TRUE,
and_condition          IN VARCHAR2 DEFAULT NULL,
queue_to_queue         IN BOOLEAN  DEFAULT NULL);
TBD
Overload 2 dbms_xstream_gg_adm.add_global_propagation_rules(
streams_name           IN  VARCHAR2 DEFAULT NULL,
source_queue_name      IN  VARCHAR2,
destination_queue_name IN  VARCHAR2,
include_dml            IN  BOOLEAN  DEFAULT TRUE,
include_ddl            IN  BOOLEAN  DEFAULT FALSE,
include_tagged_lcr     IN  BOOLEAN  DEFAULT FALSE,
source_database        IN  VARCHAR2 DEFAULT NULL,
dml_rule_name          OUT VARCHAR2,
ddl_rule_name          OUT VARCHAR2,
inclusion_rule         IN  BOOLEAN  DEFAULT TRUE,
and_condition          IN  VARCHAR2 DEFAULT NULL,
queue_to_queue         IN  BOOLEAN  DEFAULT NULL);
TBD
 
ADD_GLOBAL_RULES
Adds rules to an OGG XStream clients rule set

Overload 1
dbms_xstream_gg_adm.add_global_rules(
streams_type          IN  VARCHAR2,
streams_name          IN  VARCHAR2 DEFAULT NULL,
queue_name            IN  VARCHAR2 DEFAULT 'streams_queue',
include_dml           IN  BOOLEAN  DEFAULT TRUE,
include_ddl           IN  BOOLEAN  DEFAULT FALSE,
include_procedure     IN  BOOLEAN  DEFAULT FALSE,
include_tagged_lcr    IN  BOOLEAN  DEFAULT FALSE,
source_database       IN  VARCHAR2 DEFAULT NULL,
dml_rule_name         OUT VARCHAR2,
ddl_rule_name         OUT VARCHAR2,
inclusion_rule        IN  BOOLEAN  DEFAULT TRUE,
and_condition         IN  VARCHAR2 DEFAULT NULL,
source_root_name      IN  VARCHAR2 DEFAULT NULL,
source_container_name IN  VARCHAR2 DEFAULT NULL);
TBD
Overload 2 dbms_xstream_gg_adm.add_global_rules(
streams_type          IN VARCHAR2,
streams_name          IN VARCHAR2 DEFAULT NULL,
queue_name            IN VARCHAR2 DEFAULT 'streams_queue',
include_dml           IN BOOLEAN  DEFAULT TRUE,
include_ddl           IN BOOLEAN  DEFAULT FALSE,
include_tagged_lcr    IN BOOLEAN  DEFAULT FALSE,
source_database       IN VARCHAR2 DEFAULT NULL,
inclusion_rule        IN BOOLEAN  DEFAULT TRUE,
and_condition         IN VARCHAR2 DEFAULT NULL,
source_root_name      IN VARCHAR2 DEFAULT NULL,
source_container_name IN VARCHAR2 DEFAULT NULL);
TBD
 
ADD_OUTBOUND
Creates an OGG XStream outbound server that dequeues logical change records (LCRs) from the specified queue

Overload 1
dbms_xstream_gg_adm.add_outbound(
server_name           IN VARCHAR2,
queue_name            IN VARCHAR2  DEFAULT NULL,
source_database       IN VARCHAR2  DEFAULT NULL,
table_names           IN dbms_utility.uncl_array,
schema_names          IN dbms_utility.uncl_array,
connect_user          IN VARCHAR2  DEFAULT NULL,
comment               IN VARCHAR2  DEFAULT NULL,
capture_name          IN VARCHAR2  DEFAULT NULL,
start_scn             IN NUMBER    DEFAULT NULL,
start_time            IN TIMESTAMP DEFAULT NULL,
include_dml           IN BOOLEAN   DEFAULT TRUE,
include_ddl           IN BOOLEAN   DEFAULT FALSE,
source_root_name      IN VARCHAR2  DEFAULT NULL,
source_container_name IN VARCHAR2  DEFAULT NULL,
lcrid_version         IN NUMBER    DEFAULT NULL);
TBD
Overload 2 dbms_xstream_gg_adm.add_outbound(
server_name           IN VARCHAR2,
queue_name            IN VARCHAR2  DEFAULT NULL,
source_database       IN VARCHAR2  DEFAULT NULL,
table_names           IN VARCHAR2  DEFAULT NULL,
schema_names          IN VARCHAR2  DEFAULT NULL,
connect_user          IN VARCHAR2  DEFAULT NULL,
comment               IN VARCHAR2  DEFAULT NULL,
capture_name          IN VARCHAR2  DEFAULT NULL,
start_scn             IN NUMBER    DEFAULT NULL,
start_time            IN TIMESTAMP DEFAULT NULL,
include_dml           IN BOOLEAN   DEFAULT TRUE,
include_ddl           IN BOOLEAN   DEFAULT FALSE,
source_root_name      IN VARCHAR2  DEFAULT NULL,
source_container_name IN VARCHAR2  DEFAULT NULL,
lcrid_version         IN NUMBER    DEFAULT NULL);
TBD
 
ADD_PROCEDURE_RULE
Undocumented

Overload 1
dbms_xstream_gg_adm.add_procedure_rule(
streams_type          IN  VARCHAR2,
streams_name          IN  VARCHAR2,
owner                 IN  VARCHAR2,
package_name          IN  VARCHAR2,
procedure_name        IN  VARCHAR2,
null_package_name     IN  BOOLEAN,
queue_name            IN  VARCHAR2,
include_tagged_lcr    IN  BOOLEAN,
source_database       IN  VARCHAR2,
procedure_rule_name   OUT VARCHAR2,
inclusion_rule        IN  BOOLEAN,
and_condition         IN  VARCHAR2,
source_root_name      IN  VARCHAR2,
source_container_name IN  VARCHAR2);
TBD
Overload 2 dbms_xstream_gg_adm.add_procedure_rule(
streams_type          IN VARCHAR2,
streams_name          IN VARCHAR2,
owner                 IN VARCHAR2,
package_name          IN VARCHAR2,
procedure_name        IN VARCHAR2,
null_package_name     IN BOOLEAN,
queue_name            IN VARCHAR2,
include_tagged_lcr    IN BOOLEAN,
source_database       IN VARCHAR2,
inclusion_rule        IN BOOLEAN,
and_condition         IN VARCHAR2,
source_root_name      IN VARCHAR2,
source_container_name IN VARCHAR2);
TBD
 
ADD_SCHEMA_PROPAGATION_RULES
Either adds schema rules to the positive rule set for a propagation, or adds schema rules to the negative rule set for a propagation, and creates the specified propagation if it does not exist

Overload 1
dbms_xstream_gg_adm.add_schema_propagation_rules(
schema_name            IN VARCHAR2,
streams_name           IN VARCHAR2  DEFAULT NULL,
source_queue_name      IN VARCHAR2,
destination_queue_name IN VARCHAR2,
include_dml            IN BOOLEAN  DEFAULT TRUE,
include_ddl            IN BOOLEAN  DEFAULT FALSE,
include_tagged_lcr     IN BOOLEAN  DEFAULT FALSE,
source_database        IN VARCHAR2 DEFAULT NULL,
inclusion_rule         IN BOOLEAN  DEFAULT TRUE,
and_condition          IN VARCHAR2 DEFAULT NULL,
queue_to_queue         IN BOOLEAN  DEFAULT NULL);
TBD
Overload 2 dbms_xstream_gg_adm.add_schema_propagation_rules(
schema_name            IN  VARCHAR2,
streams_name           IN  VARCHAR2 DEFAULT NULL,
source_queue_name      IN  VARCHAR2,
destination_queue_name IN  VARCHAR2,
include_dml            IN  BOOLEAN  DEFAULT TRUE,
include_ddl            IN  BOOLEAN  DEFAULT FALSE,
include_tagged_lcr     IN  BOOLEAN  DEFAULT FALSE,
dml_rule_name          OUT VARCHAR2,
ddl_rule_name          OUT VARCHAR2,
source_database        IN  VARCHAR2 DEFAULT NULL,
inclusion_rule         IN  BOOLEAN  DEFAULT TRUE,
and_condition          IN  VARCHAR2 DEFAULT NULL,
queue_to_queue         IN  BOOLEAN  DEFAULT NULL);
TBD
 
ADD_SCHEMA_RULES
Adds schema rules to a rule set

Overload 1
dbms_xstream_gg_adm.add_schema_rules(
schema_name           IN VARCHAR2,
streams_type          IN VARCHAR2,
streams_name          IN VARCHAR2 DEFAULT NULL,
queue_name            IN VARCHAR2 DEFAULT 'streams_queue',
include_dml           IN BOOLEAN  DEFAULT TRUE,
include_ddl           IN BOOLEAN  DEFAULT FALSE,
include_tagged_lcr    IN BOOLEAN  DEFAULT FALSE,
source_database       IN VARCHAR2 DEFAULT NULL,
inclusion_rule        IN BOOLEAN  DEFAULT TRUE,
and_condition         IN VARCHAR2 DEFAULT NULL,
source_root_name      IN VARCHAR2 DEFAULT NULL,
source_container_name IN VARCHAR2 DEFAULT NULL);
TBD
Overload 2 dbms_xstream_gg_adm.add_schema_rules(
schema_name           IN  VARCHAR2,
streams_type          IN  VARCHAR2,
streams_name          IN  VARCHAR2 DEFAULT NULL,
queue_name            IN  VARCHAR2 DEFAULT 'streams_queue',
include_dml           IN  BOOLEAN  DEFAULT TRUE,
include_ddl           IN  BOOLEAN  DEFAULT FALSE,
include_tagged_lcr    IN  BOOLEAN  DEFAULT FALSE,
source_database       IN  VARCHAR2 DEFAULT NULL,
inclusion_rule        IN  BOOLEAN  DEFAULT TRUE,
dml_rule_name         OUT VARCHAR2,
ddl_rule_name         OUT VARCHAR2,
and_condition         IN  VARCHAR2 DEFAULT NULL,
source_root_name      IN  VARCHAR2 DEFAULT NULL,
source_container_name IN  VARCHAR2 DEFAULT NULL);
TBD
 
ADD_SUBSET_OUTBOUND_RULES
Adds OGG subset rules to an outbound server configuration

Overload 1
dbms_xstream_gg_adm.add_subset_outbound_rules(
server_name     IN VARCHAR2,
table_name      IN VARCHAR2,
condition       IN VARCHAR2 DEFAULT NULL,
column_list     IN dbms_utility.lname_array,
keep            IN BOOLEAN  DEFAULT TRUE,
source_database IN VARCHAR2 DEFAULT NULL);
TBD
Overload 2 dbms_xstream_gg_adm.add_subset_outbound_rules(
server_name     IN VARCHAR2,
table_name      IN VARCHAR2,
condition       IN VARCHAR2 DEFAULT NULL,
column_list     IN VARCHAR2 DEFAULT NULL,
keep            IN BOOLEAN  DEFAULT TRUE,
source_database IN VARCHAR2 DEFAULT NULL);
TBD
 
ADD_SUBSET_PROPAGATION_RULES
Adds propagation rules that propagate the logical change records (LCRs) related to a subset of the rows in the specified table in a source queue to a destination queue, and creates the specified propagation if it does not exist

Overload 1
dbms_xstream_gg_adm.add_subset_propagation_rules(
table_name             IN VARCHAR2,
dml_condition          IN VARCHAR2,
streams_name           IN VARCHAR2 DEFAULT NULL,
source_queue_name      IN VARCHAR2,
destination_queue_name IN VARCHAR2,
include_tagged_lcr     IN BOOLEAN  DEFAULT FALSE,
source_database        IN VARCHAR2 DEFAULT NULL,
queue_to_queue         IN BOOLEAN  DEFAULT NULL);
TBD
Overload 2 dbms_xstream_gg_adm.add_subset_propagation_rules(
table_name             IN  VARCHAR2,
dml_condition          IN  VARCHAR2,
streams_name           IN  VARCHAR2 DEFAULT NULL,
source_queue_name      IN  VARCHAR2,
destination_queue_name IN  VARCHAR2,
include_tagged_lcr     IN  BOOLEAN  DEFAULT FALSE,
source_database        IN  VARCHAR2 DEFAULT NULL,
insert_rule_name       OUT VARCHAR2,
update_rule_name       OUT VARCHAR2,
delete_rule_name       OUT VARCHAR2,

queue_to_queue         IN  BOOLEAN  DEFAULT NULL);
TBD
 
ADD_SUBSET_RULES
This procedure adds rules to an OGG XStream client

Overoad 1
dbms_xstream_gg_adm.add_subset_rules(
table_name IN VARCHAR2,
dml_condition IN VARCHAR2,
streams_type          IN  VARCHAR2 DEFAULT 'apply',
streams_name          IN  VARCHAR2 DEFAULT NULL,
queue_name            IN  VARCHAR2 DEFAULT 'streams_queue',
include_tagged_lcr    IN  BOOLEAN  DEFAULT FALSE,
source_database       IN  VARCHAR2 DEFAULT NULL,
insert_rule_name      OUT VARCHAR2,
update_rule_name      OUT VARCHAR2,
delete_rule_name      OUT VARCHAR2,

source_root_name      IN  VARCHAR2 DEFAULT NULL,
source_container_name IN  VARCHAR2 DEFAULT NULL);
TBD
Overoad 2 dbms_xstream_gg_adm.add_subset_rules(
table_name            IN VARCHAR2,
dml_condition         IN VARCHAR2,
streams_type          IN VARCHAR2 DEFAULT 'apply',
streams_name          IN VARCHAR2 DEFAULT NULL,
queue_name            IN VARCHAR2 DEFAULT 'streams_queue',
include_tagged_lcr    IN BOOLEAN DEFAULT FALSE,
source_database       IN VARCHAR2 DEFAULT NULL,
source_root_name      IN VARCHAR2 DEFAULT NULL,
source_container_name IN VARCHAR2 DEFAULT NULL);
TBD
 
ADD_TABLE_PROPAGATION_RULES
Undocumented

Overload 1
dbms_xstream_gg_adm.add_table_propagation_rules(
table_name             IN VARCHAR2,
streams_name           IN VARCHAR2,
source_queue_name      IN VARCHAR2,
destination_queue_name IN VARCHAR2,
include_dml            IN BOOLEAN,
include_ddl            IN BOOLEAN,
include_tagged_lcr     IN BOOLEAN,
source_database        IN VARCHAR2,
inclusion_rule         IN BOOLEAN,
AND_condition          IN VARCHAR2,
queue_TO_queue         IN BOOLEAN);
TBD
Overload 2 dbms_xstream_gg_adm.add_table_propagation_rules(
table_name             IN  VARCHAR2,
streams_name           IN  VARCHAR2,
source_queue_name      IN  VARCHAR2,
destination_queue_name IN  VARCHAR2,
include_dml            IN  BOOLEAN,
include_ddl            IN  BOOLEAN,
include_tagged_lcr     IN  BOOLEAN,
source_database        IN  VARCHAR2,
dml_rule_name          OUT VARCHAR2,
ddl_rule_name          OUT VARCHAR2,

inclusion_rule         IN  BOOLEAN,
and_condition          IN  VARCHAR2,
queue_TO_queue         IN  BOOLEAN);
TBD
 
ADD_TABLE_RULES
Add table rules to rule set

Overload 1
dbms_xstream_gg_adm.add_table_rules(
table_name            IN VARCHAR2,
streams_type          IN VARCHAR2,
streams_name          IN VARCHAR2,
queue_name            IN VARCHAR2,
include_dml           IN BOOLEAN,
include_ddl           IN BOOLEAN,
include_tagged_lcr    IN BOOLEAN,
source_database       IN VARCHAR2,
inclusion_rule        IN BOOLEAN,
and_condition         IN VARCHAR2,
source_root_name      IN VARCHAR2,
source_container_name IN VARCHAR2);
TBD
Overload 2 dbms_xstream_gg_adm.add_table_rules(
table_name            IN  VARCHAR2,
streams_type          IN  VARCHAR2,
streams_name          IN  VARCHAR2,
queue_name            IN  VARCHAR2,
include_dml           IN  BOOLEAN,
include_ddl           IN  BOOLEAN,
include_tagged_lcr    IN  BOOLEAN,
source_database       IN  VARCHAR2,
dml_rule_name         OUT VARCHAR2,
ddl_rule_name         OUT VARCHAR2,
inclusion_rule        IN  BOOLEAN,
and_condition         IN  VARCHAR2,
source_root_name      IN  VARCHAR2,
source_container_name IN  VARCHAR2);
TBD
 
ALTER_INBOUND
Modifies an OGG XStream inbound server dbms_xstream_gg_adm.alter_inbound(
server_name IN VARCHAR2,
apply_user  IN VARCHAR2 DEFAULT NULL,
comment     IN VARCHAR2 DEFAULT NULL);
TBD
 
ALTER_OUTBOUND
Modifies an OGG XStream outbound server

Overload 1
dbms_xstream_gg_adm.alter_outbound(
server_name           IN VARCHAR2,
table_names           IN dbms_utility.uncl_array,
schema_names          IN dbms_utility.uncl_array,
add                   IN BOOLEAN   DEFAULT TRUE,
capture_user          IN VARCHAR2  DEFAULT NULL,
connect_user          IN VARCHAR2  DEFAULT NULL,
comment               IN VARCHAR2  DEFAULT NULL,
inclusion_rule        IN BOOLEAN   DEFAULT TRUE,
start_scn             IN NUMBER    DEFAULT NULL,
start_time            IN TIMESTAMP DEFAULT NULL,
include_dml           IN BOOLEAN   DEFAULT TRUE,
include_ddl           IN BOOLEAN   DEFAULT TRUE,
source_database       IN VARCHAR2  DEFAULT NULL,
source_container_name IN VARCHAR2  DEFAULT NULL);
TBD
Overload 2 dbms_xstream_gg_adm.alter_outbound(
server_name           IN VARCHAR2,
table_names           IN VARCHAR2  DEFAULT NULL,
schema_names          IN VARCHAR2  DEFAULT NULL,
add                   IN BOOLEAN   DEFAULT TRUE,
capture_user          IN VARCHAR2  DEFAULT NULL,
connect_user          IN VARCHAR2  DEFAULT NULL,
comment               IN VARCHAR2  DEFAULT NULL,
inclusion_rule        IN BOOLEAN   DEFAULT TRUE,
start_scn             IN NUMBER    DEFAULT NULL,
start_time            IN TIMESTAMP DEFAULT NULL,
include_dml           IN BOOLEAN   DEFAULT TRUE,
include_ddl           IN BOOLEAN   DEFAULT TRUE,
source_database       IN VARCHAR2  DEFAULT NULL,
source_container_name IN VARCHAR2  DEFAULT NULL);
TBD
Overload 3 dbms_xstream_gg_adm.alter_outbound(
server_name           IN VARCHAR2,
table_nameS           IN VARCHAR2,
schema_nameS          IN VARCHAR2,
add                   IN BOOLEAN,
capture_user          IN VARCHAR2,
connect_user          IN VARCHAR2,
comment               IN VARCHAR2,
inclusion_rule        IN BOOLEAN,
start_scn             IN NUMBER,
start_time            IN TIMESTAMP,
include_dml           IN BOOLEAN,
include_ddl           IN BOOLEAN,
source_database       IN VARCHAR2,
source_container_name IN VARCHAR2);
TBD
 
BUILD_PDBSET_DICTIONARY
Undocumented dbms_xstream_gg_adm.build_pdbset_dictionary(
pdb_names          IN  sys.dbms_utility.uncl_array,
first_lockdown_scn OUT NUMBER,
last_lockdown_scn  OUT NUMBER,
FLAGS              IN  NUMBER);
TBD
 
CREATE_CAPTURE
Create a primary extract process dbms_xstream_gg_adm.create_capture(
queue_name                IN VARCHAR2,
capture_name              IN VARCHAR2,
rule_set_name             IN VARCHAR2,
start_scn                 IN NUMBER,
source_database           IN VARCHAR2,
use_database_link         IN BOOLEAN,
first_scn                 IN NUMBER,
logfile_assignment        IN VARCHAR2,
negative_rule_set_name    IN VARCHAR2,
capture_user              IN VARCHAR2,
checkpoint_retention_time IN NUMBER,
start_time                IN TIMESTAMP,
source_root_name          IN VARCHAR2,
source_container_name     IN VARCHAR2,
capture_class             IN VARCHAR2,
clone_capture_name        IN VARCHAR2);
TBD
 
CREATE_INBOUND
Creates an OGG XStream inbound server and its queue dbms_xstream_gg_adm.create_inbound(
server_name         IN VARCHAR2,
queue_name          IN VARCHAR2,
apply_user          IN VARCHAR2 DEFAULT NULL,
comment             IN VARCHAR2 DEFAULT NULL,
committed_data_only IN BOOLEAN,
scn_based_position  IN BOOLEAN);
TBD
 
CREATE_OUTBOUND
Creates an OGG XStream outbound server, queue, and capture process to enable client applications to stream out Oracle database changes encapsulated in logical change records (LCRs)

Overload 1
dbms_xstream_gg_adm.create_outbound(
server_name            IN VARCHAR2,
source_database        IN VARCHAR2 DEFAULT NULL,
table_names            IN VARCHAR2 DEFAULT NULL,
schema_names           IN VARCHAR2 DEFAULT NULL,
capture_user           IN VARCHAR2 DEFAULT NULL,
connect_user           IN VARCHAR2 DEFAULT NULL,
comment                IN VARCHAR2 DEFAULT NULL,
committed_data_only    IN BOOLEAN  DEFAULT TRUE,
capture_name           IN VARCHAR2 DEFAULT NULL,
wait_for_inflight_txns IN VARCHAR2,
synchronization        IN VARCHAR2,
include_dml            IN BOOLEAN  DEFAULT TRUE,
include_ddl            IN BOOLEAN  DEFAULT TRUE,
enable_procedure       IN BOOLEAN  DEFAULT TRUE,
source_root_name       IN VARCHAR2 DEFAULT NULL,
source_container_name  IN VARCHAR2 DEFAULT NULL,
lcrid_version          IN NUMBER   DEFAULT NULL);
TBD
Overload 2 dbms_xstream_gg_adm.create_outbound(
server_name            IN VARCHAR2,
source_database        IN VARCHAR2 DEFAULT NULL,
table_names            IN dbms_utility.uncl_array,
schema_names           IN dbms_utility.uncl_array,
capture_user           IN VARCHAR2 DEFAULT NULL,
connect_user           IN VARCHAR2 DEFAULT NULL,
comment                IN VARCHAR2 DEFAULT NULL,
committed_data_only    IN BOOLEAN  DEFAULT TRUE,
capture_name           IN VARCHAR2 DEFAULT NULL,
wait_for_inflight_txns IN VARCHAR2,
synchronization        IN VARCHAR2,
include_dml            IN BOOLEAN  DEFAULT TRUE,
include_ddl            IN BOOLEAN  DEFAULT TRUE,
enable_procedure       IN BOOLEAN  DEFAULT TRUE,
source_root_name       IN VARCHAR2 DEFAULT NULL,
source_contaimer_name  IN VARCHAR2 DEFAULT NULL,
lcrid_version          IN NUMBER   DEFAULT NULL);
TBD
 
DELETE_COLUMN
Undocumented dbms_xstream_gg_adm.delete_column(
rule_name   IN VARCHAR2,
table_name  IN VARCHAR2,
column_name IN VARCHAR2,
value_type  IN VARCHAR2,
step_number IN NUMBER,
operation   IN VARCHAR2);
TBD
 
DELETE_REPLICATION_EVENTS
Undocumented dbms_xstream_gg_adm.delete_replication_event(
streams_name  IN VARCHAR2  DEFAULT NULL,
streams_type  IN VARCHAR2  DEFAULT NULL,
process_type  IN VARCHAR2  DEFAULT NULL,
event_name    IN VARCHAR2  DEFAULT NULL,
include_error IN BOOLEAN   DEFAULT TRUE,
event_time    IN TIMESTAMP DEFAULT NULL);
TBD
 
DROP_INBOUND
Removes an inbound server configuration dbms_xstream_gg_adm.drop_inbound(server_name IN VARCHAR2);
TBD
 
DROP_OUTBOUND
Removes an outbound server configuration dbms_xstream_gg_adm.drop_outbound(server_name IN VARCHAR2);
TBD
 
GET_LCR_CONTENT
Undocumented dbms_xstream_gg_adm.get_lcr_content(
lcr      IN sys.anydata,
row_type IN VARCHAR2)
RETURN CLOB;
TBD
 
GET_MDH_FOR_PDBNSMR_SCN
Undocumented dbms_xstream_gg_adm.get_mdh_for_pdbname_scn(
logmnr_session_num IN NUMBER,
pdbname            IN VARCHAR2,
asofscn            IN NUMBER)
RETURN NUMBER;
TBD
 
GET_MESSAGE_TRACKING
Undocumented dbms_xstream_gg_adm.get_message_tracking RETURN VARCHAR2;
SELECT dbms_xstream_gg_adm.get_message_tracking
FROM dual;
 
GET_PDBNAME_FOR_MDH
Undocumented dbms_xstream_gg_adm.get_pdbname_for_mdh(
logmnr_session_num IN NUMBER,
mdh                IN NUMBER)
RETURN VARCHAR2;
TBD
 
GET_PDB_INFO
Returns Pluggable Database information

Overload 1
dbms_xstream_gg_adm.get_pdb_info(
pdb_name        IN  VARCHAR2,
pdb_exists      OUT BOOLEAN,
pdb_open        OUT BOOLEAN,
pdb_global_name OUT VARCHAR2);
DECLARE
 pdb1  BOOLEAN;
 pdb2  BOOLEAN;
 pdbgn VARCHAR2(30);
BEGIN
  dbms_xstream_gg_adm.get_pdb_info('PDBDEV', pdb1, pdb2, pdbgn);
  IF pdb1 THEN
    dbms_output.put_line('PDB Exist');
  ELSE
    dbms_output.put_line('PDB Does Not Exist');
  END IF;
  IF pdb1 THEN
    dbms_output.put_line('PDB Open');
  ELSE
    dbms_output.put_line('PDB Closed');
  END IF;
  dbms_output.put_line('PDB Global NameG: ' || pdbgn);
END;
/
PDB Exist
PDB Open
PDB Global NameG: PDBDEV

PL/SQL procedure successfully completed.
Overload 2 dbms_xstream_gg_adm.get_pdb_info(
pdb_name        IN  VARCHAR2,
pdb_exists      OUT BOOLEAN,
pdb_open        OUT BOOLEAN,
pdb_global_name OUT VARCHAR2,
flags           OUT BINARY_INTEGER,
spare1          OUT NUMBER,
spare2          OUT VARCHAR2);
DECLARE
 pdb1 BOOLEAN;
 pdb2 BOOLEAN;
 pdb3 VARCHAR2(30);
 flag BINARY_INTEGER;
 sp1  NUMBER;
 sp2  VARCHAR2(30);
BEGIN
  dbms_xstream_gg_adm.get_pdb_info('PDBDEV', pdb1, pdb2, pdb3, flag, sp1, sp2);
  IF pdb1 THEN
    dbms_output.put_line('PDB Exist');
  ELSE
    dbms_output.put_line('PDB Does Not Exist');
  END IF;
  IF pdb1 THEN
    dbms_output.put_line('PDB Open');
  ELSE
    dbms_output.put_line('PDB Closed');
  END IF;
  dbms_output.put_line('FLAG: ' || flag);
  dbms_output.put_line('SPARE1: ' || sp1);
  dbms_output.put_line('SPARE2: ' || sp2);
END;
/
PDB Exist
PDB Open
FLAG: 0
SPARE1: 0
SPARE2:

PL/SQL procedure successfully completed.
 
GET_TAG
Gets the binary tag for all redo entries generated by the current session dbms_xstream_gg_adm.get_tag RETURN RAW;
See SET_TAG Demo Below
 
HANDLE_COLLISIONS
Undocumented dbms_xstream_gg_adm.handle_collisions(
apply_name    IN VARCHAR2,
ENABLE        IN BOOLEAN,
object        IN VARCHAR2,
source_object IN VARCHAR2);
TBD
 
KEEP_COLUMNS
Undocumented

Overload 1
dbms_xstream_gg_adm.keep_columns(
rule_name    IN VARCHAR2,
table_name   IN VARCHAR2,
column_table IN sys.dbms_utility.lname_array,
value_type   IN VARCHAR2
step_number  IN NUMBER
operation    IN VARCHAR2
TBD
Overload 2 dbms_xstream_gg_adm.keep_columns(
rule_name   IN VARCHAR2,
table_name  IN VARCHAR2,
column_LIST IN VARCHAR2,
value_type  IN VARCHAR2,
step_number IN NUMBER,
operation   IN VARCHAR2);
TBD
 
MERGE_STREAMS
Undocumented dbms_xstream_gg_adm.merge_streams(
cloned_propagation_name IN VARCHAR2,
propagation_name        IN VARCHAR2,
queue_name              IN VARCHAR2,
perform_actions         IN BOOLEAN,
script_name             IN VARCHAR2,
script_directory_object IN VARCHAR2);
TBD
 
MERGE_STREAMS_JOB
Undocumented dbms_xstream_gg_adm.merge_streams_job(
cloned_propagation_name IN VARCHAR2,
propagation_name        IN VARCHAR2,
queue_name              IN VARCHAR2,
merge_threshold         IN NUMBER,
schedule_name           IN VARCHAR2,
merge_job_name          IN VARCHAR2);
TBD
 
POPULATE_APPLY_PROGRESS
Undocumented dbms_xstream_gg_adm.populate_apply_progress(apply_num IN NUMBER);
exec dbms_xstream_gg_adm.populate_apply_progress(42);
 
PURGE_CDR_INFO
Undocumented dbms_xstream_gg_adm.purge_cdr_info(
local_transaction_id IN VARCHAR2,
seqno                IN NUMBER,
rba                  IN NUMBER,
index_num            IN NUMBER);
TBD
 
PURGE_SOURCE_CATALOG
Undocumented dbms_xstream_gg_adm.purge_source_catalog(
source_database    IN VARCHAR2,
source_object_name IN VARCHAR2,
source_object_type IN VARCHAR2,
source_root_name   IN VARCHAR2);
TBD
 
RECOVER_OPERATION
Undocumented dbms_xstream_gg_adm.recover_operation(
script_id      IN RAW,
operation_mode IN VARCHAR2);
TBD
 
REMOVE_CONTAINER_RULE
Undocumented dbms_xstream_gg_adm.remove_container_rule(
capture_name      IN VARCHAR2,
canon_filter_rule IN VARCHAR2,
inclusion_rule    IN BOOLEAN);
TBD
 
REMOVE_CONTAINER_RULE_BY_ID
Undocumented dbms_xstream_gg_adm.remove_container_rule_by_id(
capture_name IN VARCHAR2,
rule_id      IN NUMBER);
TBD
 
REMOVE_DBNAME_MAPPING
Undocumented dbms_xstream_gg_adm.remove_dbname_mapping(
source_database_name  IN VARCHAR2,
source_container_name IN VARCHAR2,
source_root_name      IN VARCHAR2);
TBD
 
REMOVE_QUEUE
Undocumented dbms_xstream_gg_adm.remove_queue(
queue_name              IN VARCHAR2,
cascade                 IN BOOLEAN,
drop_unused_queue_table IN BOOLEAN);
TBD
 
REMOVE_RULE
Undocumented dbms_xstream_gg_adm.remove_rule(
SERVER_name      IN VARCHAR2,
insert_rule_name IN VARCHAR2,
update_rule_name IN VARCHAR2,
delete_rule_name IN VARCHAR2);
TBD
 
REMOVE_SUBSET_OUTBOUND_RULES
Removes subset rules from an outbound server configuration dbms_xstream_gg_adm.remove_subset_outbound_rules(
dbms_xstream_adm.remove_subset_outbound_rules(
server_name      IN VARCHAR2,
insert_rule_name IN VARCHAR2,
update_rule_name IN VARCHAR2,
delete_rule_name IN VARCHAR2);
TBD
 
REMOVE_XSTREAM_CONFIGURATION
Undocumented dbms_xstream_gg_adm.remove_xstream_configuration(
container       IN VARCHAR2,
goldengate_only IN BOOLEAN);
exec dbms_xstream_gg_adm.remove_xstream_configuration('PDBTEST', TRUE);

PL/SQL procedure successfully completed.
 
RENAME_COLUMN
Remap column names between Extract to Replicat dbms_xstream_gg_adm.rename_column
rule_name        IN VARCHAR2,
table_name       IN VARCHAR2,
FROM_column_name IN VARCHAR2,
TO_column_name   IN VARCHAR2,
value_type       IN VARCHAR2,
step_number      IN NUMBER,
operation        IN VARCHAR2);
TBD
 
RENAME_SCHEMA
Remap schemas between Extract and Replicat dbms_xstream_gg_adm.rename_schema(
rule_name        IN VARCHAR2,
FROM_schema_name IN VARCHAR2,
TO_schema_name   IN VARCHAR2,
step_number      IN NUMBER,
operation        IN VARCHAR2);
TBD
 
RENAME_TABLE
Remap table names between Extract and Replicat dbms_xstream_gg_adm.rename_table(
rule_name       IN VARCHAR2,
FROM_table_name IN VARCHAR2,
TO_table_name   IN VARCHAR2,
step_number     IN NUMBER,
operation       IN VARCHAR2);
TBD
 
RESET_CONFIGURATION
Undocumented dbms_xstream_gg_adm.reset_configuration(
server_name   IN VARCHAR2,
reset_options IN BINARY_INTEGER);
TBD
 
SET_CHECKPOINT_SCNS
Undocumented dbms_xstream_gg_adm.set_checkpoint_scns(
capture_name      IN VARCHAR2,
io_checkpoint_scn IN NUMBER,
br_checkpoint_scn IN NUMBER);
TBD
 
SET_DML_CONFLICT_HANDLER
Undocumented

Overload 1
dbms_xstream_gg_adm.set_dml_conflict_handler(
apply_name            IN VARCHAR2,
conflict_handler_name IN VARCHAR2,
object                IN VARCHAR2,
operation_name        IN VARCHAR2,
conflict_type         IN VARCHAR2,
method_name           IN VARCHAR2,
column_LIST           IN VARCHAR2,
resolution_column     IN VARCHAR2,
source_object         IN VARCHAR2);
TBD
Overload 2 dbms_xstream_gg_adm.set_dml_conflict_handler(
apply_name            IN VARCHAR2,
conflict_handler_name IN VARCHAR2,
object                IN VARCHAR2,
operation_name        IN VARCHAR2,
conflict_type         IN VARCHAR2,
method_name           IN VARCHAR2,
column_table          IN sys.dbms_utility.lname_array,
resolution_column     IN VARCHAR2,
source_object         IN VARCHAR2);
TBD
 
SET_MESSAGE_TRACKING
Sets the current tracking label for logical change records (LCRs) produced by the current session dbms_xstream_gg_adm.set_message_tracking(
tracking_label IN VARCHAR2,
actions        IN NUMBER DEFAULT dbms_xstream_adm.action_memory);
exec dbms_xstream_gg_adm.set_message_tracking(NULL, dbms_xstream_adm.action_memory);

PL/SQL procedure successfully completed.
 
SET_PARAMETER
Undocumented dbms_xstream_gg_adm.set_parameter(
streams_name    IN VARCHAR2,
streams_type    IN VARCHAR2,
parameter       IN VARCHAR2,
value           IN VARCHAR2,
no_wait         IN BOOLEAN,
source_database IN VARCHAR2);
TBD
 
SET_REPERROR_HANDLER
Undocumented dbms_xstream_gg_adm.set_reperror_handler(
apply_name    IN VARCHAR2,
object        IN VARCHAR2,
error_number  IN NUMBER,
method        IN VARCHAR2,
source_object IN VARCHAR2,
max_retries   IN NUMBER,
delay_csecs   IN NUMBER);
TBD
 
SET_TAG
sets the binary tag for all redo entries subsequently generated by the current session. Each redo entry generated by DML or DDL statements in the current session will have this tag. dbms_xstream_gg_adm.set_tag(tag IN RAW DEFAULT NULL);
DECLARE
 tagVal RAW(2000) := utl_raw.cast_to_raw('UWXSTag');
BEGIN
  dbms_xstream_gg_adm.set_tag(tagVal);
  dbms_output.put_line(dbms_xstream_adm.get_tag);
END;
/
55575853546167

PL/SQL procedure successfully completed.
 
SET_UP_QUEUE
Creates a queue for Integrated Capture and Replicat dbms_xstream_gg_adm.set_up_queue(
queue_table    IN VARCHAR2,
storage_clause IN VARCHAR2,
queue_name     IN VARCHAR2,
queue_USER     IN VARCHAR2,
comment        IN VARCHAR2);
TBD
 
SPLIT_STREAMS
Splits a single GoldenGate capture to two replicats dbms_xstream_gg_adm.split_streams(
propagation_name        IN     VARCHAR2,
cloned_propagation_name IN     VARCHAR2,
cloned_queue_name       IN     VARCHAR2,
cloned_capture_name     IN     VARCHAR2,
perform_actions         IN     BOOLEAN,
script_name             IN     VARCHAR2,
script_directory_object IN     VARCHAR2,
auto_merge_threshold    IN     NUMBER,
schedule_name           IN OUT VARCHAR2,
merge_job_name          IN OUT VARCHAR2);
TBD
 
START_OUTBOUND
Starts an OGG XStream outbound server streaming out the LCRs to an XStream client application dbms_xstream_gg_adm.start_outbound(server_name IN VARCHAR2);
exec dbms_xstream_gg_adm.start_outbound('ZZYZX');
BEGIN dbms_xstream_gg_adm.start_outbound('ZZYZX'); END;
*
ERROR at line 1:
ORA-26701: Streams process ZZYZX does not exist
ORA-06512: at "SYS.DBMS_LOGREP_UTIL", line 581
ORA-06512: at "SYS.DBMS_LOGREP_UTIL", line 635
ORA-06512: at "SYS.DBMS_XSTREAM_ADM_UTL", line 430
ORA-06512: at "SYS.DBMS_XSTREAM_GG_ADM", line 828
ORA-06512: at line 1
 
STOP_OUTBOUND
Stops an OGG XStream outbound server streaming out the LCRs to an XStream client application. dbms_xstream_gg_adm.stop_outbound(
server_name IN VARCHAR2,
force       IN BOOLEAN   DEFAULT FALSE);
exec dbms_xstream_gg_adm.stop_outbound('ZZYZX');
BEGIN dbms_xstream_gg_adm.stop_outbound('ZZYZX'); END;
*
ERROR at line 1:
ORA-26701: Streams process ZZYZX does not exist
ORA-06512: at "SYS.DBMS_LOGREP_UTIL", line 581
ORA-06512: at "SYS.DBMS_LOGREP_UTIL", line 635
ORA-06512: at "SYS.DBMS_XSTREAM_ADM_UTL", line 430
ORA-06512: at "SYS.DBMS_XSTREAM_GG_ADM", line 856
ORA-06512: at line 1
 
UPDATE_ERROR_TXN
Undocumented dbms_xstream_gg_adm.update_error_txn(
transaction_id IN VARCHAR2,
error_flags    IN NUMBER);
TBD

Related Topics
Built-in Functions
Built-in Packages
Database Security
What's New In 19c
What's New In 20c

Morgan's Library Page Footer
This site is maintained by Dan Morgan. Last Updated: This site is protected by copyright and trademark laws under U.S. and International law. © 1998-2019 Daniel A. Morgan All Rights Reserved
  DBSecWorx