Skip to content

Sync Reader ​

Introduction ​

When the source database is compatible with the PSync protocol, sync_reader is recommended. Databases compatible with the PSync protocol include:

  • Redis
  • Tair
  • Valkey
  • ElastiCache (requires aws_psync configuration)

Advantages: Best data consistency, minimal impact on the source database, and allows for seamless switching.

Principle: RedisShake simulates a Slave connecting to the Master node, and the Master will send data to RedisShake, which includes both full and incremental parts. The full data is an RDB file, and the incremental data is an AOF data stream. RedisShake will accept both full and incremental data and temporarily store them on the hard disk. During the full synchronization phase, RedisShake first parses the RDB file into individual Redis commands, then sends these commands to the destination. During the incremental synchronization phase, RedisShake continues to synchronize the AOF data stream to the destination.

Configuration ​

toml
[sync_reader]
cluster = false            # set to true if source is a redis cluster
address = "127.0.0.1:6379" # when cluster is true, set address to one of the cluster node
username = ""              # keep empty if not using ACL
password = ""              # keep empty if no authentication is required
tls = false
sync_rdb = true # set to false if you don't want to sync rdb
sync_aof = true # set to false if you don't want to sync aof
  • cluster: Whether the source is a cluster
  • address: Source address, when the source is a cluster, address can be set to any node in the cluster
  • Authentication:
    • When the source uses ACL accounts, configure username and password
    • When the source uses traditional accounts, only configure password
    • When the source does not require authentication, do not configure username and password
  • tls: Whether the source has enabled TLS/SSL, no need to configure a certificate because RedisShake does not verify the server certificate
  • sync_rdb: Whether to apply the full dataset from the RDB to the target. When false, RedisShake attempts to request an empty RDB, reducing dataset traversal, serialization, and transfer. This optimization requires source support for REPLCONF rdb-filter-only (available in Redis 7.0 and later) and automatically negotiates EOF capability, regardless of try_diskless or the source's repl-diskless-sync setting. If the source does not support or rejects the option, RedisShake receives and discards the full RDB instead. Even when the optimization succeeds, the source still forks and sends an empty RDB before incremental synchronization begins.
  • sync_aof: Whether to synchronize AOF, when set to false, RedisShake will skip the incremental synchronization phase, at which point RedisShake will exit after the full synchronization phase is complete.

Released under the MIT License.