Oracle Data Guard DBMS_DG API Summary

The Oracle Data Guard DBMS_DG APIs allow you to manage a broker configuration.

Table 11-1 DBMS_DG API Summary

API Effect
ADD_DATABASE Adds a standby database to the Data Guard broker configuration.
ADD_FAR_SYNC

Adds a far sync instance to the Data Guard broker configuration.

ADD_RECOVERY_APPLIANCE

Adds a Zero Data Loss Recovery Appliance to the Data Guard broker configuration.

CONVERT_TO_PHYSICAL

Used to convert a snapshot standby database to a physical standby database.

CONVERT_TO_SNAPSHOT

Converts a snapshot standby database to a physical standby database.

CREATE_CONFIGURATION

Used to create a Data Guard broker configuration.

DISABLE

Used to disable a configuration member.

DISABLE_CONFIGURATION

This function is used to disable broker management of a configuration.

DISABLE_FS_FAILOVER

Used to to disable fast-start failover.

DISABLE_FS_FAILOVER_CONDITION

Used to remove conditions for which a fast-start failover should be performed.

ENABLE

This function is used to to enable broker management of the specified member.

ENABLE_CONFIGURATION

Enables broker management of a configuration..

ENABLE_FS_FAILOVER

Is used to enable fast-start failover..

ENABLE_FS_FAILOVER_CONDITION Can be used to specify additional conditions for which a fast-start failover should be performed.

FAILOVER

This function can be used to perform a database failover.

GET_CONFIGURATION_PROPERTY

Is used to get the value of a configuration property.

GET_PROPERTY

Is used to get the value of a member property.

HEALTH_CHECK

Is used to get the broker to evaluate the health of all configuration members.

REINSTATE

Can be used to reinstate a database after a failover operation.

REMOVE

Is used to remove a member the Data Guard broker configuration.

REMOVE_CONFIGURATION

Is used to remove the Data Guard broker configuration.

REMOVE_INSTANCE

Can be used to remove an instance from a member the Data Guard broker configuration.

RESET_CONFIGURATION_PROPERTY

Is used to reset a configuration property to its default value.

RESET_PROPERTY

Can be used to reset a member configurable property to its default value.

SET_CONFIGURATION_PROPERTY

Can be used to set a value for a configuration property.

SET_PROPERTY

Can be used to set a value for a member configurable property.

SET_PROTECTION_MODE

Can be used to set the configuration protection mode.

SET_STATE_APPLY_OFF

Is used to set the apply state to off for a logical or physical standby database.

SET_STATE_APPLY_ON

Is used to set the apply state to onfor a logical or physical standby database..

SET_STATE_TRANSPORT_OFF

Used to set the redo transport state to off for a primary database.

SET_STATE_TRANSPORT_ON

Can be used to set the redo transport state to on for a primary database.

STOP_OBSERVER used to stop fast-start failover observers in a Data Guard broker configuration.
SWITCHOVER Is used to perform a database switchover.
WAIT Is used to wait for various Data Guard broker events to occur.