Litestream

Command: sync

v0.5.9 The sync command forces an immediate WAL-to-LTX sync for a database managed by the Litestream daemon. By default it triggers the sync and returns immediately (fire-and-forget). With the -wait flag it blocks until the sync completes, including remote replication.

The sync command communicates with a running litestream replicate process over the IPC control socket. The daemon must already be running.

Usage 

litestream sync [arguments] DB_PATH

Arguments 

-socket PATH
    Path to the control socket.
    Defaults to /var/run/litestream.sock

-wait
    Block until sync completes including remote replication.
    Defaults to false (fire-and-forget).

-timeout SECONDS
    Maximum time to wait in seconds, best-effort.
    Defaults to 30.

Behavior

The sync command operates in two modes:

  • Fire-and-forget (default): Triggers WAL-to-LTX conversion and returns immediately. The response status will be synced_local if changes were synced, or no_change if the database was already up to date.

  • Blocking (-wait): Blocks until both WAL-to-LTX conversion and LTX-to-remote replication complete. The response status will be synced when complete, or no_change if the database was already up to date.

Examples

Basic sync

Trigger an immediate sync for a database:

$ litestream sync /path/to/my.db

Sync and wait for completion

Block until the sync finishes, including remote replication:

$ litestream sync -wait /path/to/my.db

Sync with custom timeout and socket

Specify a longer timeout and a non-default socket path:

$ litestream sync -wait -timeout 60 -socket /tmp/litestream.sock /path/to/my.db

See Also

← Command: restore
IPC Endpoints →