ALTER ASYNC REPLICATION

The ALTER ASYNC REPLICATION statement modifies the status and parameters of an asynchronous replication instance.

Syntax

ALTER ASYNC REPLICATION <name> SET (option = value [, ...])

Parameters

  • name — a name of the asynchronous replication instance.

  • SET (option = value [, ...]) — asynchronous replication parameters:

    • STATE: the state of asynchronous replication. Valid values are:

      • PAUSED: pause the application of changes. Changefeeds in the source continue accumulating records according to the availability policy set by AVAILABILITY_PERIOD. Replica objects already attached remain read-only.
      • STANDBY: start or resume change data replication. For replication created with INITIAL_SCAN = FALSE, attaches previously restored target tables. Before starting replication, finish importing all tables as described in the initial synchronization guide.
      • DONE: complete the asynchronous replication process. For forced completion, also specify FAILOVER_MODE = 'FORCE'.

    • FAILOVER_MODE: the replication completion mode. Applies only with STATE = 'DONE'. This parameter is not required for PAUSED or STANDBY. Valid values are:

      • FORCE — forced failover.

  • Authentication settings for the source database (one of the following):

    • Using a token:

      • TOKEN_SECRET_PATH — the secret that contains the token.

    • Using a username and password:

      • USER — the username.
      • PASSWORD_SECRET_PATH — the secret that contains the password.

    • Using a service agent:

      • SERVICE_ACCOUNT_ID — the identificator of the service account.
      • INITIAL_TOKEN_SECRET_PATH — the secret that contains the account's token. It is used for initial authentication.

Examples

The following statement starts replication after importing the initial data:

ALTER ASYNC REPLICATION my_replication SET (STATE = 'STANDBY');

The following statement pauses the application of changes:

ALTER ASYNC REPLICATION my_replication SET (STATE = 'PAUSED');

To resume replication, use STATE = 'STANDBY'. With a finite AVAILABILITY_PERIOD, account for the age of messages already accumulated, the pause, and subsequent processing time: pausing does not suspend the availability period. With 'UNLIMITED', unacknowledged changes are retained until processed; monitor free space in the source.

The following statement forces the asynchronous replication process to complete:

ALTER ASYNC REPLICATION my_replication SET (STATE = "DONE", FAILOVER_MODE = "FORCE");

The following query changes the secret:

ALTER ASYNC REPLICATION my_replication SET (TOKEN_SECRET_PATH = "my_token");

See also

Previous
ACTION
Next
Overview