Skip to content

Replication Custom Properties

Jens Alfke edited this page Aug 21, 2015 · 2 revisions

CBLReplicator has a property called customProperties that provides an informal way to customize the behavior of the replicator. (In the REST API you can use the same properties simply by adding them to the JSON body of the POST request to /_replicate.)

Key Value Description
reset anything The replicator will reset its state and act as though it's never synced with the remote database before. This will be slower, but it has some potentially useful effects, like re-downloading all documents that had been purged locally.
connection_timeout milliseconds Timeout for network requests
heartbeat milliseconds How often a pull replication's server push (_changes feed) should send a byte down the socket to keep it alive
poll milliseconds If set, a continuous pull replication will periodically poll for changes (at the given interval) instead of leaving a socket open. Increases latency but reduces number of sockets on the server.
network string If set to "WiFi", the replication will only run over a WiFi network, not cellular. If set to Cell, the reverse happens.
websocket boolean
Clone this wiki locally