ACE Director Alum Daniel Morgan, founder of Morgan's Library, is scheduling
complimentary technical Workshops on Database Security for the first 30
Oracle Database customers located anywhere in North America, EMEA, LATAM, or
APAC that send an email to
asra_us@oracle.com. Request a Workshop for
your organization today.
Purpose
Provides interfaces for streaming database changes between an Oracle database and heterogeneous, external, systems enabling applications to stream data changes both in or out.
AUTHID
CURRENT_USER
Constants
Name
Data Type
Value
Miscellaneous
RESET_PARAMETERS
BINARY_INTEGER
1
RESET_HANDLERS
BINARY_INTEGER
2
RESET_PROGRESS
BINARY_INTEGER
4
CLEAR_KEY_COLUMNS
BINARY_INTEGER
8
RESET_ALL
BINARY_INTEGER
2147483647
Set Message Tracing
ACTION_TRACE
BINARY_INTEGER
1
ACTION_MEMORY
BINARY_INTEGER
2
Variable
is_xstream BOOLEAN;
Dependencies
ANYDATA
DBMS_LOGREP_UTIL
DBMS_STREAMS_DECL
DBMS_APPLY_ADM
DBMS_LOGREP_UTIL_INVOK
DBMS_UTILITY
DBMS_APPLY_ADM_INTERNAL
DBMS_STANDARD
DBMS_XSTREAM_ADM_INTERNAL
DBMS_ASSERT
DBMS_STREAMS_ADM
DBMS_XSTREAM_ADM_UTL
DBMS_CAPTURE_ADM_INTERNAL
DBMS_STREAMS_ADM_IVK
DBMS_XSTREAM_GG_ADM
DBMS_CAPTURE_ADM_IVK
DBMS_STREAMS_ADM_UTL
DBMS_XSTREAM_UTL_IVK
DBMS_LOGREP_LIB
DBMS_STREAMS_ADM_UTL_INVOK
Documented
Yes
First Available
11.2
Security Model
Owned by SYS with EXECUTE granted to the EXECUTE_CATALOG_ROLE role
Creates an Oracle XStream outbound server that dequeues logical change records (LCRs) from the specified queue
Overload 1
dbms_xstream_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 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_adm.add_outbound(
server_name IN VARCHAR2,
queue_name IN VARCHAR2,
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 TRUE,
source_root_name IN VARCHAR2 DEFAULT NULL,
source_container_name IN VARCHAR2 DEFAULT NULL,
lcrid_version IN NUMBER DEFAULT NULL);
Adds subset rules to an outbound server configuration
Overload 1
dbms_xstream_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);
SELECT rule_owner, subsetting_operation, rule_name
FROM dba_xstream_rules
WHERE subsetting_operation IS NOT NULL;
Overload 2
dbms_xstream_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);
SELECT rule_owner, subsetting_operation, rule_name
FROM dba_xstream_rules
WHERE subsetting_operation IS NOT NULL;
dbms_xstream_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_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);
Creates an Oracle XStream inbound server and its queue
dbms_xstream_adm.create_inbound(
server_name IN VARCHAR2,
queue_name IN VARCHAR2,
apply_user IN VARCHAR2 DEFAULT NULL,
comment IN VARCHAR2 DEFAULT NULL);
Creates an Oracle 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_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,
capture_name IN VARCHAR2 DEFAULT NULL,
include_dml IN BOOLEAN DEFAULT TRUE,
include_ddl 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_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,
capture_name IN VARCHAR2 DEFAULT NULL,
include_dml IN BOOLEAN DEFAULT TRUE,
include_ddl IN BOOLEAN DEFAULT TRUE,
source_root_name IN VARCHAR2 DEFAULT NULL,
source_contaimer_name IN VARCHAR2 DEFAULT NULL,
lcrid_version IN NUMBER DEFAULT NULL);
Removes subset rules from an outbound server configuration
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);
SELECT rule_owner, subsetting_operation, rule_name
FROM dba_xstream_rules
WHERE subsetting_operation IS NOT NULL;
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_adm.set_tag(tag IN RAW DEFAULT NULL);
DECLARE
tagVal RAW(2000) := utl_raw.cast_to_raw('UWXSTag');
BEGIN
dbms_xstream_adm.set_tag(tagVal);
dbms_output.put_line(dbms_xstream_adm.get_tag);
END;
/