Oracle | DBMS

Oracle DBMS_DG 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 This package is the public interface for the Data Guard callable API.

AUTHID CURRENT_USER

Constants

Name	Data Type	Value
Wait Events
WAIT_PREDEFINED_MIN	PLS_INTEGER	1
WAIT_START_BROKER	PLS_INTEGER	1
WAIT_STOP_BROKER	PLS_INTEGER	2
WAIT_PREDEFINED_MAX	PLS_INTEGER	2

Dependencies

DBMS_DRS	GV$DATAGUARD_STATS	GV$FS_FAILOVER_HISTOGRAM
GV$DATAGUARD_CONFIG	GV$DATAGUARD_STATUS	GV$FS_FAILOVER_STATS

Documented Yes: Packages and Types Reference

Exceptions

Error Code	Reason
ORA-16646	Fast-Start Failover is disabled
ORA-16666	Unable to initiate Fast-Start Failover on a standby database
ORA-16817	Unsynchronized Fast-Start Failover configuration
ORA-16819	Fast-Start Failover observer not started
ORA-16820	Fast-Start Failover observer is no longer observing this database
ORA-16829	Lagging Fast-Start Failover configuration

First Available 11.1

Pragma PRAGMA SUPPLEMENTAL_LOG_DATA(default, READ_ONLY);
pragma TIMESTAMP('2012-01-26:08:55:00');

Security Model Owned by SYS with no privileges granted

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

Subprograms

ADD_DATABASE	REMOVE
ADD_FAR_SYNC	REMOVE_CONFIGURATION
ADD_RECOVERY_APPLIANCE	REMOVE_CONFIGURATION_TAG
CONVERT_TO_PHYSICAL	REMOVE_CONFIGURATION_TAG_ALL
CONVERT_TO_SNAPSHOT	REMOVE_INSTANCE
CREATE_CONFIGURATION	REMOVE_MEMBER_TAG
DISABLE	REMOVE_MEMBER_TAG_ALL
DISABLE_CONFIGURATION	RESET_CONFIGURATION_PROPERTY
DISABLE_FS_FAILOVER	RESET_PROPERTY
DISABLE_FS_FAILOVER_CONDITION	SET_CONFIGURATION_PROPERTY
ENABLE	SET_CONFIGURATION_TAG
ENABLE_CONFIGURATION	SET_MEMBER_TAG
ENABLE_FS_FAILOVER	SET_PROPERTY
ENABLE_FS_FAILOVER_CONDITION	SET_PROTECTION_MODE
FAILOVER	SET_STATE_APPLY_OFF
GET_CONFIGURATION_PROPERTY	SET_STATE_APPLY_ON
GET_CONFIGURATION_TAG	SET_STATE_TRANSPORT_OFF
GET_MEMBER_TAG	SET_STATE_TRANSPORT_ON
GET_PROPERTY	STOP_OBSERVER
HEALTH_CHECK	SWITCHOVER
INITIATE_FS_FAILOVER	WAIT
REINSTATE

ADD_DATABASE (new 23ai)

Adds a standby database to a broker configuration dbms_dg.add_database( database_name IN VARCHAR2, database_ci IN VARCHAR2, severity OUT BINARY_INTEGER) RETURN BINARY_INTEGER;

TBD

ADD_FAR_SYNC (new 23ai)

Adds a far sync instance to a broker
configuration dbms_dg.add_far_sync( far_sync_name IN VARCHAR2, far_sync_ci IN VARCHAR2, severity OUT BINARY_INTEGER) RETURN BINARY_INTEGER;

TBD

ADD_RECOVERY_APPLIANCE (new 23ai)

Add a recovery appliance to a broker
configuration dbms_dg.add_recovery_appliance( ra_name IN VARCHAR2, ra_ci IN VARCHAR2 DEFAULT NULL, severity OUT BINARY_INTEGER) RETURN BINARY_INTEGER;

TBD

CONVERT_TO_PHYSICAL (new 23ai)

Converts a snapshot standby database to a physical standby database dbms_dg.dbms_dg.convert_to_physical( db_name IN VARCHAR2, severity OUT BINARY_INTEGER) RETURN BINARY_INTEGER;

TBD

CONVERT_TO_SNAPSHOT (new 23ai)

Converts a physical standby database to a snapshot standby database dbms_dg.convert_to_snapshot( db_name IN VARCHAR2, severity OUT BINARY_INTEGER) RETURN BINARY_INTEGER;

TBD

CREATE_CONFIGURATION (new 23ai)

Creates a broker configuration dbms_dg.create_configuration( config_name IN VARCHAR2, primary_ci IN VARCHAR2, severity OUT BINARY_INTEGER) RETURN BINARY_INTEGER;

TBD

DISABLE (new 23ai)

Disables broker management of a member within a broker configuration dbms_dg.disable( member_name IN VARCHAR2, severity OUT BINARY_INTEGER) RETURN BINARY_INTEGER;

TBD

DISABLE_CONFIGURATION (new 23ai)

Disables broker management of a configuration dbms_dg.disable_configuration(severity OUT BINARY_INTEGER) RETURN BINARY_INTEGER;

TBD

DISABLE_FS_FAILOVER (new 23ai)

Disables fast-start failover (FSFO) dbms_dg.disable_fs_failover( force IN BOOLEAN DEFAULT FALSE, severity OUT BINARY_INTEGER) RETURN BINARY_INTEGER;

TBD

DISABLE_FS_FAILOVER_CONDITION (new 23ai)

Disables a fast-start failover condition dbms_dg.disable_fs_failover_condition( condition IN VARCHAR2, severity OUT BINARY_INTEGER) RETURN BINARY_INTEGER;

TBD

ENABLE (new 23ai)

Enables broker management of a member within the broker configuration dbms_dg.enable( member_name IN VARCHAR2, severity OUT BINARY_INTEGER) RETURN BINARY_INTEGER;

TBD

ENABLE_CONFIGURATION (new 23ai)

Enables broker management of the configuration dbms_dg.enable_configuration(severity OUT BINARY_INTEGER) RETURN BINARY_INTEGER;

TBD

ENABLE_FS_FAILOVER (new 23ai)

Enable fast-start failover dbms_dg.enable_fs_failover( observe_only IN BOOLEAN DEFAULT FALSE, severity OUT BINARY_INTEGER) RETURN BINARY_INTEGER;

TBD

ENABLE_FS_FAILOVER_CONDITION (new 23ai)

Enables a fast-start failover condition dbms_dg.enable_fs_failover_condition( condition IN VARCHAR2, severity OUT BINARY_INTEGER) RETURN BINARY_INTEGER;

TBD

FAILOVER (new 23ai)

Perform a database failover operation dbms_dg.failover( db_name IN VARCHAR2, failover_type IN VARCHAR2 DEFAULT NULL, severity OUT BINARY_INTEGER) RETURN BINARY_INTEGER;

TBD

GET_CONFIGURATION_PROPERTY (new 23ai)

Called by a broker client to return a configuration level property dbms_dg.get_configuration_property( property_name IN VARCHAR2, value OUT VARCHAR2, severity OUT BINARY_INTEGER) RETURN BINARY_INTEGER;

TBD

GET_CONFIGURATION_TAG (new 23ai)

Returns the value of a configuration tag dbms_dg.get_configuration_tag( config_name IN VARCHAR2, tag_name IN VARCHAR2, value OUT VARCHAR2, severity OUT BINARY_INTEGER) RETURN BINARY_INTEGER;

TBD

GET_MEMBER_TAG (new 23ai)

Returns the value of a member tag dbms_dg.get_member_tag( config_name IN VARCHAR2, member_name IN VARCHAR2, tag_name IN VARCHAR2, value OUT VARCHAR2, severity OUT BINARY_INTEGER) RETURN BINARY_INTEGER;

TBD

GET_PROPERTY (new 23ai)

Called by a broker client it returns a property value by specifying a member name dbms_dg.get_property( member_name IN VARCHAR2, property_name IN VARCHAR2, value OUT VARCHAR2, severity OUT BINARY_INTEGER ) RETURN BINARY_INTEGER;

TBD

HEALTH_CHECK (new 23ai)

Performs a broker health check dbms_dg.health_check RETURN BINARY_INTEGER;

SELECT dbms_dg.health_check;

      *

      ORA-00349: feature not enabled: Data Guard Broker

INITIATE_FS_FAILOVER

Specify a condition string that, when encountered by an application, allows the application to request the primary database to immediately invoke a fast-start failover dbms_dg.initiative_fs_failover(condstr IN VARCHAR2) RETURN BINARY_INTEGER;

set serveroutput on

      

      DECLARE

       status INTEGER;

      BEGIN

        status := dbms_dg.initiate_fs_failover('Failover Requested');

      

        dbms_output.put_line('Actual Status = ORA-' || status);

        IF status = 16646 THEN

          dbms_output.put_line('FSFO Disabled);

        END IF;

      END;

      /

REINSTATE (new 23ai)

Reinstates a previously added database dbms_dg.reinstate( db_name IN VARCHAR2, severity OUT BINARY_INTEGER) RETURN BINARY_INTEGER;

TBD

REMOVE (new 23ai)

Removes a member from the broker configuration dbms_dg.remove( member_name IN VARCHAR2, preserve_destination IN BOOLEAN DEFAULT FALSE, severity OUT BINARY_INTEGER) RETURN BINARY_INTEGER;

TBD

REMOVE_CONFIGURATION (new 23ai)

Removes a broker configuration dbms_dg.remove_configuration( preserve_destinations IN BOOLEAN DEFAULT FALSE, severity OUT BINARY_INTEGER) RETURN BINARY_INTEGER;

TBD

REMOVE_CONFIGURATION_TAG (new 23ai)

Removes a configuration tag dbms_dg.remove_configuration_tag( config_name IN VARCHAR2, tag_name IN VARCHAR2, severity OUT BINARY_INTEGER) RETURN BINARY_INTEGER;

TBD

REMOVE_CONFIGURATION_TAG_ALL (new 23ai)

Removes all configuration tags dbms_dg.remove_configuration_tag_all( config_name IN VARCHAR2, severity OUT BINARY_INTEGER) RETURN BINARY_INTEGER;

TBD

REMOVE_INSTANCE (new 23ai)

Removes an instance from a member of the broker configuration dbms_dg.remove_instance( member_name IN VARCHAR2, instance_name IN VARCHAR2, severity OUT BINARY_INTEGER) RETURN BINARY_INTEGER;

TBD

REMOVE_MEMBER_TAG (new 23ai)

Removes a member tag dbms_dg.remove_member_tag( config_name IN VARCHAR2, member_name IN VARCHAR2, tag_name IN VARCHAR2, severity OUT BINARY_INTEGER) RETURN BINARY_INTEGER;

TBD

REMOVE_MEMBER_TAG_ALL (new 23ai)

Removes all member tags dbms_dg.remove_member_tag_all( config_name IN VARCHAR2, member_name IN VARCHAR2, severity OUT BINARY_INTEGER) RETURN BINARY_INTEGER;

TBD

RESET_CONFIGURATION_PROPERTY (new 23ai)

Resets a configuration-level property to its default value dbms_dg.reset_configuration_property( property_name IN VARCHAR2, severity OUT BINARY_INTEGER) RETURN BINARY_INTEGER;

TBD

RESET_PROPERTY (new 23ai)

Resets a member configurable property to its default value dbms_dg.reset_property( member_name IN VARCHAR2, property_name IN VARCHAR2, severity OUT BINARY_INTEGER) RETURN BINARY_INTEGER;

TBD

SET_CONFIGURATION_PROPERTY (new 23ai)

Sets the value of a configuration-level property dbms_dg.set_configuration_property( property_name IN VARCHAR2, value IN VARCHAR2, severity OUT BINARY_INTEGER) RETURN BINARY_INTEGER;

TBD

SET_CONFIGURATION_TAG (new 23ai)

Sets the value of a configuration tag dbms_dg.set_configuration_tag( config_name IN VARCHAR2, tag_name IN VARCHAR2, value IN VARCHAR2, severity OUT BINARY_INTEGER) RETURN BINARY_INTEGER;

TBD

SET_MEMBER_TAG (new 23ai)

Sets the value of a member tag

If the key doesn't exist, a new key is created dbms_dg.set_member_tag( config_name IN VARCHAR2, member_name IN VARCHAR2, tag_name IN VARCHAR2, value IN VARCHAR2, severity OUT BINARY_INTEGER) RETURN BINARY_INTEGER;

TBD

SET_PROPERTY (new 23ai)

Sets a member configurable property dbms_dg.set_property( member_name IN VARCHAR2, property_name IN VARCHAR2, value IN VARCHAR2, severity OUT BINARY_INTEGER) RETURN BINARY_INTEGER;

TBD

SET_PROTECTION_MODE (new 23ai)

Changes the protection mode of the configuration to the specified mode Mode options: MaxPerformance, MaxAvailability, MaxProtection dbms_dg.set_protection_mode( protection_mode IN VARCHAR2, severity OUT BINARY_INTEGER) RETURN BINARY_INTEGER;

TBD

SET_STATE_APPLY_OFF (new 23ai)

Changes a member's state to APPLY-OFF dbms_dg.set_state_apply_off( member_name IN VARCHAR2, severity OUT BINARY_INTEGER) RETURN BINARY_INTEGER;

TBD

SET_STATE_APPLY_ON (new 23ai)

Changes a member's state to APPLY-ON dbms_dg.set_state_apply_on( member_name IN VARCHAR2, apply_instance IN VARCHAR2 DEFAULT NULL, severity OUT BINARY_INTEGER) RETURN BINARY_INTEGER;

TBD

SET_STATE_TRANSPORT_OFF (new 23ai)

Changes a member's state to TRANSPORT-OFF dbms_dg.set_state_transport_off( member_name IN VARCHAR2, severity OUT BINARY_INTEGER) RETURN BINARY_INTEGER;

TBD

SET_STATE_TRANSPORT_ON (new 23ai)

Changes a member's state to TRANSPORT-ON dbms_dg.set_state_transport_on( member_name IN VARCHAR2, severity OUT BINARY_INTEGER) RETURN BINARY_INTEGER;

TBD

STOP_OBSERVER (new 23ai)

Stop the fast-start failover observers in a
Data Guard broker configuration dbms_dg.stop_observer( ob_name IN VARCHAR2, severity OUT BINARY_INTEGER) RETURN BINARY_INTEGER;

TBD

SWITCHOVER (new 23ai)

Performs a database switchover operation dbms_dg.switchover( db_name IN VARCHAR2, severity OUT BINARY_INTEGER) RETURN BINARY_INTEGER;

TBD

WAIT (new 23ai)

Use to wait for various Data Guard broker events to occur dbms_dg.wait( wait_event IN BINARY_INTEGER, wait_time IN BINARY_INTEGER) RETURN BINARY_INTEGER;

TBD