REMOVE

The REMOVE function can be used to remove a member the Data Guard broker configuration.

REMOVE Function

DBMS_DG.REMOVE (
     member_name          IN VARCHAR2,
     preserve_destination IN BOOLEAN DEFAULT FALSE,
     severity              OUT BINARY_INTEGER)
RETURN BINARY_INTEGER;

Parameters

Parameter	Description
member_name	The DB_UNIQUE_NAME initialization parameter value of the database to be reinstated.
preserve_destination	A boolean value to indicate whether the log_archive_dest initialization parameter setting should be preserved or clear when removing member from the configuration. A value of TRUE indicates that the parameter setting will not be cleared. A value of FALSE indicates the parameter setting will be cleared.
severity	The severity associated with the status returned by this function. Severity will be one of the following Oracle error numbers: ORA-0: normal, successful completion ORA-16501: The Oracle Data Guard broker operation failed. ORA-16502: The Oracle Data Guard broker operation succeeded with warnings.

Usage Notes

• This function returns a binary integer.

• An error is returned if you specify the name of the primary database in the broker configuration.
• By default, this function will cause all references to the specified member to be removed from all redo transport initialization parameters at each member of the configuration. To preserve these settings, specify TRUE for the preserve_destination parameter.
• This function cannot be called if fast-start failover is enabled and database-name specifies the name of the target standby database.

Return Values

Error	Description
ORA-00000: normal, successful completion	The member was successfully removed.
Other	The Data Guard broker was unable to remove the member from the configuration and the return value will indicate the reason for this failure.