Skip to main content

autonomous_container_database_dataguard_associations

Creates, updates, deletes, gets or lists an autonomous_container_database_dataguard_associations resource.

Overview​

Nameautonomous_container_database_dataguard_associations
TypeResource
Idoci.database.autonomous_container_database_dataguard_associations

Fields​

The following fields are returned by SELECT queries:

The Autonomous Container Database with Autonomous Data Guard enabled association information for the specified Autonomous Data Guard association OCID.

NameDatatypeDescription
idstringThe OCID of the Autonomous Data Guard created for a given Autonomous Container Database.
applyLagstringThe lag time between updates to the primary Autonomous Container Database and application of the redo data on the standby Autonomous Container Database, as computed by the reporting database. Example: 9 seconds
applyRatestringThe rate at which redo logs are synchronized between the associated Autonomous Container Databases. Example: 180 Mb per second
autonomousContainerDatabaseIdstringThe [OCID](/Content/General/Concepts/identifiers.htm) of the Autonomous Container Database that has a relationship with the peer Autonomous Container Database. Used only by Autonomous AI Database on Dedicated Exadata Infrastructure.
fastStartFailOverLagLimitInSecondsintegerThe lag time for my preference based on data loss tolerance in seconds.
isAutomaticFailoverEnabledbooleanIndicates whether Automatic Failover is enabled for Autonomous Container Database Dataguard Association
lifecycleDetailsstringAdditional information about the current lifecycleState, if available.
lifecycleStatestringThe current state of Autonomous Data Guard. (PROVISIONING, AVAILABLE, ROLE_CHANGE_IN_PROGRESS, TERMINATING, TERMINATED, FAILED, UNAVAILABLE, UPDATING)
peerAutonomousContainerDatabaseDataguardAssociationIdstringThe OCID of the peer Autonomous Container Database-Autonomous Data Guard association.
peerAutonomousContainerDatabaseIdstringThe [OCID](/Content/General/Concepts/identifiers.htm) of the peer Autonomous Container Database.
peerLifecycleStatestringThe current state of the Autonomous Container Database. (PROVISIONING, AVAILABLE, UPDATING, TERMINATING, TERMINATED, FAILED, BACKUP_IN_PROGRESS, RESTORING, RESTORE_FAILED, RESTARTING, MAINTENANCE_IN_PROGRESS, ROLE_CHANGE_IN_PROGRESS, ENABLING_AUTONOMOUS_DATA_GUARD, UNAVAILABLE)
peerRolestringThe Data Guard role of the Autonomous Container Database or Autonomous AI Database, if Autonomous Data Guard is enabled. (PRIMARY, STANDBY, DISABLED_STANDBY, BACKUP_COPY, SNAPSHOT_STANDBY)
protectionModestringThe protection mode of this Autonomous Data Guard association. For more information, see [Oracle Data Guard Protection Modes](http:​//docs.oracle.com/database/122/SBYDB/oracle-data-guard-protection-modes.htm#SBYDB02000) in the Oracle Data Guard documentation. (MAXIMUM_AVAILABILITY, MAXIMUM_PERFORMANCE)
rolestringThe Data Guard role of the Autonomous Container Database or Autonomous AI Database, if Autonomous Data Guard is enabled. (PRIMARY, STANDBY, DISABLED_STANDBY, BACKUP_COPY, SNAPSHOT_STANDBY)
timeCreatedstring (date-time)The date and time the Autonomous DataGuard association was created.
timeLastRoleChangedstring (date-time)The date and time when the last role change action happened.
timeLastSyncedstring (date-time)The date and time of the last update to the apply lag, apply rate, and transport lag values.
transportLagstringThe approximate number of seconds of redo data not yet available on the standby Autonomous Container Database, as computed by the reporting database. Example: 7 seconds

Methods​

The following methods are available for this resource:

NameAccessible byRequired ParamsOptional ParamsDescription
getselectautonomousContainerDatabaseId, autonomousContainerDatabaseDataguardAssociationId, regionDeprecated. Use the [GetAutonomousContainerDatabase](#/en/database/latest/AutonomousContainerDatabase/GetAutonomousContainerDatabase) operation to get the details of an Autonomous Container Database (ACD) enabled with Autonomous Data Guard associated with the specified ACD.<br />
listselectautonomousContainerDatabaseId, regionlimit, pageDeprecated. Use the [ListAutonomousContainerDatabases](#/en/database/latest/AutonomousContainerDatabase/ListAutonomousContainerDatabases) operation to get a list of the Autonomous Container Databases (ACDs)with Autonomous Data Guard-enabled associated with the specified ACD.<br />
createinsertautonomousContainerDatabaseId, region, peerAutonomousContainerDatabaseDisplayName, protectionModeopc-retry-tokenDeprecated. Use the [AddStandbyAutonomousContainerDatabase](#/en/database/latest/AutonomousContainerDatabase/AddStandbyAutonomousContainerDatabase) operation to create a new Autonomous Data Guard association. An Autonomous Data Guard association represents the replication relationship between the<br />specified Autonomous Container database and a peer Autonomous Container database. For more information, see [Using Oracle Data Guard](https:​//docs.oracle.com/en/cloud/paas/autonomous-database/dedicated/adbau/#articletitle.html). <br />
updateupdateautonomousContainerDatabaseId, autonomousContainerDatabaseDataguardAssociationId, regionif-match, opc-request-idDeprecated. Use the [EditAutonomousContainerDatabaseDataguard](#/en/database/latest/AutonomousContainerDatabase/EditAutonomousContainerDatabaseDataguard) operation to update an Autonomous Data Guard association.<br />
failover_autonomous_container_database_dataguard_associationexecautonomousContainerDatabaseId, autonomousContainerDatabaseDataguardAssociationId, regionif-matchDeprecated. Use the [FailoverAutonomousContainerDatabaseDataguard](#/en/database/latest/AutonomousContainerDatabase/FailoverAutonomousContainerDatabaseDataguard) operation to fail over the standby Autonomous Container Database (ACD) to the primary ACD after the existing primary ACD fails or becomes unreachable.<br /><br />A failover can result in data loss, depending on the protection mode in effect at the time the primary Autonomous Container Database fails.<br />
migrate_autonomous_container_database_dataguard_associationexecautonomousContainerDatabaseId, autonomousContainerDatabaseDataguardAssociationId, regionif-match, opc-request-idMigrate Autonomous Container Database, identified by the autonomousContainerDatabaseId parameter.<br />
reinstate_autonomous_container_database_dataguard_associationexecautonomousContainerDatabaseId, autonomousContainerDatabaseDataguardAssociationId, regionif-matchDeprecated. Use the [ReinstateAutonomousContainerDatabaseDataguard](#/en/database/latest/AutonomousContainerDatabase/ReinstateAutonomousContainerDatabaseDataguard) operation to reinstate a disabled standby Autonomous Container Database (ACD), identified by the autonomousContainerDatabaseId parameter, to an active standby ACD.<br />
switchover_autonomous_container_database_dataguard_associationexecautonomousContainerDatabaseId, autonomousContainerDatabaseDataguardAssociationId, regionif-matchDeprecated. Use the [SwitchoverAutonomousContainerDatabaseDataguard](#/en/database/latest/AutonomousContainerDatabase/SwitchoverAutonomousContainerDatabaseDataguard) operation to switches over the primary Autonomous Container Database (ACD) of an Autonomous Data Guard peer association to standby role. The standby ACD associated with autonomousContainerDatabaseDataguardAssociationId assumes the primary ACD role.<br /><br />A switchover incurs no data loss.<br />

Parameters​

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

NameDatatypeDescription
autonomousContainerDatabaseDataguardAssociationIdstringThe Autonomous Container Database-Autonomous Data Guard association [OCID](/Content/General/Concepts/identifiers.htm).
autonomousContainerDatabaseIdstringThe Autonomous Container Database [OCID](/Content/General/Concepts/identifiers.htm).
regionstringOCI region identifier (e.g. us-ashburn-1, ap-sydney-1); resolves from OCI_REGION when not supplied in the query. (default: us-ashburn-1, x-stackQL-envVar: OCI_REGION)
if-matchstringFor optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
limitintegerThe maximum number of items to return per page.
opc-request-idstringUnique identifier for the request.
opc-retry-tokenstringA token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations (for example, if a resource has been deleted and purged from the system, then a retry of the original creation request may be rejected).
pagestringThe pagination token to continue listing from.

SELECT examples​

Deprecated. Use the [GetAutonomousContainerDatabase](#/en/database/latest/AutonomousContainerDatabase/GetAutonomousContainerDatabase) operation to get the details of an Autonomous Container Database (ACD) enabled with Autonomous Data Guard associated with the specified ACD.<br />

SELECT
id,
applyLag,
applyRate,
autonomousContainerDatabaseId,
fastStartFailOverLagLimitInSeconds,
isAutomaticFailoverEnabled,
lifecycleDetails,
lifecycleState,
peerAutonomousContainerDatabaseDataguardAssociationId,
peerAutonomousContainerDatabaseId,
peerLifecycleState,
peerRole,
protectionMode,
role,
timeCreated,
timeLastRoleChanged,
timeLastSynced,
transportLag
FROM oci.database.autonomous_container_database_dataguard_associations
WHERE autonomousContainerDatabaseId = '{{ autonomousContainerDatabaseId }}' -- required
AND autonomousContainerDatabaseDataguardAssociationId = '{{ autonomousContainerDatabaseDataguardAssociationId }}' -- required
AND region = '{{ region }}' -- required
;

INSERT examples​

Deprecated. Use the [AddStandbyAutonomousContainerDatabase](#/en/database/latest/AutonomousContainerDatabase/AddStandbyAutonomousContainerDatabase) operation to create a new Autonomous Data Guard association. An Autonomous Data Guard association represents the replication relationship between the<br />specified Autonomous Container database and a peer Autonomous Container database. For more information, see [Using Oracle Data Guard](https:​//docs.oracle.com/en/cloud/paas/autonomous-database/dedicated/adbau/#articletitle.html). <br />

INSERT INTO oci.database.autonomous_container_database_dataguard_associations (
fastStartFailOverLagLimitInSeconds,
isAutomaticFailoverEnabled,
peerAutonomousContainerDatabaseBackupConfig,
peerAutonomousContainerDatabaseCompartmentId,
peerAutonomousContainerDatabaseDisplayName,
peerAutonomousVmClusterId,
peerCloudAutonomousVmClusterId,
peerDbUniqueName,
protectionMode,
standbyMaintenanceBufferInDays,
autonomousContainerDatabaseId,
region,
opc-retry-token
)
SELECT
{{ fastStartFailOverLagLimitInSeconds }},
{{ isAutomaticFailoverEnabled }},
'{{ peerAutonomousContainerDatabaseBackupConfig }}',
'{{ peerAutonomousContainerDatabaseCompartmentId }}',
'{{ peerAutonomousContainerDatabaseDisplayName }}' /* required */,
'{{ peerAutonomousVmClusterId }}',
'{{ peerCloudAutonomousVmClusterId }}',
'{{ peerDbUniqueName }}',
'{{ protectionMode }}' /* required */,
{{ standbyMaintenanceBufferInDays }},
'{{ autonomousContainerDatabaseId }}',
'{{ region }}',
'{{ opc-retry-token }}'
RETURNING
id,
applyLag,
applyRate,
autonomousContainerDatabaseId,
fastStartFailOverLagLimitInSeconds,
isAutomaticFailoverEnabled,
lifecycleDetails,
lifecycleState,
peerAutonomousContainerDatabaseDataguardAssociationId,
peerAutonomousContainerDatabaseId,
peerLifecycleState,
peerRole,
protectionMode,
role,
timeCreated,
timeLastRoleChanged,
timeLastSynced,
transportLag
;

UPDATE examples​

Deprecated. Use the [EditAutonomousContainerDatabaseDataguard](#/en/database/latest/AutonomousContainerDatabase/EditAutonomousContainerDatabaseDataguard) operation to update an Autonomous Data Guard association.<br />

UPDATE oci.database.autonomous_container_database_dataguard_associations
SET
fastStartFailOverLagLimitInSeconds = {{ fastStartFailOverLagLimitInSeconds }},
isAutomaticFailoverEnabled = {{ isAutomaticFailoverEnabled }},
protectionMode = '{{ protectionMode }}'
WHERE
autonomousContainerDatabaseId = '{{ autonomousContainerDatabaseId }}' --required
AND autonomousContainerDatabaseDataguardAssociationId = '{{ autonomousContainerDatabaseDataguardAssociationId }}' --required
AND region = '{{ region }}' --required
AND if-match = '{{ if-match}}'
AND opc-request-id = '{{ opc-request-id}}'
RETURNING
id,
applyLag,
applyRate,
autonomousContainerDatabaseId,
fastStartFailOverLagLimitInSeconds,
isAutomaticFailoverEnabled,
lifecycleDetails,
lifecycleState,
peerAutonomousContainerDatabaseDataguardAssociationId,
peerAutonomousContainerDatabaseId,
peerLifecycleState,
peerRole,
protectionMode,
role,
timeCreated,
timeLastRoleChanged,
timeLastSynced,
transportLag;

Lifecycle Methods​

Deprecated. Use the [FailoverAutonomousContainerDatabaseDataguard](#/en/database/latest/AutonomousContainerDatabase/FailoverAutonomousContainerDatabaseDataguard) operation to fail over the standby Autonomous Container Database (ACD) to the primary ACD after the existing primary ACD fails or becomes unreachable.<br /><br />A failover can result in data loss, depending on the protection mode in effect at the time the primary Autonomous Container Database fails.<br />

EXEC oci.database.autonomous_container_database_dataguard_associations.failover_autonomous_container_database_dataguard_association
@autonomousContainerDatabaseId='{{ autonomousContainerDatabaseId }}' --required,
@autonomousContainerDatabaseDataguardAssociationId='{{ autonomousContainerDatabaseDataguardAssociationId }}' --required,
@region='{{ region }}' --required,
@if-match='{{ if-match }}'
;