Oracle | DBMS

Oracle DBMS_AWRHUB 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 AWR Server Host Utilities

Procedures cannot be replicated by LogMiner via regular DML/DDL apply (replication of SYS schema is not supported) nor using 'Procedural replication' (re-invoking the procedure at the logical standby produce different results).

AUTHID CURRENT_USER

Dependencies

DBMS_AWRHUB_SERVER	DBMS_AWRWH_LIB	DBMS_REPLAYHUB
DBMS_AWRHUB_SOURCE

Documented No

Pragmas PRAGMA SUPPLEMENTAL_LOG_DATA(default, UNSUPPORTED);

First Available 21c

Security Model Owned by SYS with EXECUTE granted to the DBA role.

Source {ORACLE_HOME}/rdbms/admin/dbmsawr.sql

Subprograms

ADD_SERVER_MAILBOX	ENABLE_CLOUD_ACCESS	SETUP_CLOUD_ACCESS
CREATE_SERVER	MODIFY_HUB_SETTINGS	SETUP_SERVER_CACHE_MAILBOX
DISABLE_CLOUD_ACCESS	MODIFY_SOURCE_SETTINGS	SETUP_SOURCE_CACHE_MAILBOX
DROP_SERVER	REGISTER_SOURCE	UNREGISTER_SOURCE

ADD_SERVER_MAILBOX (new 23ai)

Adds a mailbox that can be used by the AHub Server dbms_awrhub.add_server_mailbox( hub_name IN VARCHAR2, hub_mailbox IN VARCHAR2, mailbox_type IN VARCHAR2 DEFAULT 'FILE_SYSTEM', mailbox_cred IN VARCHAR2 DEFAULT NULL);

TBD

CREATE_SERVER

Designates the database it runs on as an AWRHub server that will store AWR data uploaded by its sources dbms_awrhub.create_server( hub_name IN VARCHAR2, hub_mailbox IN VARCHAR2, mailbox_type IN VARCHAR2 DEFAULT 'FILE_SYSTEM', mailbox_cred IN VARCHAR2 DEFAULT NULL, cred_owner IN VARCHAR2 DEFAULT NULL);

exec dbms_awrhub.create_server('UWAWRHUB', 'AWR_HUB_MAIL');

DISABLE_CLOUD_ACCESS (new 23ai)

Disable the specified Cloud access method dbms_awrhub.disable_cloud_access(access_method IN VARCHAR2);

TBD

DROP_SERVER

Drops the previously created server dbms_awrhub.drop_server(hub_name IN VARCHAR2 DEFAULT NULL);

exec dbms_awrhub.drop_server('UWAWRHUB');

ENABLE_CLOUD_ACCESS (new 23ai)

Enables the specified access method to be used by AWRHub to transfer files between the local File System and an Oracle Object Store dbms_awrhub.enable_cloud_access(access_method IN VARCHAR2); Options: 'built_in_cloud_access' and 'custom_cloud_access'

exec dbms_awrhub.enable_cloud_access('built_in_cloud_access');

MODIFY_HUB_SETTINGS (new 23ai)

Modifies the settings of the specified Hub dbms_awrhub.modify_hub_settings( hub_name IN VARCHAR2, sweep_interval IN NUMBER DEFAULT NULL, dflt_upload_snap_cnt IN NUMBER DEFAULT NULL, dflt_hub_retention IN NUMBER DEFAULT NULL, dflt_hub_tablespace IN VARCHAR2 DEFAULT NULL, num_conc_imp IN NUMBER DEFAULT NULL, max_run_time IN NUMBER DEFAULT NULL, consumer_group IN VARCHAR2 DEFAULT NULL);

TBD

MODIFY_SOURCE_SETTINGS (new 23ai)

Modifies settings of the hub services for the specified Source DB dbms_awrhub.modify_source_settings( hub_name IN VARCHAR2, source_name IN VARCHAR2, hub_service IN VARCHAR2 DEFAULT 'SNAPSHOT', upload_snap_cnt IN NUMBER DEFAULT NULL, hub_retention IN NUMBER DEFAULT NULL, hub_tablespace IN VARCHAR2 DEFAULT NULL);

TBD

REGISTER_SOURCE

Configures the database where it runs as an AWRHub source of the specified hub dbms_awrhub.register_source( hub_name IN VARCHAR2, source_name IN VARCHAR2 DEFAULT NULL, hub_mailbox IN VARCHAR2, mailbox_type IN VARCHAR2 DEFAULT 'FILE_SYSTEM', mailbox_cred IN VARCHAR2 DEFAULT NULL, cred_owner IN VARCHAR2 DEFAULT NULL);

exec dbms_awrhub.register_source('UWAWRHUB', NULL, 'AWR_HUB_MAIL');

SETUP_CLOUD_ACCESS (new 23ai)

Configures a cloud access method that can be used by AWRHub to transfer files between a local File System and the Oracle Object Store dbms_awrhub.setup_cloud_access( access_method IN VARCHAR2, exec_path IN VARCHAR2 DEFAULT NULL, remote_user IN VARCHAR2 DEFAULT NULL, remote_machine IN VARCHAR2 DEFAULT NULL);

TBD

SETUP_SERVER_CACHE_MAILBOX

Setups up a cache mailbox for AWRHub source. A source cache mailbox is a temporary location for mail packages to be put in before exported to the hub mailbox. dbms_awrhub.setup_source_cache_mailbox( hub_name IN VARCHAR2, cache_mailbox IN VARCHAR2 DEFAULT NULL);

exec dbms_awrhub.setup_source_cache_mailbox('UWAWRHUB');

SETUP_SOURCE_CACHE_MAILBOX (new 23ai parameter)

Setups a cache mailbox for AWRHub source. A source cache mailbox is a temporary location for mail packages to be put in before exported to the hub mailbox dbms_awrhub.setup_server_cache_mailbox( hub_name IN VARCHAR2, source_name IN VARCHAR2 DEFAULT NULL, cache_mailbox IN VARCHAR2 DEFAULT NULL);

exec dbms_awrhub.setup_server_cache_mailbox('UWAWRHUB');

UNREGISTER_SOURCE

Unregisters a source from an AWRHub dbms_awrhub.unregister_source( hub_name IN VARCHAR2 DEFAULT NULL, source_name IN VARCHAR2 DEFAULT NULL);

exec dbms_awrhub.unregister_source('UWAWRHUB');