ADD_DATABASE

The ADD_DATABASE function can be used to add a standby database to the Data Guard broker configuration.

ADD_DATABASE Function

Format

DBMS_DG.ADD_DATABASE (
     database_name          IN VARCHAR2,
     database_ci            IN VARCHAR2,
     severity               OUT BINARY_INTEGER)
RETURN BINARY_INTEGER;

Parameters

Parameter Description
database_name

The name that will be used by the broker to refer to this standby database. It must match (case-insensitive) the value of the corresponding database DB_UNIQUE_NAME initialization parameter.

database_ci

A fully specified connect descriptor or a name to be resolved by an Oracle Net Services naming method (for example, TNS). The value you specify is also used as the initial value of the DGConnectIdentifier database property.

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.

  • This function can only be called while connected to a primary database or an enabled standby database or far sync instance.

Return Values

Error Description
ORA-00000: normal, successful completion

The standby database was successfully added to the Data Guard broker configuration.

Other

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