8.5 Asynchronous Replication Channel Options

The following options can be set with clusterSet.createReplicaCluster() and cluster.setOption():

clusterSetReplicationConnectRetry: corresponds to the replication option SOURCE_CONNECT_RETRY. Specifies the interval in seconds between the reconnection attempts that the replica makes after the connection to the source times out. The default interval is 3.
clusterSetReplicationRetryCount: corresponds to the replication option SOURCE_RETRY_COUNT. Sets the maximum number of reconnection attempts that the replica makes after the connection to the source times out. Default is 10.
clusterSetReplicationHeartbeatPeriod: corresponds to the replication option SOURCE_HEARTBEAT_PERIOD. Controls the heartbeat interval, which stops the connection timeout occurring in the absence of data if the connection is still good.
clusterSetReplicationCompressionAlgorithms: corresponds to the replication option SOURCE_COMPRESSION_ALGORITHMS. String that specifies the permitted compression algorithms for connections to the replication source
clusterSetReplicationZstdCompressionLevel: corresponds to the replication option SOURCE_ZSTD_COMPRESSION_LEVEL. Specifies the compression level to use for connections to the replication source server that use the zstd compression algorithm.
clusterSetReplicationBind: corresponds to the replication option SOURCE_BIND. Determines which of the replica's network interfaces is chosen for connecting to the source, for use on replicas that have multiple network interfaces.
clusterSetReplicationNetworkNamespace: corresponds to the replication option NETWORK_NAMESPACE. specifies the network namespace to use for TCP/IP connections to the replication source server or, if the MySQL communication stack is in use, for Group Replication’s group communication connections.

For information on default values, see CHANGE REPLICATION SOURCE TO Statement.

Note

If any of these options are set using cluster.setOption() on a Cluster which is not a member of a ClusterSet, an error is returned.

Replication channel options are set in the Cluster metadata and do not take effect until the channel is started or restarted, using clusterSet.rejoinCluster() for example. These options can also be set when the Cluster is OFFLINE.

For example:

cluster.setOption("clusterSetReplicationCompressionAlgorithms", "zlib")

If an option is set with a NULL value, the default value is used.