Oracle | DBMS_WORKLOAD_REPOSITORY

Oracle DBMS_WORKLOAD_REPOSITORY_DEF Version 26ai

General Information

Library Note

Morgan's Library Page Header

The best Oracle News for FY2026

Oracle Database 26ai is now availble. If you haven't you downloaded already: Why?

Purpose Undocumented

AUTHID DEFINER

Data Types TYPE OUTPUT_TABLE_DEF IS ...;

Dependencies 3

AWRRPT_INSTANCE_LIST_TYPE	DBMS_SRF_LIB	DBMS_UMF_PROTECTED
DBMS_ASH_INTERNAL	DBMS_SWRF_REPORT_INTERNAL	DBMS_WORKLOAD_REPOSITORY
DBMS_ASSERT	DBMS_SYSTEM	PLITBLM
DBMS_REPORT	DBMS_SYS_ERROR	WRM$_WR_CONTROL
DBMS_STANDARD	DBMS_UMF	XMLTYPE
DBMS_SWRF_INTERNAL

Documented No

First Available 23ai

Security Model Owned by SYS with no privileges granted.

Access to the subprograms in this package is restricted by an Accessible By clause.

Source {ORACLE_HOME}/rdbms/admin/prvsawrdef.plb
{ORACLE_HOME}/rdbms/admin/prvtawr.plb

Subprograms

ADD_COLORED_APPLICATION	DROP_BASELINE	MODIFY_SNAPSHOT_SETTINGS
ADD_COLORED_SQL	DROP_BASELINE_TEMPLATE	MODIFY_TABLE_QUOTA
ASH_REPORT_ANALYTICS	DROP_SNAPSHOT_RANGE	MODIFY_TABLE_SETTINGS
ASH_REPORT_HTML	ENABLE_AWRAPP_SNAPSHOT	PURGE_SQL_DETAILS
ASH_REPORT_TEXT	ENABLE_SNAPSHOT_SERVICE	REGISTER_DATABASE
AWR_SET_REPORT_THRESHOLDS	EXCLUDE_APPMAP	REGISTER_REMOTE_DATABASE
CONTROL_RESTRICTED_SNAPSHOT	GET_AWR_ID	REMOVE_COLORED_SQL
CREATE_BASELINE	GET_AWR_VIEW_NAME_BY_LOCATION	RENAME_BASELINE
CREATE_BASELINE_TEMPLATE	INCLUDE_APPMAP	SET_REPORT_SECTIONS
CREATE_REMOTE_SNAPSHOT	IS_AUTOMATIC_SNAPSHOT_ENABLED	UNREGISTER_DATABASE
CREATE_SNAPSHOT	LOCAL_AWR_DBID	UNREGISTER_REMOTE_DATABASE
DEFINE_APPLICATION	MODIFY_AWREXP_SETTINGS	UPDATE_DATAFILE_INFO
DISABLE_AWRAPP_SNAPSHOT	MODIFY_BASELINE_WINDOW_SIZE	UPDATE_OBJECT_INFO

ADD_COLORED_APPLICATION (new 23ai)

Undocumented dbms_workload_repository_def.add_colored_application( dbid IN NUMBER, app_name IN VARCHAR2);

TBD

ADD_COLORED_SQL (new 23ai)

Undocumented dbms_workload_repository_def.add_colored_sql( sql_id IN VARCHAR2, dbid IN NUMBER);

TBD

ASH_REPORT_ANALYTICS (new 23ai)

Undocumented dbms_workload_repository_def.ash_report_analytics( dbid IN NUMBER, inst_id IN NUMBER, begin_time IN DATE, end_time IN DATE, report_level IN VARCHAR2, filter_list IN VARCHAR2) RETURN CLOB;

TBD

ASH_REPORT_HTML (new 23ai)

Undocumented dbms_workload_repository_def.ash_report_html( l_dbid IN NUMBER, l_inst_num IN NUMBER, l_btime IN DATE, l_etime IN DATE, l_options IN NUMBER, l_slot_width IN NUMBER, l_sid IN NUMBER, l_sql_id IN VARCHAR2, l_wait_class IN VARCHAR2, l_service_hash IN NUMBER, l_module IN VARCHAR2, l_action IN VARCHAR2, l_client_id IN VARCHAR2, l_plsql_entry IN VARCHAR2, l_data_src IN NUMBER, l_container IN VARCHAR2) RETURN sys.dbms_workload_repository_def.output_table_def;

TBD

ASH_REPORT_TEXT (new 23ai)

Undocumented dbms_workload_repository_def.ash_report_text( l_dbid IN NUMBER, l_inst_num IN NUMBER, l_btime IN DATE, l_etime IN DATE, l_options IN NUMBER, l_slot_width IN NUMBER, l_sid IN NUMBER, l_sql_id IN VARCHAR2, l_wait_class IN VARCHAR2, l_service_hash IN NUMBER, l_module IN VARCHAR2, l_action IN VARCHAR2, l_client_id IN VARCHAR2, l_plsql_entry IN VARCHAR2, l_data_src IN NUMBER, l_container IN VARCHAR2) RETURN sys.dbms_workload_repository_def.output_table_def;

TBD

AWR_SET_REPORT_THRESHOLDS (new 23ai)

Undocumented dbms_workload_repository_def.awr_set_report_tresholds( top_n_events IN NUMBER, top_n_files IN NUMBER, top_n_segments IN NUMBER, top_n_services IN NUMBER, top_n_sql IN NUMBER, top_n_sql_max IN NUMBER, top_sql_pct IN NUMBER, shmem_threshold IN NUMBER, versions_threshold IN NUMBER, top_n_disks IN NUMBER, outlier_pct IN NUMBER, outlier_cpu_pct IN NUMBER);

TBD

CONTROL_RESTRICTED_SNAPSHOT (new 23ai)

Undocumented dbms_workload_repository_def.control_restricted_snapshot(allow IN BOOLEAN);

exec dbms_workload_repository_def.control_restricted_snapshot(TRUE);

CREATE_BASELINE (new 23ai)

Undocumented

Overload 1 dbms_workload_repository_def.create_baseline( start_snap_id IN NUMBER, end_snap_id IN NUMBER, baseline_name IN VARCHAR2, dbid IN NUMBER, expiration IN NUMBER);

TBD

Overload 2 dbms_workload_repository_def.create_baseline( start_snap_id IN NUMBER, end_snap_id IN NUMBER, baseline_name IN VARCHAR2, dbid IN NUMBER, expiration IN NUMBER) RETURN NUMBER;

TBD

Overload 3 dbms_workload_repository_def.create_baseline( start_time IN DATE, end_time IN DATE, baseline_name IN VARCHAR2, dbid IN NUMBER, expiration IN NUMBER);

TBD

Overload 4 dbms_workload_repository_def.create_baseline( start_time IN DATE, end_time IN DATE, baseline_name IN VARCHAR2, dbid IN NUMBER, expiration IN NUMBER) RETURN NUMBER;

TBD

CREATE_BASELINE_TEMPLATE (new 23ai)

Undocumented

Overload 1 dbms_workload_repository_def.create_baseline_template( start_time IN DATE, end_time IN DATE, baseline_name IN VARCHAR2, template_name IN VARCHAR2, expiration IN NUMBER, dbid IN NUMBER);

TBD

Overload 2 dbms_workload_repository_def.create_baseline_template( day_of_week IN VARCHAR2, hour_in_day IN NUMBER, duration IN NUMBER, start_time IN DATE, end_time IN DATE, baseline_name_prefix IN VARCHAR2, template_name IN VARCHAR2, expiration IN NUMBER, dbid IN NUMBER);

TBD

CREATE_REMOTE_SNAPSHOT (new 23ai)

Undocumented dbms_workload_repository_def.create_remote_snapshot( node_id IN NUMBER, flush_level IN VARCHAR2);

TBD

Overload 2 dbms_workload_repository_def.create_remote_snapshot( node_id IN NUMBER, flush_level IN VARCHAR2) RETURN NUMBER;

TBD

Overload 3 dbms_workload_repository_def.create_remote_snapshot( node_name IN VARCHAR2, topology_name IN VARCHAR2, flush_level IN VARCHAR2);

TBD

Overload 4 dbms_workload_repository_def.create_remote_snapshot( node_name IN VARCHAR2, topology_name IN VARCHAR2, flush_level IN VARCHAR2) RETURN NUMBER;

TBD

CREATE_SNAPSHOT (new 23ai)

Undocumented

Overload 1 dbms_workload_repository_def.create_snapshot( flush_level IN VARCHAR2, dbid IN NUMBER, source_name IN VARCHAR2, timeout_secs IN NUMBER)

TBD

Overload 2 dbms_workload_repository_def.create_snapshot( flush_level IN VARCHAR2, dbid IN NUMBER, source_name IN VARCHAR2, timeout_secs IN NUMBER) RETURN NUMBER;

TBD

DEFINE_APPLICATION (new 23ai)

Undocumented dbms_workload_repository_def.define_application( dbid IN NUMBER, app_name IN VARCHAR2, module_name IN VARCHAR2, action_name IN VARCHAR2);

TBD

DISABLE_AWRAPP_SNAPSHOT (new 23ai)

Undocumented dbms_workload_repository_def.disable_awrapp_snapshot(dbid IN NUMBER);

exec dbms_workload_repository_def.disable_awrapp_snapshot(

DROP_BASELINE (new 23ai)

Undocumented dbms_workload_repository_def.drop_baseline( baseline_name IN VARCHAR2, cascade IN BOOLEAN, dbid IN NUMBER);

TBD

DROP_BASELINE_TEMPLATE (new 23ai)

Undocumented dbms_workload_repository_def.drop_baseline_template( template_name IN VARCHAR2, dbid IN NUMBER);

TBD

DROP_SNAPSHOT_RANGE (new 23ai)

Undocumented dbms_workload_repository_def.drop_snapshot_range( low_snap_id IN NUMBER, high_snap_id IN NUMBER, dbid IN NUMBER);

TBD

ENABLE_AWRAPP_SNAPSHOT (new 23ai)

Undocumented dbms_workload_repository_def.enable_awrapp_snapshot(dbid IN NUMBER);

exec dbms_workload_repository_def.enable_awrapp_snapshot;

           *

      ORA-06553: PLS-904: insufficient privilege to access object DBMS_WORKLOAD_REPOSITORY_DEF

ENABLE_SNAPSHOT_SERVICE (new 23ai)

Undocumented dbms_workload_repository_def.enable_snapshot_service( dbid IN NUMBER, snap_type IN VARCHAR2, snap_action IN VARCHAR2);

TBD

EXCLUDE_APPMAP (new 23ai)

Undocumented dbms_workload_repository_def.exclude_appmap( dbid IN NUMBER, appmap_name IN VARCHAR2);

TBD

GET_AWR_ID (new 23ai)

Undocumented dbms_workload_repository_def.get_awr_id( hub_name IN VARCHAR2, source_name IN VARCHAR2) RETURN NUMBER;

TBD

GET_AWR_VIEW_NAME_BY_LOCATION (new 23ai)

Undocumented dbms_workload_repository_def.get_awr_view_name_by_location( dba_hist_view_name IN VARCHAR2, awr_location IN VARCHAR2) RETURN VARCHAR2;

TBD

INCLUDE_APPMAP (new 23ai)

Undocumented dbms_workload_repository_def.include_appmap( dbid IN NUMBER, appmap_name IN VARCHAR2);

TBD

IS_AUTOMATIC_SNAPSHOT_ENABLED (new 23ai)

Undocumented dbms_workload_repository_def.is_automatic_snapshot_enabled RETURN BOOLEAN;

BEGIN

        IF dbms_workload_repository_def.is_automatic_snapshot_enabled THEN

          dbms_output.put_line('T');

        ELSE

          dbms_output.put_line('F');

        END IF;

      END;

      /

      *

      ORA-06553: PLS-904: insufficient privilege to access object DBMS_WORKLOAD_REPOSITORY_DEF

LOCAL_AWR_DBID (new 23ai)

Undocumented dbms_workload_repository_def.local_awr_dbid RETURN NUMBER

SELECT dbms_workload_repository_def.local_awr_dbid;

      *

      ORA-06553: PLS-904: insufficient privilege to access object DBMS_WORKLOAD_REPOSITORY_DEF

MODIFY_AWREXP_SETTINGS (new 23ai)

Undocumented dbms_workload_repository_def.modify_awrexp_settings( dbid IN NUMBER, include_sqlmon_option IN VARCHAR2);

TBD

MODIFY_BASELINE_WINDOW_SIZE (new 23ai)

Undocumented dbms_workload_repository_def.modify_baseline_window_size( window_size IN NUMBER, dbid IN NUMBER);

TBD

MODIFY_SNAPSHOT_SETTINGS (new 23ai)

Undocumented

Overload 1 dbms_workload_repository_def.modify_snapshot_settings( retention IN NUMBER, interval IN NUMBER, topnsql IN NUMBER, dbid IN NUMBER, tablespace_name IN VARCHAR2, auto_purge IN BOOLEAN, emergency_snap IN BOOLEAN);

TBD

Overload 2 dbms_workload_repository_def.modify_snapshot_settings( retention IN NUMBER, interval IN NUMBER, topnsql IN VARCHAR2, dbid IN NUMBER, tablespace_name IN VARCHAR2, auto_purge IN BOOLEAN, emergency_snap IN BOOLEAN);

TBD

MODIFY_TABLE_QUOTA (new 23ai)

Undocumented dbms_workload_repository_def.modify_table_quota( table_name IN VARCHAR2, limit IN NUMBER, dbid IN NUMBER);

TBD

MODIFY_TABLE_SETTINGS (new 23ai)

Undocumented dbms_workload_repository_def.modify_table_settings( table_name IN VARCHAR2, dbid IN NUMBER, flush_level IN VARCHAR2);

TBD

PURGE_SQL_DETAILS (new 23ai)

Undocumented dbms_workload_repository_def.purge_sql_details( numrows IN NUMBER, dbid IN NUMBER);

TBD

REGISTER_DATABASE (new 23ai)

Undocumented dbms_workload_repository_def.register_database( dbid IN NUMBER, tablespace_name IN VARCHAR2);

TBD

REGISTER_REMOTE_DATABASE (new 23ai)

Undocumented

Overload 1 dbms_workload_repository_def.register_remote_database(node_name IN VARCHAR2);

TBD

Overload 2 dbms_workload_repository_def.register_remote_database( node_id IN NUMBER, topology_name IN VARCHAR2);

TBD

REMOVE_COLORED_SQL (new 23ai)

Undocumented dbms_workload_repository_def.remove_colored_sql( sql_id IN VARCHAR2, dbid IN NUMBER);

TBD

RENAME_BASELINE (new 23ai)

Undocumented dbms_workload_repository_def.rename_baseline( old_baseline_name IN VARCHAR2, new_baseline_name IN VARCHAR2, dbid IN NUMBER);

TBD

SET_REPORT_SECTIONS (new 23ai)

Undocumented dbms_workload_repository_def.set_report_sections( sec_title IN VARCHAR2, max_rows IN BINARY_INTEGER);

TBD

UNREGISTER_DATABASE (new 23ai)

Undocumented dbms_workload_repository_def.unregister_database( dbid IN NUMBER, remove_snapshot IN BOOLEAN);

TBD

UNREGISTER_REMOTE_DATABASE (new 23ai)

Undocumented

Overload 1 dbms_workload_repository_def.unregister_remote_database( node_id IN NUMBER, remote_check IN BOOLEAN);

TBD

Overload 2 dbms_workload_repository_def.unregister_remote_database( node_name IN VARCHAR2, topology_name IN VARCHAR2, remote_check IN BOOLEAN)

TBD

UPDATE_DATAFILE_INFO (new 23ai)

Undocumented dbms_workload_repository_def.update_datafile_info;

exec dbms_workload_repository_def.update_datafile_info;

           *

      PLS-00904: insufficient privilege to access object DBMS_WORKLOAD_REPOSITORY_DEF

UPDATE_OBJECT_INFO (new 23ai)

Undocumented dbms_workload_repository_def.update_object_info(maxrows IN NUMBER);

TBD