Oracle8i Supplied Packages Reference
Release 8.1.5
A68001-01

Contents

Title and Copyright Information

Send Us Your Comments

Preface

1 Oracle Supplied Packages

Package Overview

Using Oracle Supplied Packages

Creating New Packages

Referencing Package Contents

List of Oracle Supplied Packages

Subprograms in Supplemental Packages

2 DBMS_ALERT

Summary of Subprograms

REGISTER procedure

REMOVE procedure

REMOVEALL procedure

SET_DEFAULTS procedure

SIGNAL procedure

WAITANY procedure

WAITONE procedure

3 DBMS_APPLICATION_INFO

Summary of Subprograms

SET_MODULE procedure

SET_ACTION procedure

READ_MODULE procedure

SET_CLIENT_INFO procedure

READ_CLIENT_INFO procedure

SET_SESSION_LONGOPS procedure

4 DBMS_AQ

Enumerated Constants

Data Structures

Summary of Subprograms

ENQUEUE procedure

DEQUEUE procedure

LISTEN procedure

5 DBMS_AQADM

Enumerated Constants

6 DBMS_DDL

Summary of Subprograms

ALTER_COMPILE procedure

ANALYZE_OBJECT procedure

7 DBMS_DEBUG

Using DBMS_DEBUG

8 DBMS_DEFER

Summary of Subprograms

COMMIT_WORK procedure

datatype_ARG procedure

TRANSACTION procedure

9 DBMS_DEFER_QUERY

Summary of Subprograms

GET_ARG_FORM function

GET_ARG_TYPE function

GET_CALL_ARGS procedure

GET_datatype_ARG function

10 DBMS_DEFER_SYS

Summary of Subprograms

ADD_DEFAULT_DEST procedure

DELETE_DEFAULT_DEST procedure

DELETE_DEF_DESTINATION procedure

DELETE_ERROR procedure

DELETE_TRAN procedure

DISABLED function

EXCLUDE_PUSH function

EXECUTE_ERROR procedure

EXECUTE_ERROR_AS_USER procedure

REGISTER_PROPAGATOR procedure

SCHEDULE_PURGE procedure

SCHEDULE_PUSH procedure

SET_DISABLED procedure

UNREGISTER_PROPAGATOR procedure

UNSCHEDULE_PURGE procedure

UNSCHEDULE_PUSH procedure

11 DBMS_DESCRIBE

Summary of Subprograms

DESCRIBE_PROCEDURE procedure

12 DBMS_DISTRIBUTED_TRUST_ADMIN

Summary of Subprograms

ALLOW_ALL procedure

ALLOW_SERVER procedure

DENY_ALL procedure

DENY_SERVER procedure

13 DBMS_HS

Summary of Subprograms

ALTER_BASE_CAPS procedure

ALTER_BASE_DD procedure

ALTER_CLASS_CAPS procedure

ALTER_CLASS_DD procedure

ALTER_CLASS_INIT procedure

ALTER_FDS_CLASS procedure

ALTER_FDS_INST procedure

ALTER_INST_CAPS procedure

ALTER_INST_DD procedure

ALTER_INST_INIT procedure

COPY_CLASS procedure

COPY_INST procedure

CREATE_BASE_CAPS procedure

CREATE_BASE_DD procedure

CREATE_CLASS_CAPS procedure

CREATE_CLASS_DD procedure

CREATE_CLASS_INIT procedure

CREATE_FDS_CLASS procedure

CREATE_FDS_INST procedure

CREATE_INST_CAPS procedure

CREATE_INST_DD procedure

CREATE_INST_INIT procedure

DROP_BASE_CAPS procedure

DROP_BASE_DD procedure

DROP_CLASS_CAPS procedure

DROP_CLASS_DD procedure

DROP_CLASS_INIT procedure

DROP_FDS_CLASS procedure

DROP_FDS_INST procedure

DROP_INST_CAPS procedure

DROP_INST_DD procedure

DROP_INST_INIT procedure

REPLACE_BASE_CAPS procedure

REPLACE_BASE_DD procedure

REPLACE_CLASS_CAPS procedure

REPLACE_CLASS_DD procedure

REPLACE_CLASS_INIT procedure

REPLACE_FDS_CLASS procedure

REPLACE_FDS_INST procedure

REPLACE_INST_CAPS procedure

REPLACE_INST_DD procedure

REPLACE_INST_INIT procedure

14 DBMS_HS_PASSTHROUGH

Summary of Subprograms

BIND_VARIABLE procedure

BIND_VARIABLE_RAW procedure

BIND_OUT_VARIABLE procedure

BIND_OUT_VARIABLE_RAW procedure

BIND_INOUT_VARIABLE procedure

BIND_INOUT_VARIABLE_RAW procedure

CLOSE_CURSOR procedure

EXECUTE_IMMEDIATE procedure

EXECUTE_NON_QUERY function

FETCH_ROW function

GET_VALUE procedure

GET_VALUE_RAW procedure

OPEN_CURSOR function

PARSE procedure

15 DBMS_IOT

Summary of Subprograms

BUILD_CHAIN_ROWS_TABLE procedure

BUILD_EXCEPTIONS_TABLE procedure

16 DBMS_JOB

Summary of Subprograms

SUBMIT procedure

REMOVE procedure

CHANGE procedure

NEXT_DATE procedure

INSTANCE procedure

INTERVAL procedure

BROKEN procedure

USER_EXPORT procedure

USER_EXPORT procedure

17 DBMS_LOB

Rules and Limitations

BFILE-Specific Rules and Limitations

Temporary LOBs Usage Notes

Temporary LOB Exceptions

18 DBMS_LOCK

Viewing and Monitoring Locks

Summary of Subprograms

ALLOCATE_UNIQUE procedure

REQUEST function

CONVERT function

RELEASE function

SLEEP procedure

19 DBMS_LOGMNR

Using the LogMiner

Using Place Holder Columns

Summary of Subprograms

ADD_LOGFILE procedure

START_LOGMNR procedure

END_LOGMNR procedure

20 DBMS_LOGMNR_D

Creating a Dictionary File

Summary of Subprograms

BUILD procedure

21 DBMS_OFFLINE_OG

Summary of Subprograms

BEGIN_INSTANTIATION procedure

BEGIN_LOAD procedure

END_INSTANTIATION procedure

END_LOAD procedure

RESUME_SUBSET_OF_MASTERS procedure

22 DBMS_OFFLINE_SNAPSHOT

Summary of Subprograms

BEGIN_LOAD procedure

END_LOAD procedure

23 DBMS_OLAP

Summary of Subprograms

ESTIMATE_SUMMARY_SIZE procedure

EVALUATE_UTILIZATION procedure

EVALUATE_UTILIZATION_W procedure

RECOMMEND_MV procedure

RECOMMEND_MV_W procedure

VALIDATE_DIMENSION procedure

DBMS_OLAP Interface Tables

24 DBMS_ORACLE_TRACE_AGENT

Summary of Subprograms

SET_ORACLE_TRACE_IN_SESSION procedure

25 DBMS_ORACLE_TRACE_USER

Summary of Subprograms

SET_ORACLE_TRACE procedure

26 DBMS_OUTPUT

Using DBMS_OUTPUT

Summary of Subprograms

ENABLE procedure

DISABLE procedure

PUT and PUT_LINE procedures

NEW_LINE procedure

GET_LINE and GET_LINES procedures

27 DBMS_PCLXUTIL

Using DBMS_PCLXUTIL

Summary of Subprograms

BUILD_PART_INDEX procedure

28 DBMS_PIPE

Summary of Subprograms

CREATE_PIPE function

PACK_MESSAGE procedure

SEND_MESSAGE function

RECEIVE_MESSAGE function

NEXT_ITEM_TYPE function

UNPACK_MESSAGE procedure

REMOVE_PIPE function

PURGE procedure

RESET_BUFFER procedure

UNIQUE_SESSION_NAME function

29 DBMS_PROFILER

Using DBMS_PROFILER

Summary of Subprograms

START_PROFILER function

STOP_PROFILER function

FLUSH_DATA function

GET_VERSION procedure

INTERNAL_VERSION_CHECK function

30 DBMS_RANDOM

Summary of Subprograms

INITIALIZE procedure

RANDOM function

TERMINATE procedure

31 DBMS_RECTIFIER_DIFF

Summary of Subprograms

DIFFERENCES procedure

RECTIFY procedure

32 DBMS_REFRESH

Summary of Subprograms

CHANGE procedure

DESTROY procedure

REFRESH procedure

SUBTRACT procedure

33 DBMS_REPAIR

Enumeration Types

Summary of Subprograms

ADMIN_TABLES procedure

CHECK_OBJECT procedure

DUMP_ORPHAN_KEYS procedure

FIX_CORRUPT_BLOCKS procedure

REBUILD_FREELISTS procedure

SKIP_CORRUPT_BLOCKS procedure

34 DBMS_REPCAT

Summary of Subprograms

ADD_GROUPED_COLUMN procedure

ADD_MASTER_DATABASE procedure

ADD_PRIORITY_datatype procedure

ADD_SITE_PRIORITY_SITE procedure

ADD_conflicttype_RESOLUTION procedure

ALTER_MASTER_PROPAGATION procedure

ALTER_MASTER_REPOBJECT procedure

ALTER_PRIORITY procedure

ALTER_PRIORITY_datatype procedure

ALTER_SITE_PRIORITY procedure

ALTER_SITE_PRIORITY_SITE procedure

ALTER_SNAPSHOT_PROPAGATION procedure

CANCEL_STATISTICS procedure

COMMENT_ON_COLUMN_GROUP procedure

COMMENT_ON_PRIORITY_GROUP/PRIORITY procedure

COMMENT_ON_REPGROUP procedure

COMMENT_ON_REPSITES procedure

COMMENT_ON_REPOBJECT procedure

COMMENT_ON_conflicttype_RESOLUTION procedure

COMPARE_OLD_VALUES procedure

CREATE_MASTER_REPGROUP procedure

CREATE_MASTER_REPOBJECT procedure

CREATE_SNAPSHOT_REPGROUP procedure

CREATE_SNAPSHOT_REPOBJECT procedure

DEFINE_COLUMN_GROUP procedure

DEFINE_PRIORITY_GROUP procedure

DEFINE_SITE_PRIORITY procedure

DO_DEFERRED_REPCAT_ADMIN procedure

DROP_COLUMN_GROUP procedure

DROP_GROUPED_COLUMN procedure

DROP_MASTER_REPGROUP procedure

DROP_MASTER_REPOBJECT procedure

DROP_PRIORITY procedure

DROP_PRIORITY_GROUP procedure

DROP_PRIORITY_datatype procedure

DROP_SITE_PRIORITY procedure

DROP_SITE_PRIORITY_SITE procedure

DROP_SNAPSHOT_REPGROUP procedure

DROP_SNAPSHOT_REPOBJECT procedure

DROP_conflicttype_RESOLUTION procedure

EXECUTE_DDL procedure

GENERATE_REPLICATION_SUPPORT procedure

GENERATE_SNAPSHOT_SUPPORT procedure

MAKE_COLUMN_GROUP procedure

PURGE_MASTER_LOG procedure

PURGE_STATISTICS procedure

REFRESH_SNAPSHOT_REPGROUP procedure

REGISTER_SNAPSHOT_REPGROUP procedure

REGISTER_STATISTICS procedure

RELOCATE_MASTERDEF procedure

REMOVE_MASTER_DATABASES procedure

REPCAT_IMPORT_CHECK procedure

RESUME_MASTER_ACTIVITY procedure

SEND_OLD_VALUES procedure

SET_COLUMNS procedure

SUSPEND_MASTER_ACTIVITY procedure

SWITCH_SNAPSHOT_MASTER procedure

UNREGISTER_SNAPSHOT_REPGROUP procedure

VALIDATE function

WAIT_MASTER_LOG procedure

35 DBMS_REPCAT_ADMIN

Summary of Subprograms

GRANT_ADMIN_ANY_SCHEMA procedure

GRANT_ADMIN_SCHEMA procedure

REGISTER_USER_REPGROUP procedure

REVOKE_ADMIN_ANY_SCHEMA procedure

REVOKE_ADMIN_SCHEMA procedure

UNREGISTER_USER_REPGROUP procedure

36 DBMS_REPCAT_INSTANTIATE

Summary of Subprograms

DROP_SITE_INSTANTIATION procedure

INSTANTIATE_OFFLINE procedure

INSTANTIATE_ONLINE procedure

37 DBMS_REPCAT_RGT

Summary of Subprograms

ALTER_REFRESH_TEMPLATE procedure

ALTER_TEMPLATE_OBJECT procedure

ALTER_TEMPLATE_PARM procedure

ALTER_USER_AUTHORIZATION procedure

ALTER_USER_PARM_VALUE procedure

COMPARE_TEMPLATES function

COPY_TEMPLATE function

CREATE_OBJECT_FROM_EXISTING function

CREATE_REFRESH_TEMPLATE function

CREATE_TEMPLATE_OBJECT function

CREATE_TEMPLATE_PARM function

CREATE_USER_AUTHORIZATION function

CREATE_USER_PARM_VALUE function

DELETE_RUNTIME_PARMS procedure

DROP_ALL_OBJECTS procedure

DROP_ALL_TEMPLATE_PARMS procedure

DROP_ALL_TEMPLATE_SITES procedure

DROP_ALL_TEMPLATES procedure

DROP_ALL_USER_AUTHORIZATIONS procedure

DROP_ALL_USER_PARM_VALUES procedure

DROP_REFRESH_TEMPLATE procedure

DROP_SITE_INSTANTIATION procedure

DROP_TEMPLATE_OBJECT procedure

DROP_TEMPLATE_PARM procedure

DROP_USER_AUTHORIZATION procedure

DROP_USER_PARM_VALUE procedure

GET_RUNTIME_PARM_ID function

INSERT_RUNTIME_PARMS procedure

INSTANTIATE_OFFLINE function

INSTANTIATE_ONLINE function

LOCK_TEMPLATE_EXCLUSIVE procedure

LOCK_TEMPLATE_SHARED procedure

38 DBMS_REPUTIL

Summary of Subprograms

REPLICATION_OFF procedure

REPLICATION_ON procedure

REPLICATION_IS_ON function

FROM_REMOTE function

GLOBAL_NAME function

39 DBMS_RESOURCE_MANAGER

Summary of Subprograms

CREATE_PLAN procedure

UPDATE_PLAN procedure

DELETE_PLAN procedure

DELETE_PLAN_CASCADE procedure

CREATE_CONSUMER_GROUP procedure

UPDATE_CONSUMER_GROUP procedure

DELETE_CONSUMER_GROUP procedure

CREATE_PLAN_DIRECTIVE procedure

UPDATE_PLAN_DIRECTIVE procedure

DELETE_PLAN_DIRECTIVE procedure

CREATE_PENDING_AREA procedure

VALIDATE_PENDING_AREA procedure

CLEAR_PENDING_AREA procedure

SUBMIT_PENDING_AREA procedure

SET_INITIAL_CONSUMER_GROUP procedure

SWITCH_CONSUMER_GROUP_FOR_SESS procedure

SWITCH_CONSUMER_GROUP_FOR_USER procedure

40 DBMS_RESOURCE_MANAGER_PRIVS

Summary of Subprograms

GRANT_SYSTEM_PRIVILEGE procedure

REVOKE_SYSTEM_PRIVILEGE procedure

GRANT_SWITCH_CONSUMER_GROUP procedure

REVOKE_SWITCH_CONSUMER_GROUP procedure

41 DBMS_RLS

Dynamic Predicates

Summary of Subprograms

ADD_POLICY procedure

DROP_POLICY procedure

REFRESH_POLICY procedure

ENABLE_POLICY procedure

42 DBMS_ROWID

Summary of Subprograms

ROWID_CREATE function

ROWID_INFO procedure

ROWID_TYPE function

ROWID_OBJECT function

ROWID_RELATIVE_FNO function

ROWID_BLOCK_NUMBER function

ROWID_ROW_NUMBER function

ROWID_TO_ABSOLUTE_FNO function

ROWID_TO_EXTENDED function

ROWID_TO_RESTRICTED function

ROWID_VERIFY function

43 DBMS_SESSION

Summary of Subprograms

SET_ROLE procedure

SET_SQL_TRACE procedure

SET_NLS procedure

CLOSE_DATABASE_LINK procedure

RESET_PACKAGE procedure

UNIQUE_SESSION_ID function

IS_ROLE_ENABLED function

IS_SESSION_ALIVE function

SET_CLOSE_CACHED_OPEN_CURSORS procedure

FREE_UNUSED_USER_MEMORY procedure

SET_CONTEXT procedure

LIST_CONTEXT procedure

SWITCH_CURRENT_CONSUMER_GROUP procedure

44 DBMS_SHARED_POOL

Installation Notes

Summary of Subprograms

SIZES procedure

UNKEEP procedure

ABORTED_REQUEST_THRESHOLD procedure

45 DBMS_SNAPSHOT

Summary of Subprograms

BEGIN_TABLE_REORGANIZATION procedure

END_TABLE_REORGANIZATION

I_AM_A_REFRESH function

PURGE_DIRECT_LOAD_LOG procedure

PURGE_LOG procedure

PURGE_SNAPSHOT_FROM_LOG procedure

REFRESH procedure

REFRESH_ALL_MVIEWS procedure

REFRESH_DEPENDENT procedure

REGISTER_SNAPSHOT procedure

UNREGISTER_SNAPSHOT procedure

46 DBMS_SPACE

Summary of Subprograms

UNUSED_SPACE procedure

FREE_BLOCKS procedure

47 DBMS_SPACE_ADMIN

Summary of Subprograms

SEGMENT_VERIFY procedure

SEGMENT_CORRUPT procedure

SEGMENT_DROP_CORRUPT procedure

SEGMENT_DUMP procedure

TABLESPACE_VERIFY procedure

TABLESPACE_FIX_BITMAPS procedure

TABLESPACE_REBUILD_BITMAPS procedure

TABLESPACE_REBUILD_QUOTAS procedure

TABLESPACE_MIGRATE_FROM_LOCAL procedure

48 DBMS_SQL

49 DBMS_STATS

Using DBMS_STATS

Summary of Subprograms

Setting or Getting Statistics

PREPARE_COLUMN_VALUES procedure

SET_COLUMN_STATS procedure

SET_INDEX_STATS procedure

SET_TABLE_STATS procedure

CONVERT_RAW_VALUE procedure

GET_COLUMN_STATS procedure

GET_INDEX_STATS procedure

GET_TABLE_STATS procedure

DELETE_COLUMN_STATS procedure

DELETE_INDEX_STATS procedure

DELETE_TABLE_STATS procedure

DELETE_SCHEMA_STATS procedure

DELETE_DATABASE_STATS procedure

Transferring Statistics

CREATE_STAT_TABLE procedure

DROP_STAT_TABLE procedure

EXPORT_COLUMN_STATS procedure

EXPORT_INDEX_STATS procedure

EXPORT_TABLE_STATS procedure

EXPORT_SCHEMA_STATS procedure

EXPORT_DATABASE_STATS procedure

IMPORT_COLUMN_STATS procedure

IMPORT_INDEX_STATS procedure

IMPORT_TABLE_STATS procedure

IMPORT_SCHEMA_STATS procedure

IMPORT_DATABASE_STATS procedure

Gathering Optimizer Statistics

GATHER_INDEX_STATS procedure

GATHER_TABLE_STATS procedure

GATHER_SCHEMA_STATS procedure

GATHER_DATABASE_STATS procedure

GENERATE_STATS procedure

50 DBMS_TRACE

Using DBMS_TRACE

Summary of Subprograms

SET_PLSQL_TRACE procedure

CLEAR_PLSQL_TRACE procedure

PLSQL_TRACE_VERSION procedure

51 DBMS_TRANSACTION

Summary of Subprograms

READ_ONLY procedure

READ_WRITE procedure

ADVISE_ROLLBACK procedure

ADVISE_NOTHING procedure

ADVISE_COMMIT procedure

USE_ROLLBACK_SEGMENT procedure

COMMIT_COMMENT procedure

COMMIT_FORCE procedure

COMMIT procedure

SAVEPOINT procedure

ROLLBACK procedure

ROLLBACK_SAVEPOINT procedure

ROLLBACK_FORCE procedure

BEGIN_DISCRETE_TRANSACTION procedure

PURGE_MIXED procedure

PURGE_LOST_DB_ENTRY procedure

LOCAL_TRANSACTION_ID function

STEP_ID function

52 DBMS_TTS

Summary of Subprograms

TRANSPORT_SET_CHECK procedure

DOWNGRADE procedure

53 DBMS_UTILITY

54 DEBUG_EXTPROC

Installation Notes

Using DEBUG_EXTPROC

Summary of Subprograms

STARTUP_EXTPROC_AGENT procedure

55 OUTLN_PKG

Summary of Subprograms

DROP_UNUSED procedure

DROP_BY_CAT procedure

UPDATE_BY_CAT procedure

56 UTL_COLL

Summary of Subprograms

IS_LOCATOR function

57 UTL_FILE

File Ownership and Protections

Examples (UNIX-Specific)

Summary of Subprograms

IS_OPEN function

FCLOSE procedure

FCLOSE_ALL procedure

GET_LINE procedure

NEW_LINE procedure

PUT_LINE procedure

FFLUSH procedure

58 UTL_HTTP

Summary of Subprograms

REQUEST function

REQUEST_PIECES function

59 UTL_RAW

Summary of Subprograms

CONCAT function

CAST_TO_RAW function

CAST_TO_VARCHAR2 function

LENGTH function

SUBSTR function

TRANSLATE function

TRANSLITERATE function

OVERLAY function

COPIES function

XRANGE function

REVERSE function

COMPARE function

CONVERT function

BIT_AND function

BIT_OR function

BIT_XOR function

BIT_COMPLEMENT function

60 UTL_REF

Summary of Subprograms

SELECT_OBJECT procedure

LOCK_OBJECT procedure

UPDATE_OBJECT procedure

DELETE_OBJECT procedure

Index

Copyright © 1999 Oracle Corporation.
All Rights Reserved.