Skip to content

Bump live-sync to v0.4.0 and document new flags #4621

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
arajkumar merged 3 commits into from
Dec 15, 2025
Merged

Bump live-sync to v0.4.0 and document new flags #4621

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
c1f33f9
Bump live-sync to v0.4.0 and document new flags
arajkumar Dec 15, 2025
a4898ff
Update _partials/_livesync-terminal.md
arajkumar Dec 15, 2025
69f1e77
Update _partials/_livesync-terminal.md
arajkumar Dec 15, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 7 additions & 2 deletions _partials/_livesync-terminal.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -175,7 +175,7 @@ instance to a $SERVICE_LONG:
As you run the $PG_CONNECTOR continuously, best practice is to run it as a Docker daemon.

```shell
docker run -d --rm --name livesync timescale/live-sync:v0.3.3 run \
docker run -d --rm --name livesync timescale/live-sync:v0.4.0 run \
--publication <publication_name> --subscription <subscription_name> \
--source $SOURCE --target $TARGET --table-map <table_map_as_json>
```
Expand All @@ -191,6 +191,11 @@ instance to a $SERVICE_LONG:
`--table-map`: (Optional) A JSON string that maps source tables to target tables. If not provided, the source and target table names are assumed to be the same.
For example, to map the source table `metrics` to the target table `metrics_data`:

`--table-sync-workers`: (Optional) The number of parallel workers to use for initial table sync. Default is 4.

`--copy-data`: (Optional) By default, the initial table data is copied from source to target before starting logical replication. Set to `false` so only changes made after replication slot creation are replicated.
Best practice is to set to `false` during dry-run livesync so you do not copy table data.

```
--table-map '{"source": {"schema": "public", "table": "metrics"}, "target": {"schema": "public", "table": "metrics_data"}}'
```
Expand Down Expand Up @@ -325,7 +330,7 @@ EOF
Use the `--drop` flag to remove the replication slots created by the $PG_CONNECTOR on the source database.

```shell
docker run -it --rm --name livesync timescale/live-sync:v0.3.3 run \
docker run -it --rm --name livesync timescale/live-sync:v0.4.0 run \
--publication <publication_name> --subscription <subscription_name> \
--source $SOURCE --target $TARGET \
--drop
Expand Down