Oracle | DBMS_XSTREAM_ADM

Oracle DBMS_XSTREAM_ADM_UTL Version 26ai

General Information

Library Note

Morgan's Library Page Header

The best Oracle News for FY2026

Oracle Database 26ai will be available on generic Linux platforms in January and soon on AIX and Windows

Purpose Utility package supporting heterogeneous streams replication and GoldenGate

AUTHID DEFINER

Dependencies

ALL_USERS	DBMS_GSM_DBADMIN	DBMS_XSTREAM_GG_ADM
ANYDATA	DBMS_LOGREP_LIB	DBMS_XSTREAM_UTL_IVK
DBA_APPLY	DBMS_LOGREP_UTIL	LOGSTDBY$PARAMETERS
DBA_CAPTURE	DBMS_LOGREP_UTIL_INVOK	PROPS$
DBA_GOLDENGATE_RULES	DBMS_RULE_ADM	STREAMS$_APPLY_MILESTONE
DBA_STREAMS_RULES	DBMS_SHARED_CAPTURE_IVK	STREAMS$_APPLY_PROCESS
DBA_XSTREAM_RULES	DBMS_STANDARD	STREAMS$_CAPTURE_PROCESS
DBMS_APPLY_ADM	DBMS_STREAMS_ADM	STREAMS$_CAPTURE_SERVER
DBMS_APPLY_ADM_INTERNAL	DBMS_STREAMS_ADM_UTL	V$DATABASE
DBMS_AQADM	DBMS_STREAMS_DECL	XSTREAM$_PRIVILEGES
DBMS_ASSERT	DBMS_STREAMS_LCR_INT	XSTREAM$_SERVER
DBMS_CAPTURE_ADM	DBMS_SYSTEM	XSTREAM$_SUBSET_RULES
DBMS_CAPTURE_ADM_INTERNAL	DBMS_UTILITY	XSTREAM$_SYSGEN_OBJS
DBMS_CAPTURE_ADM_IVK	DBMS_XSTREAM_ADM	_DBA_GGXSTREAM_INBOUND
DBMS_GOLDENGATE_ADM	DBMS_XSTREAM_AUTH_IVK	_DBA_GGXSTREAM_OUTBOUND

Documented No

First Available 11.2

Security Model Owned by SYS with EXECUTE granted to GSMADMIN_INTERNAL and the EXECUTE_CATALOG_ROLE role.

Source {ORACLE_HOME}/rdbms/admin/prvthxstr.plb

Subprograms

ALTER_OUTBOUND	GRANT_CONNECT_USER_PRIVILEGE
APPLY_EXISTS	HAS_TABLE_RULE
CHECK_SVR_NAME	INS_GEN_OBJ
CHECK_SVR_TYPE	INS_SUBSET_RULES
CLEAN_APPLY_SPILL	IS_GG_XSTREAM_FOR_STREAMS
CONVERT_SCN_TO_POS	IS_ROOT_WITH_DGPDB
CREATE_XOUT_CAPTURE	IS_SYSGEN_OBJ
DEL_GEN_RULE	IS_UNCOMMITTED_XOUT
DEL_SUBSET_RULES	NUM_SUBSCRIBERS
DEL_XSERVER	REMOVE_GEN_RULE
DROP_GEN_RULE	REMOVE_XSTREAM_ADMIN_PRIVILEGE
DROP_OUTBOUND	SET_APPLY_STARTSCN
DROP_OUTBOUND_RULES	SET_CAPTURE_STARTSCN
ENABLE_GG_XSTREAM_FOR_STREAMS	SET_CHECKPOINT_SCNS
GET_CAP_N_QUEUE	SET_OUTBOUND_STARTSCN
GET_LCR_CONTENT	START_OUTBOUND
GET_LOCAL_CAPTURE	STOP_OUTBOUND
GET_OUTBOUND_SRCDB	UPD_XSERVER
GET_OUTBOUND_SRCROOT	UPD_XSERVER_CAPINFO
GET_PROCEDURE_RULES	VALID_SUBSET_RULES
GET_STREAMS_RULES

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);

           *

      ORA-026859: Server "ORA2MS" is not an XStream outbound server

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;

      /

      

      PL/SQL procedure successfully completed.

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);

      

      PL/SQL procedure successfully completed.

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');

      

      PL/SQL procedure successfully completed.

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;

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;

      /

      TRUE

      

      PL/SQL procedure successfully completed.

IS_ROOT_WITH_DGPDB (new 23ai)

Returns TRUE if the root current container is ROOT is in a Data Guard standby with a PDB dbms_xstream_adm_utl.is_root_with_dgpdb RETURN BOOLEAN;

BEGIN

        IF dbms_xstream_adm_utl.is_root_with_dgpdb THEN

          dbms_output.put_line('TRUE');

        ELSE

          dbms_output.put_line('FALSE');

        END IF;

      END;

      /

      
      TRUE

      

      PL/SQL procedure successfully completed.

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;

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;

      /

      FALSE

      

      PL/SQL procedure successfully completed.

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;

      /

      *

      ORA-24010: QUEUE UWCLASS.ZZYZX_Q does not exist

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

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