REMOVE_INSTANCE

The REMOVE_INSTANCE function can be used to remove an instance from a member the Data Guard broker configuration.

REMOVE_INSTANCE Function

DBMS_DG.REMOVE_INSTANCE (
     member_name           IN VARCHAR2,
     instance_name         IN VARCHAR2,
     severity              OUT BINARY_INTEGER)
RETURN BINARY_INTEGER;

Parameters

Parameter Description
member_name The DB_UNIQUE_NAME initialization parameter value of the member whose instance is to be removed.
instance_name The name of the instance (SID) that you want to remove the broker configuration.
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.

  • The broker automatically adds started instances to the broker configuration. However, the broker does not automatically remove instances from the database. This function can be used to manually remove any instance that no longer exists from the configuration.
  • This function returns an error for an instance that is currently active in the broker configuration.
  • This function returns an error if this is the only instance currently associated with a database for far sync instance.

Return Values

Error Description
ORA-00000: normal, successful completion

The configuration was successfully removed.

Other

The Data Guard broker was unable to remove the configuration and the return value will indicate the reason for this failure.