Oracle DBMS_XSTREAM_ADM_UTL
Version 21c

General Information
Library Note Morgan's Library Page Header
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 Utility package supporting heterogeneous streams replication and GoldenGate
AUTHID DEFINER
Dependencies
ALL_USERS DBMS_LOGREP_LIB DBMS_XSTREAM_GG_ADM
ANYDATA DBMS_LOGREP_UTIL DBMS_XSTREAM_UTL_IVK
DBA_APPLY DBMS_LOGREP_UTIL_INVOK PROPS$
DBA_CAPTURE DBMS_RULE_ADM STREAMS$_APPLY_MILESTONE
DBA_GOLDENGATE_RULES DBMS_STANDARD STREAMS$_APPLY_PROCESS
DBA_STREAMS_RULES DBMS_STREAMS_ADM STREAMS$_CAPTURE_PROCESS
DBA_XSTREAM_RULES DBMS_STREAMS_ADM_UTL STREAMS$_CAPTURE_SERVER
DBMS_APPLY_ADM DBMS_STREAMS_DECL XSTREAM$_PRIVILEGES
DBMS_APPLY_ADM_INTERNAL DBMS_STREAMS_LCR_INT XSTREAM$_SERVER
DBMS_AQADM DBMS_SYSTEM XSTREAM$_SUBSET_RULES
DBMS_ASSERT DBMS_UTILITY XSTREAM$_SYSGEN_OBJS
DBMS_CAPTURE_ADM DBMS_XSTREAM_ADM _DBA_GGXSTREAM_INBOUND
DBMS_CAPTURE_ADM_INTERNAL DBMS_XSTREAM_AUTH _DBA_GGXSTREAM_OUTBOUND
DBMS_CAPTURE_ADM_IVK DBMS_XSTREAM_AUTH_IVK  
Documented No
First Available 11.2
Security Model Owned by SYS with EXECUTE granted to the EXECUTE_CATALOG_ROLE role.
Source {ORACLE_HOME}/rdbms/admin/prvthxstr.plb
Subprograms
 
ADD_XSTREAM_ADMIN_PRIVILEGE
Undocumented dbms_xstream_adm_utl.add_xstream_admin_privilege(
grantee               IN VARCHAR2,
canon_privilege_type  IN NUMBER,
canon_privilege_level IN NUMBER);
TBD
 
ALTER_OUTBOUND
Undocumented dbms_xstream_adm_utl.alter_outbound(
canon_svr_name    IN VARCHAR2
canon_capture     IN VARCHAR2
canon_invoker     IN VARCHAR2
oldest_scn        IN BINARY_INTEGER
processed_lwm_scn IN BINARY_INTEGER
flags             IN BINARY_INTEGER);
TBD
 
APPLY_EXISTS
Undocumented dbms_xstream_adm_utl.apply_exists(
srv_name       IN  VARCHAR2,
canon_srv_name OUT VARCHAR2)
RETURN BOOLEAN;
TBD
 
CHECK_SVR_NAME
Undocumented dbms_xstream_adm_utl.check_svr_name(
svr_name       IN  VARCHAR2,
must_exist     IN  BOOLEAN,
canon_svr_name OUT VARCHAR2,
is_outbound    IN  BOOLEAN);
TBD
 
CHECK_SVR_TYPE
Undocumented dbms_xstream_adm_utl.check_svr_type(
canon_svr_name IN VARCHAR2,
is_outbound    IN BOOLEAN);
exec dbms_xstream_adm_utl.check_svr_type('ORA2MS', TRUE);
 
CLEAN_APPLY_SPILL
Undocumented dbms_xstream_adm_utl.clean_apply_spill(canon_apply_name IN VARCHAR2);
DECLARE
 cname user_tables.table_name%TYPE;
BEGIN
  dbms_utility.canonicalize('uwclass.servers', cname, 16);
  dbms_xstream_adm_utl.clean_apply_spill(cname);
END;
/
 
CONVERT_SCN_TO_POS
Undocumented dbms_xstream_adm_utl.convert_scn_to_pos(
scn IN  NUMBER,
pos OUT RAW);
TBD
 
CREATE_XOUT_CAPTURE
Undocumented dbms_xstream_adm_utl.create_xout_capture(
queue_name       IN VARCHAR2,
canon_capture    IN VARCHAR2,
canon_invoker    IN VARCHAR2,
source_database  IN VARCHAR2,
capture_user     IN VARCHAR2,
enable_procedure IN BOOLEAN,
source_root_name IN VARCHAR2);
TBD
 
DEL_GEN_RULE
Undocumented dbms_xstream_adm_utl.del_gen_rule(
rule_name     IN VARCHAR2,
canon_invoker IN VARCHAR2);
TBD
 
DEL_SUBSET_RULES
Undocumented dbms_xstream_adm_utl.del_subset_rules(
canon_server_name IN VARCHAR2,
canon_ins_rule    IN VARCHAR2,
canon_upd_rule    IN VARCHAR2,
canon_del_rule    IN VARCHAR2,
canon_rules_owner IN VARCHAR2);
TBD
 
DEL_XSERVER
Undocumented dbms_xstream_adm_utl.del_xserver(canon_server_name IN VARCHAR2);
TBD
 
DROP_GEN_RULE
Undocumented dbms_xstream_adm_utl.drop_gen_rule(
rule_name     IN VARCHAR2,
canon_invoker IN VARCHAR2);
TBD
 
DROP_OUTBOUND
Undocumented dbms_xstream_adm_utl.drop_outbound(
server_name   IN VARCHAR2,
canon_invoker IN VARCHAR2);
TBD
 
DROP_OUTBOUND_RULES
Undocumented dbms_xstream_adm_utl.drop_outbound_rules(
canon_svr_name IN VARCHAR2,
canon_invoker  IN VARCHAR2);
TBD
 
ENABLE_GG_XSTREAM_FOR_STREAMS
Enable GoldenGate XStream for Stream dbms_xstream_adm_utl.enable_gg_xstream_for_streams(enable IN BOOLEAN);
exec dbms_xstream_adm_utl.enable_gg_xstream_for_streams(TRUE);
 
GET_CAP_N_QUEUE
Undocumented dbms_xstream_adm_utl.get_cap_n_queue(
canon_server_name  IN  VARCHAR2,
canon_capture      OUT VARCHAR2,
canon_cap_src_db   OUT VARCHAR2,
canon_cap_src_root OUT VARCHAR2,
canon_queue_owner  OUT VARCHAR2,
canon_queue_name   OUT VARCHAR2,
is_outbound        IN  BOOLEAN);
TBD
 
GET_LCR_CONTENT
Undocumented dbms_xstream_adm_utl.get_lcr_content(
lcr      IN XMLTYPE,
row_type IN VARCHAR2)
RETURN CLOB;
TBD
 
GET_LOCAL_CAPTURE
Undocumented dbms_xstream_adm_utl.get_local_capture(
canon_qowner     IN     VARCHAR2,
canon_qname      IN     VARCHAR2,
canon_capture    IN OUT VARCHAR2,
canon_cap_src_db IN OUT VARCHAR2);
TBD
 
GET_OUTBOUND_SRCDB
Undocumented dbms_xstream_adm_utl.get_outbound_srcdb(canon_server IN VARCHAR2)
RETURN VARCHAR2;
TBD
 
GET_OUTBOUND_SRCROOT
Undocumented dbms_xstream_adm_utl.get_outbound_srcroot(canon_server IN VARCHAR2)
RETURN VARCHAR2;
TBD
 
GET_PROCEDURE_RULES
Undocumented dbms_xstream_adm_utl.get_procedure_rules(
canon_strms_name IN  VARCHAR2,
streams_type     IN  VARCHAR2,
inclusion_rule   IN  BOOLEAN,
rule_list_out    OUT dbms_utility.uncl_array,
rule_cnt         OUT NUMBER);
TBD
 
GET_STREAMS_RULES
Undocumented dbms_xstream_adm_utl.get_streams_rule(
canon_strms_name IN  VARCHAR2,
streams_type     IN  VARCHAR2,
table_cnt        IN  NUMBER,
canon_tab_owners IN  dbms_utility.name_array,
canon_tab_names  IN  dbms_utility.name_array,
schema_cnt       IN  NUMBER,
canon_schemas    IN  dbms_utility.name_array,
inclusion_rule   IN  BOOLEAN,
rule_list        OUT dbms_utility.uncl_array,
rule_cnt         OUT NUMBER,
include_dml      IN  BOOLEAN,
include_ddl      IN  BOOLEAN,
source_db        IN VARCHAR2,
source_root      IN VARCHAR2);
TBD
 
GRANT_CONNECT_USER_PRIVILEGE
Undocumented dbms_xstream_adm_utl.grant_connect_user_privilege(
is_grant     IN BOOLEAN,
connect_user IN VARCHAR2);
exec dbms_xstream_adm_utl.grant_connect_user_privilege(FALSE, 'UWCLASS');
 
HAS_TABLE_RULE
Undocumented dbms_xstream_adm_utl.has_table_rule(
canon_table_owner IN VARCHAR2,
canon_table_name  IN VARCHAR2,
canon_strm_name   IN VARCHAR2,
streams_type      IN VARCHAR2)
RETURN BOOLEAN;
TBD
 
INS_GEN_OBJ
Undocumented dbms_xstream_adm_utl.ins_gen_obj(
canon_server_name  IN VARCHAR2,
canon_object_owner IN VARCHAR2,
canon_object_name  IN VARCHAR2,
object_type        IN VARCHAR2);
TBD
 
INS_SUBSET_RULES
Undocumented dbms_xstream_adm_utl.ins_subset_rules(
canon_server_name IN VARCHAR2,
ins_rule          IN VARCHAR2,
upd_rule          IN VARCHAR2,
del_rule          IN VARCHAR2,
canon_invoker     IN VARCHAR2);
TBD
 
IS_GG_XSTREAM_FOR_STREAMS
Undocumented dbms_xstream_adm_utl.is_gg_xstream_for_streams RETURN BOOLEAN;
set serveroutput on

DECLARE
 b BOOLEAN;
BEGIN
  IF dbms_xstream_adm_utl.is_gg_xstream_for_streams THEN
    dbms_output.put_line('TRUE');
  ELSE
    dbms_output.put_line('FALSE');
  END IF;
END;
/
 
IS_SYSGEN_OBJ
Undocumented dbms_xstream_adm_utl.is_sysgen_obj(
canon_object_owner IN VARCHAR2,
canon_object_name  IN VARCHAR2,
object_type        IN VARCHAR2)
RETURN BOOLEAN;
TBD
 
IS_UNCOMMITTED_XOUT
Undocumented dbms_xstream_adm_utl.is_uncommitted_xout(server_name IN VARCHAR2)
RETURN BOOLEAN;
set serveroutput on

BEGIN
  IF dbms_xstream_adm_utl.is_uncommitted_xout('ZZYZX') THEN
    dbms_output.put_line('TRUE');
  ELSE
    dbms_output.put_line('FALSE');
  END IF;
END;
/
 
NUM_SUBSCRIBERS
Returns the number of subscribers on the named queue dbms_xstream_adm_utl.num_subscribers(
canon_qowner IN VARCHAR2,
canon_qname  IN VARCHAR2)
RETURN BINARY_INTEGER;
set serveroutput on

DECLARE
 i PLS_INTEGER;
BEGIN
  i := dbms_xstream_adm_utl.num_subscribers('UWCLASS', 'ZZYZX_Q');
  dbms_output.put_line(i);
END;
/
 
REMOVE_GEN_RULE
Undocumented dbms_xstream_adm_utl.remove_gen_rule(
rule_name      IN VARCHAR2,
streams_type   IN VARCHAR2,
streams_name   IN VARCHAR2,
canon_invoker  IN VARCHAR2,
inclusion_rule IN BOOLEAN);
TBD
 
REMOVE_XSTREAM_ADMIN_PRIVILEGE
Undocumented dbms_xstream_adm_utl.remove_xstream_admin_privilege(
grantee               IN VARCHAR2,
canon_privilege_type  IN NUMBER,
canon_privilege_level IN NUMBER);
TBD
 
SET_APPLY_STARTSCN
Undocumented dbms_xstream_adm_utl.set_apply_startscn(
canon_apply_name IN     VARCHAR2,
canon_start_scn  IN     NUMBER,
status           IN OUT NUMBER);
TBD
 
SET_CAPTURE_STARTSCN
Undocumented dbms_xstream_adm_utl.set_capture_startscn(
canon_srv_name  IN     VARCHAR2,
canon_start_scn IN     NUMBER,
status          IN OUT NUMBER,
cap_oldest_scn  IN OUT NUMBER);
TBD
 
SET_CHECKPOINT_SCNS
Undocumented dbms_xstream_adm_utl.set_checkpoint_scns(
capture_name      IN VARCHAR2,
io_checkpoint_scn IN NUMBER,
br_checkpoint_scn IN NUMBER);
TBD
 
SET_OUTBOUND_STARTSCN
Undocumented dbms_xstream_adm_utl.set_outbound_startscn(
canon_srv_name  IN     VARCHAR2,
canon_start_scn IN     NUMBER,
status          IN OUT NUMBER);
TBD
 
START_OUTBOUND
Undocumented dbms_xstream_adm_utl.start_outbound(canon_server IN VARCHAR2);
TBD
 
STOP_OUTBOUND
Undocumented dbms_xstream_adm_utl.stop_outbound(
canon_server IN VARCHAR2,
force        IN BOOLEAN);
TBD
 
UPDATE_XSTREAM_ADMIN_PRIVILEGE
Undocumented dbms_xstream_adm_utl.update_xstream_admin_privilege(
grantee       IN VARCHAR2,
optional_priv IN VARCHAR2,
canon_invoker IN VARCHAR2,
allpdbs       IN NUMBER);
TBD
 
UPD_XSERVER
Undocumented dbms_xstream_adm_utl.upd_xserver(
canon_server_name IN VARCHAR2,
usr_comment       IN VARCHAR2);
TBD
 
UPD_XSERVER_CAPINFO
Undocumented dbms_xstream_adm_utl.upd_xserver_capinfo(
canon_server_name IN VARCHAR2,
canon_capture     IN VARCHAR2,
canon_cap_srcdb   IN VARCHAR2,
comment           IN VARCHAR2);
TBD
 
VALID_SUBSET_RULES
Undocumented dbms_xstream_adm_utl.valid_subset_rules(
canon_svr_name    IN VARCHAR2,
canon_ins_rule    IN VARCHAR2,
canon_upd_rule    IN VARCHAR2,
canon_del_rule    IN VARCHAR2,
canon_rules_owner IN VARCHAR2)
RETURN BOOLEAN;
TBD

Related Topics
Built-in Functions
Built-in Packages
DBMS_XSTREAM_ADM
DBMS_XSTREAM_AUTH
DBMS_XSTREAM_AUTH_IVK
DBMS_XSTREAM_UTL_IVK
What's New In 21c
What's New In 23c

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-2023 Daniel A. Morgan All Rights Reserved
  DBSecWorx