CREATE ASYNC REPLICATION

The CREATE ASYNC REPLICATION statement creates an asynchronous replication instance.

Syntax

CREATE ASYNC REPLICATION <name>
FOR <remote_path> AS <local_path> [, <another_remote_path> AS <another_local_path>]
WITH (option = value [, ...])

Parameters

• name — a name of the asynchronous replication instance.

• remote_path — a relative or absolute path to a table or directory in the source database.

• local_path — a relative or absolute path to a target table or directory in the local database.

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

  • CONNECTION_STRING — a connection string for the source database (mandatory).

  • Authentication details for the source database (mandatory) depending on the authentication method:

    • Access token:

      • TOKEN_SECRET_NAME — the name of the secret that contains the token.

    • Login and password:

      • USER — a database user name.
      • PASSWORD_SECRET_NAME — the name of the secret that contains the password for the source database user.

Examples

The following statement creates an asynchronous replication instance to synchronize the original_table source table in the /Root/another_database database to the replica_table target table in the local database:

CREATE ASYNC REPLICATION my_replication_for_single_table
FOR original_table AS replica_table
WITH (
    CONNECTION_STRING = 'grpcs://example.com:2135/?database=/Root/another_database',
    TOKEN_SECRET_NAME = 'my_secret'
);

The statement above uses the token from the my_secret secret for authentication and the grpcs://example.com:2135 endpoint to connect to the /Root/another_database database.

The following statement creates an asynchronous replication instance to replicate the source tables original_table_1 and original_table_2 to the target tables replica_table_1 and replica_table_2:

CREATE ASYNC REPLICATION my_replication_for_multiple_tables
FOR original_table_1 AS replica_table_1, original_table_2 AS replica_table_2
WITH (
    CONNECTION_STRING = 'grpcs://example.com:2135/?database=/Root/another_database',
    TOKEN_SECRET_NAME = 'my_secret'
);

The following statement creates an asynchronous replication instance for the objects in the original_dir directory:

CREATE ASYNC REPLICATION my_replication_for_dir
FOR original_dir AS replica_dir
WITH (
    CONNECTION_STRING = 'grpcs://example.com:2135/?database=/Root/another_database',
    TOKEN_SECRET_NAME = 'my_secret'
);

The following statement creates an asynchronous replication instance for the objects in the /Root/another_database database:

CREATE ASYNC REPLICATION my_replication_for_database
FOR `/Root/another_database` AS `/Root/my_database`
WITH (
    CONNECTION_STRING = 'grpcs://example.com:2135/?database=/Root/another_database',
    TOKEN_SECRET_NAME = 'my_secret'
);

See also

• ALTER ASYNC REPLICATION
• DROP ASYNC REPLICATION