Oracle | DBMS_AQADM

Oracle DBMS_AQADM_SYSCALLS 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 Advanced Queuing Administrative APIs.

AUTHID DEFINER

Dependencies

AQ$_AGENT	DBMS_AQADM_VAR	DBMS_PRVTAQIP
AQ$_QUEUES	DBMS_AQINT_LIB	DBMS_PRVTAQIS
AQ$_QUEUE_TABLES	DBMS_AQJMS	DBMS_PRVTSQDS
DBMS_AQ	DBMS_AQ_IMPORT_INTERNAL_DR	DBMS_PRVTSQIS
DBMS_AQADM	DBMS_AQ_SYS_EXP_INTERNAL	DBMS_RULEADM_INTERNAL
DBMS_AQADM_INV	DBMS_AQ_SYS_IMP_INTERNAL	DBMS_RULE_ADM
DBMS_AQADM_LIB	DBMS_ASSERT	DBMS_STREAMS_CONTROL_ADM
DBMS_AQADM_SYS	DBMS_PRVTAQIM	DBMS_SYS_ERROR

Documented No

Exceptions

Error Code	Reason

First Available Not known

Security Model Owned by SYS with no privileges granted

All package functionality is protected by an ACCESSIBLE BY Clause

Source {ORACLE_HOME}/rdbms/admin/dbmsaqds.plb
{ORACLE_HOME}/rdbms/admin/prvtaqdi.plb

Subprograms

EXECUTE_STMT_IN_KERNEL_CURSOR	KWQA_3GL_CREATEQUEUE_12G	KWQA_3GL_PURGE_CBK_OBJ
GET_MAX_STREAMS_POOL	KWQA_3GL_DESTROYCACHEOBJECT	KWQA_3GL_PURGE_QUEUE_TABLE
GET_MIN_STREAMS_POOL	KWQA_3GL_DMPESTACK	KWQA_3GL_QT_COMPAT
GET_OWNER_INSTANCE	KWQA_3GL_DROPQUEUE	KWQA_3GL_REMOVESUBSCRIBER
GET_WATERMARK	KWQA_3GL_DROPREGISTRATIONS	KWQA_3GL_REVOKE
IS_LOGICAL_STBY	KWQA_3GL_ENDTRANS	KWQA_3GL_SCHEDULETMSERVICE
IS_OGG_DEST	KWQA_3GL_EVENTLEVEL	KWQA_3GL_SETMSGWAIT
IS_OGG_SRC	KWQA_3GL_EXECUTESTMT	KWQA_3GL_SETREGISTRATIONNAME
IS_PRIMARY	KWQA_3GL_FIND_DATE	KWQA_3GL_SETSTREAMSCAPTUREOFF
IS_QUEUE_REPLICATED	KWQA_3GL_GET_PARAMS_IN_QKGL	KWQA_3GL_SET_CLR_TABLE_FLAG
KWQA_3GL_ADDSUBSCRIBER	KWQA_3GL_GRANT	KWQA_3GL_SET_PARAMS_IN_QKGL
KWQA_3GL_ALTERCACHEOBJECT	KWQA_3GL_INVALIDATEQUEUE	KWQA_3GL_SET_TABLE_STATS_LOCK
KWQA_3GL_ALTERQUEUE	KWQA_3GL_ISSTREAMSCAPTUREOFF	KWQA_3GL_SET_VIEW_FLAG
KWQA_3GL_ALTERSUBSCRIBER	KWQA_3GL_ISTTSIMPORT	KWQA_3GL_STARTQUEUE
KWQA_3GL_ANALYZE_MSG_CACHE	KWQA_3GL_LOCKQUEUE	KWQA_3GL_STOPQUEUE
KWQA_3GL_AQPKG	KWQA_3GL_LOCKQUEUETABLE	KWQA_3GL_STOP_MSG_FORWARDING
KWQA_3GL_BEGINTRANS	KWQA_3GL_MARK_INTERNAL_TABLES	KWQA_3GL_UNSET_PARAMS_IN_QKGL
KWQA_3GL_CALCULATE_MSG_CACHE	KWQA_3GL_NFYNOI	KWQA_3GL_UPDKGQM
KWQA_3GL_CHANGE_REP_MOD	KWQA_3GL_NTFNTRCCHK	KWQA_3GL_VALIDATEQUEUE
KWQA_3GL_CREATEADTPLODINFO	KWQA_3GL_PARSEAQNAME	SET_MAX_STREAMS_POOL
KWQA_3GL_CREATECACHEOBJECT	KWQA_3GL_PRINTREMSUBLIST	SET_MIN_STREAMS_POOL
KWQA_3GL_CREATEQUEUE	KWQA_3GL_PURGEREMSUBLIST	SET_WATERMARK

EXECUTE_STMT_IN_KERNEL_CURSOR

Undocumented dbms_aqadm_syscalls.execute_stmt_in_kernel_cursor( sql_stmt IN VARCHAR2, ignore_ddl IN BOOLEAN);

TBD

GET_MAX_STREAMS_POOL

Undocumented

All package functionality is protected by an ACCESSIBLE BY Clause dbms_aqadm_syscalls.get_max_streams_pool(value OUT NUMBER);

DECLARE

       n NUMBER;

      BEGIN

        dbms_aqadm_syscalls.get_max_streams_pool(n);

        dbms_output.put_line(n);

      END;

      /

      dbms_aqadm_syscalls.get_max_streams_pool(n);

      *

      ERROR at line 4:

      ORA-06550: line 4, column 3:

      PLS-00904: insufficient privilege to access object DBMS_AQADM_SYSCALLS

      ORA-06550: line 4, column 3:

      PL/SQL: Statement ignored

GET_MIN_STREAMS_POOL

Undocumented dbms_aqadm_syscalls.get_min_streams_pool(value OUT NUMBER);

TBD

GET_OWNER_INSTANCE

Undocumented dbms_aqadm_syscalls.get_owner_instance( primary_instance IN BINARY_INTEGER, secondary_instance IN BINARY_INTEGER, curr_owner_instance IN BINARY_INTEGER) RETURN BINARY_INTEGER;

TBD

GET_WATERMARK

Undocumented dbms_aqadm_syscalls.get_watermark(wmvalue OUT NUMBER);

TBD

IS_LOGICAL_STBY

Undocumented dbms_aqadm_syscalls.is_logical_stby RETURN BOOLEAN;

TBD

IS_OGG_DEST

Undocumented dbms_aqadm_syscalls.is_ogg_dest RETURN BOOLEAN;

TBD

IS_OGG_SRC

Undocumented dbms_aqadm_syscalls.is_ogg_src RETURN BOOLEAN;

TBD

IS_PRIMARY

Undocumented dbms_aqadm_syscalls.is_primary RETURN BOOLEAN;

TBD

IS_QUEUE_REPLICATED

Undocumented dbms_aqadm_syscalls.is_queue_replicated( name_type IN BINARY_INTEGER, qt_name IN VARCHAR2, queue_name IN VARCHAR2, crt_flag IN BOOLEAN, ext_flag IN BOOLEAN, replication_mode IN BINARY_INTEGER, can_obj_name OUT VARCHAR2, can_obj_sch OUT VARCHAR2, iqrepl OUT BOOLEAN, current_user IN VARCHAR2);

TBD

KWQA_3GL_ADDSUBSCRIBER

Undocumented dbms_aqadm_syscalls.kwqa_3gl_addsubscriber( q_schema IN VARCHAR2, q_name IN VARCHAR2, sub IN sys.aq$_agent, sub_type IN NUMBER, rule IN VARCHAR2, trans_owner IN VARCHAR2, trans_name IN VARCHAR2, ruleset_owner IN VARCHAR2, ruleset_name IN VARCHAR2, negrset_owner IN VARCHAR2, negrset_name IN VARCHAR2, sub_id IN NUMBER, proxy_id IN NUMBER, proxy_addr IN VARCHAR2, addr_id IN NUMBER, creation_time IN TIMESTAMP WITH TIME ZONE, scn_at_add OUT NUMBER);

TBD

KWQA_3GL_ALTERCACHEOBJECT

Undocumented dbms_aqadm_syscalls.kwqa_3gl_altercacheobject( jobname IN VARCHAR2, duration IN NUMBER, latency IN NUMBER);

TBD

KWQA_3GL_ALTERQUEUE

Undocumented dbms_aqadm_syscalls.kwqa_3gl_alterqueue( owner IN VARCHAR2, queue_name IN VARCHAR2, max_retry IN BINARY_INTEGER, retry_interval IN BINARY_INTEGER, retention IN BINARY_INTEGER, comment IN VARCHAR2, flow_control IN BINARY_INTEGER, rep_queue IN BINARY_INTEGER);

TBD

KWQA_3GL_ALTERSUBSCRIBER

Undocumented dbms_aqadm_syscalls.kwqa_3gl_altersubscriber( q_schema IN VARCHAR2, q_name IN VARCHAR2, sub IN sys.aq$agent, new_rule_name IN VARCHAR2, ex_rule_name IN VARCHAR2, new_trans_name IN VARCHAR2, full_ruleset IN VARCHAR2, ex_ruleset IN VARCHAR2, full_negrset IN VARCHAR2, ex_negrset IN VARCHAR2, modification_time IN TIMESTAMP WITH TIME ZONE, current_user IN VARCHAR2)

TBD

KWQA_3GL_ANALYZE_MSG_CACHE

Undocumented dbms_aqadm_syscalls.kwqa_3gl_analyze_msg_cache( inst_id IN BINARY_INTEGER, schema IN VARCHAR2, qname IN VARCHAR2, queue_id IN BINARY_INTEGER, pdb IN BINARY_INTEGER, input_flag IN BINARY_INTEGER);

TBD

KWQA_3GL_AQPKG

Undocumented dbms_aqadm_syscalls.kwqa_3gl_aqpkg RETURN BOOLEAN;

TBD

KWQA_3GL_BEGINTRANS

Undocumented dbms_aqadm_syscalls.kwqa_3gl_begintrans( set_nocmt IN BOOLEAN, old_state OUT BOOLEAN);

TBD

KWQA_3GL_CALCULATE_MSG_CACHE

Undocumented dbms_aqadm_syscalls.kwqa_3gl_calculate_msg_cache(inst_id IN BINARY_INTEGER);

TBD

KWQA_3GL_CHANGE_REP_MOD

Undocumented dbms_aqadm_syscalls.kwqa_3gl_change_rep_mod( schema IN VARCHAR2, qname IN VARCHAR2, qt_flag IN BINARY_INTEGER);

TBD

KWQA_3GL_CREATEADTPLODINFO

Undocumented dbms_aqadm_syscalls.kwqa_3gl_createadtplodinfo( owner IN VARCHAR2, queue_name IN VARCHAR2, adt_schema IN VARCHAR2, adt_name IN VARCHAR2, qt_flags IN BINARY_INTEGER);

TBD

KWQA_3GL_CREATECACHEOBJECT

Undocumented dbms_aqadm_syscalls.kwqa_3gl_createcacheobject( destination IN VARCHAR2, jobname IN VARCHAR2, duration IN NUMBER, myoid IN RAW, latency IN NUMBER, destq IN BINARY_INTEGER);

TBD

KWQA_3GL_CREATEQUEUE

Undocumented dbms_aqadm_syscalls.kwqa_3gl_createqueue( owner IN VARCHAR2, queue_name IN VARCHAR2, table_name IN VARCHAR2, compatible IN BINARY_INTEGER, queue_oid IN RAW, queue_type IN BINARY_INTEGER, max_retry IN BINARY_INTEGER, retry_interval IN BINARY_INTEGER, tracking IN BOOLEAN, retention IN BINARY_INTEGER, owner_instance IN BINARY_INTEGER, comment IN VARCHAR2, qt_flags IN BINARY_INTEGER, sort_order IN BINARY_INTEGER, timezone IN VARCHAR2, create_import IN BOOLEAN, shard_count IN BINARY_INTEGER);

TBD

KWQA_3GL_CREATEQUEUE_12G

Undocumented dbms_aqadm_syscalls.kwqa_3gl_createqueue_12g( owner IN VARCHAR2, queue_name IN VARCHAR2, table_name IN VARCHAR2, compatible IN BINARY_INTEGER, queue_oid IN RAW, queue_type IN BINARY_INTEGER, max_retry IN BINARY_INTEGER, retry_interval IN BINARY_INTEGER, tracking IN BOOLEAN, retention IN BINARY_INTEGER, owner_instance IN BINARY_INTEGER, comment IN VARCHAR2, qt_flags IN BINARY_INTEGER, timezone IN VARCHAR2, create_import IN BOOLEAN);

TBD

KWQA_3GL_DESTROYCACHEOBJECT

Undocumented dbms_aqadm_syscalls.kwqa_3gl_destroycacheobject( jobname IN VARCHAR2, dest IN VARCHAR2, myoid IN RAW);

TBD

KWQA_3GL_DMPESTACK

Undocumented dbms_aqadm_syscalls.kwqa_3gl_dmpestack;

TBD

KWQA_3GL_DROPQUEUE

Undocumented dbms_aqadm_syscalls.kwqa_3gl_dropqueue( owner IN VARCHAR2, queue_name IN VARCHAR2, force IN BOOLEAN);

TBD

KWQA_3GL_DROPREGISTRATIONS

Undocumented dbms_aqadm_syscalls.kwqa_3gl_dropregistrations( schema IN VARCHAR2, qname IN VARCHAR2)

TBD

KWQA_3GL_ENDTRANS

Undocumented dbms_aqadm_syscalls.kwqa_3gl_endtrans( commit_trans IN BOOLEAN, old_state IN BOOLEAN)

TBD

KWQA_3GL_EVENTLEVEL

Undocumented dbms_aqadm_syscalls.kwqa_3gl_eventlevel(event IN BINARY_INTEGER) RETURN BINARY_INTEGER;

TBD

KWQA_3GL_EXECUTESTMT

Undocumented dbms_aqadm_syscalls.kwqa_3gl_executestmt(stmt IN VARCHAR2);

TBD

KWQA_3GL_FIND_DATE

Undocumented dbms_aqadm_syscalls.kwqa_3gl_find_date( interval IN VARCHAR2, next_date OUT DATE, current_user IN VARCHAR2);

TBD

KWQA_3GL_GET_PARAMS_IN_QKGL

Undocumented dbms_aqadm_syscalls.kwqa_3gl_get_params_in_qkgl( queue_schema IN VARCHAR2, queue_name IN VARCHAR2, param_name IN VARCHAR2, param_value OUT NUMBER);

TBD

KWQA_3GL_GRANT

Undocumented dbms_aqadm_syscalls.kwqa_3gl_grant( owner IN VARCHAR2, queue_name IN VARCHAR2, grantee IN VARCHAR2, privilege IN BINARY_INTEGER, is_syspriv IN PL/SQL BOOLEAN, cascade IN BOOLEAN, grantor IN VARCHAR2);

TBD

KWQA_3GL_INVALIDATEQUEUE

Undocumented dbms_aqadm_syscalls.kwqa_3gl_invalidatequeue( qt_schema IN VARCHAR2, q_name IN VARCHAR2);

TBD

KWQA_3GL_ISSTREAMSCAPTUREOFF

Undocumented dbms_aqadm_syscalls.kwqa_3gl_isstreamscaptureoff RETURN BOOLEAN;

TBD

KWQA_3GL_ISTTSIMPORT

Undocumented dbms_aqadm_syscalls.kwqa_3gl_isttsimport RETURN BOOLEAN;

TBD

KWQA_3GL_LOCKQUEUE

Undocumented dbms_aqadm_syscalls.kwqa_3gl_lockqueue( q_schema IN VARCHAR2, q_name IN VARCHAR2, operation IN VARCHAR2, flags IN BINARY_INTEGER, ignore_errors IN BOOLEAN);

TBD

KWQA_3GL_LOCKQUEUETABLE

Undocumented

Overload 1 dbms_aqadm_syscalls.kwqa_3gl_lockqueuetable( qt_schema IN VARCHAR2, qt_name IN VARCHAR2, operation IN VARCHAR2, flags IN BINARY_INTEGER);

TBD

Overload 2 dbms_aqadm_syscalls.kwqa_3gl_lockqueuetable( qt_schema IN VARCHAR2, qt_name IN VARCHAR2, operation IN VARCHAR2, flags IN BINARY_INTEGER, qtab_exists OUT BOOLEAN, qtdct_exists OUT BOOLEAN, qtobjno OUT NUMBER, qt_flags OUT BINARY_INTEGER, qt_owner OUT BINARY_INTEGER);

TBD

KWQA_3GL_MARK_INTERNAL_TABLES

Undocumented dbms_aqadm_syscalls.kwqa_3gl_mark_internal_tables(set_indictor_flg IN BINARY_INTEGER);

TBD

KWQA_3GL_NFYNOI

Undocumented dbms_aqadm_syscalls.kwqa_3gl_nfynoi( qtobjno IN NUMBER, instid IN BINARY_INTEGER);

TBD

KWQA_3GL_NTFNTRCCHK

Undocumented dbms_aqadm_syscalls.kwqa_3gl_ntfntrcchk RETURN BOOLEAN;

TBD

KWQA_3GL_PARSEAQNAME

Undocumented dbms_aqadm_syscalls.kwqa_3gl_parseaqname( ntype IN BINARY_INTEGER, fname IN VARCHAR2, default_schema IN VARCHAR2, schema OUT VARCHAR2, name OUT VARCHAR2, dblkdb OUT VARCHAR2, dblkdom OUT VARCHAR2, dblkconq OUT VARCHAR2, ext_flag IN BINARY_INTEGER);

TBD

KWQA_3GL_PRINTREMSUBLIST

Undocumented dbms_aqadm_syscalls.kwqa_3gl_printremsublist( owner IN VARCHAR2, queue_name IN VARCHAR2);

TBD

KWQA_3GL_PURGEREMSUBLIST

Undocumented dbms_aqadm_syscalls.kwqa_3gl_purgeremsublist( owner IN VARCHAR2, queue_name IN VARCHAR2, sub IN sys.aq$agent, subid IN NUMBER, ifcheck IN BOOLEAN, pendingtxnx OUT BOOLEAN);

TBD

KWQA_3GL_PURGE_CBK_OBJ

Undocumented dbms_aqadm_syscalls.kwqa_3gl_purge_cbk_obj( schema IN VARCHAR2, name IN VARCHAR2, qt_flags IN BINARY_INTEGER, tobjno IN NUMBER, qt_sort_cols IN BINARY_INTEGER, delivery_mode IN BINARY_INTEGER, purge_condition IN VARCHAR2);

TBD

KWQA_3GL_PURGE_QUEUE_TABLE

Undocumented dbms_aqadm_syscalls.kwqa_3gl_purge_queue_table( schema IN VARCHAR2, name IN VARCHAR2, qt_flags IN BINARY_INTEGER, tobjno IN NUMBER, qt_sort_cols IN BINARY_INTEGER, delivery_mode IN BINARY_INTEGER, purge_condition IN VARCHAR2, current_user IN VARCHAR2, jms IN BOOLEAN);

TBD

KWQA_3GL_QT_COMPAT

Undocumented dbms_aqadm_syscalls.kwqa_3gl_qt_compat(compatible IN VARCHAR2) RETURN BINARY_INTEGER;

TBD

KWQA_3GL_REMOVESUBSCRIBER

Undocumented dbms_aqadm_syscalls.kwqa_3gl_removesubscriber( q_schema IN VARCHAR2, q_name IN VARCHAR2, sub IN OBJECT, SYS AQ$_AGENT rule_name IN VARCHAR2, ruleset IN VARCHAR2, negrset IN VARCHAR2, subid IN NUMBER, proxyid IN NUMBER, deletion_time IN TIMESTAMP WITH TIME ZONE, scn_at_remove OUT NUMBER, current_user IN VARCHAR2);

TBD

KWQA_3GL_REVOKE

Undocumented dbms_aqadm_syscalls.kwqa_3gl_revoke( owner IN VARCHAR2, queue_name IN VARCHAR2, grantee IN VARCHAR2, privilege IN BINARY_INTEGER, is_syspriv IN BOOLEAN, grantor IN VARCHAR2);

TBD

KWQA_3GL_SCHEDULETMSERVICE

Undocumented dbms_aqadm_syscalls.kwqa_3gl_scheduletmservice( qt_objn IN NUMBER, owner_instance IN BINARY_INTEGER);

TBD

KWQA_3GL_SETMSGWAIT

Undocumented dbms_aqadm_syscalls.kwqa_3gl_setmsgwait(procname IN VARCHAR2);

TBD

KWQA_3GL_SETREGISTRATIONNAME

Undocumented dbms_aqadm_syscalls.kwqa_3gl_setregistrationname( regname OUT VARCHAR2, qschema IN VARCHAR2, qname IN VARCHAR2, dest IN VARCHAR2, delim IN VARCHAR2, destq IN BINARY_INTEGER);

TBD

KWQA_3GL_SETSTREAMSCAPTUREOFF

Undocumented dbms_aqadm_syscalls.kwqa_3gl_setstreamscaptureoff(capture_off IN BOOLEAN);

TBD

KWQA_3GL_SET_CLR_TABLE_FLAG

Undocumented dbms_aqadm_syscalls.kwqa_3gl_set_clr_table_flag( qt_schema IN VARCHAR2, qt_name IN VARCHAR2, flag IN BINARY_INTEGER);

TBD

KWQA_3GL_SET_PARAMS_IN_QKGL

Undocumented dbms_aqadm_syscalls.kwqa_3gl_set_params_in_qkgl( queue_schema IN VARCHAR2, queue_name IN VARCHAR2, param_name IN VARCHAR2, param_value IN NUMBER);

TBD

KWQA_3GL_SET_TABLE_STATS_LOCK

Undocumented dbms_aqadm_syscalls.kwqa_3gl_set_table_stats_lock( ownname IN VARCHAR2, objname IN VARCHAR2, objsubname IN VARCHAR2, dslckmode IN BINARY_INTEGER, cslckmode IN BINARY_INTEGER);

TBD

KWQA_3GL_SET_VIEW_FLAG

Undocumented dbms_aqadm_syscalls.kwqa_3gl_set_view_flag( view_schema IN VARCHAR2, view_name IN VARCHAR2);

TBD

KWQA_3GL_STARTQUEUE

Undocumented dbms_aqadm_syscalls.kwqa_3gl_startqueue( owner IN VARCHAR2, queue_name IN VARCHAR2, enqueue IN BOOLEAN, dequeue IN BOOLEAN);

TBD

KWQA_3GL_STOPQUEUE

Undocumented dbms_aqadm_syscalls.kwqa_3gl_stopqueue( owner IN VARCHAR2, queue_name IN VARCHAR2, enqueue IN BOOLEAN, dequeue IN BOOLEAN, wait IN BOOLEAN);

TBD

KWQA_3GL_STOP_MSG_FORWARDING

Undocumented dbms_aqadm_syscalls.kwqa_3gl_stop_msg_forwarding( schema IN VARCHAR2, qname IN VARCHAR2, queue_id IN BINARY_INTEGER, pdb IN BINARY_INTEGER, shard_id IN BINARY_INTEGER, subscriber_id IN BINARY_INTEGER, destination_inst_id IN BINARY_INTEGER);

TBD

KWQA_3GL_UNSET_PARAMS_IN_QKGL

Undocumented dbms_aqadm_syscalls.kwqa_3gl_unset_params_in_qkgl( queue_schema IN VARCHAR2, queue_name IN VARCHAR2, param_name IN VARCHAR2);

TBD

KWQA_3GL_UPDKGQM

Undocumented dbms_aqadm_syscalls.kwqa_3gl_updkgqm( qid IN NUMBER, qschema IN VARCHAR2, qname IN VARCHAR2, flow_control IN BINARY_INTEGER, op IN BINARY_INTEGER, force IN BOOLEAN);

TBD

KWQA_3GL_VALIDATEQUEUE

Undocumented dbms_aqadm_syscalls.kwqa_3gl_validatequeue( qt_schema IN VARCHAR2, q_name IN VARCHAR2);

TBD

SET_MAX_STREAMS_POOL

Undocumented dbms_aqadm_syscalls.set_max_streams_pool(value IN NUMBER);

TBD

SET_MIN_STREAMS_POOL

Undocumented dbms_aqadm_syscalls.set_min_streams_pool(value IN NUMBER);

TBD

SET_WATERMARK

Undocumented dbms_aqadm_syscalls.set_watermark(wmvalue IN NUMBER);

TBD