Skip to content

Add optional version_label to sync configs - #756

Draft
rkistner wants to merge 3 commits into
mainfrom
version-label
Draft

Add optional version_label to sync configs#756
rkistner wants to merge 3 commits into
mainfrom
version-label

Conversation

@rkistner

Copy link
Copy Markdown
Contributor

With a single replication stream being able to handle multiple sync configs, the current diagnostic tooling does not distinguish between the sync configs properly. For example, the PowerSync Cloud dashboard only shows replication stream names, with no identifier for sync configs.

An additional issue is that it can be difficult to correlate what is deployed with what is active or processing, without comparing the full contents.

This adds a new config field sync_config.version_label in the main config YAML. When sync config is updated, that label is persisted with the config. If only the label itself is updated, that is also treated as a sync config change.

The main purpose of this field is to track sync config versions when using automated tooling, such as the powersync cloud environment. It can be managed manually, but there is no check to enforce that it is updated or unique.

Note that the version_label is not part of the sync config file itself, but rather the root config, to simplify management by of the value by tooling, while the user writes the actual sync config file.

The behavior of label change triggering a sync config change can be used instead of the old "add comment/whitespace in sync config" recommendation to reload the config.

For Postgres storage, this requires adding a new column in a migration. On MongoDB storage, it is a new field, but no migration required.

AI Usage

Used Codex gpt-5.6 to implement.

@changeset-bot

changeset-bot Bot commented Aug 17, 2026

Copy link
Copy Markdown

🦋 Changeset detected

Latest commit: e8e135c

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 15 packages
Name Type
@powersync/service-module-postgres-storage Minor
@powersync/service-module-mongodb-storage Minor
@powersync/service-core Minor
@powersync/service-types Minor
@powersync/service-schema Minor
@powersync/service-module-convex Patch
@powersync/service-module-mongodb Patch
@powersync/service-module-mssql Patch
@powersync/service-module-mysql Patch
@powersync/service-module-postgres Patch
@powersync/service-image Minor
@powersync/service-module-core Patch
test-client Patch
@powersync/service-client Patch
@powersync/lib-service-postgres Patch

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant