Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
4 changes: 1 addition & 3 deletions sync/rules/migrate-to-sync-streams.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -18,9 +18,7 @@ If your Sync Config has a `bucket_definitions:` section, you use Sync Rules and

## Why Migrate?

{/* TODO: Link to the Sync Rules deprecation announcement once it is published. */}

Sync Rules are deprecated, and PowerSync is phasing them out in favor of Sync Streams. Beyond matching Sync Rules, Sync Streams add:
Sync Rules are deprecated, and PowerSync is phasing them out in favor of Sync Streams. See [our plan for phasing out Sync Rules](https://releases.powersync.com/announcements/our-plan-for-phasing-out-sync-rules) for the full timeline. Beyond matching Sync Rules, Sync Streams add:

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Same unverifiable claim as in sync/rules/overview.mdx: I can't reach this URL from the review environment to confirm the page is live and actually contains the timeline it's promising. Please verify before merging.


- **More expressive queries:** Stream queries support JOINs, [CTEs](/sync/streams/ctes), subqueries, and [multiple queries per stream](/sync/streams/queries#multiple-queries-per-stream), with syntax closer to plain SQL. You write one query instead of separate `parameters:` and `data:` blocks.
- **On-demand syncing:** Define a stream once, then subscribe from your app one or more times with different parameters. Each subscription has its own lifecycle, so two screens or browser tabs can subscribe to the same stream independently. With Sync Rules, Client Parameters approximate this. You have to aggregate the parameter values yourself across screens and tabs, and remove them when they are no longer needed.
Expand Down
4 changes: 1 addition & 3 deletions sync/rules/overview.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -6,12 +6,10 @@ description: "Understand legacy Sync Rules for controlling which data syncs to e

Sync Rules are PowerSync's original system for <Tooltip tip="Syncing only the relevant subset of data to each client, instead of the entire database.">partial sync</Tooltip>, using YAML bucket definitions.

{/* TODO: Link to the Sync Rules deprecation announcement on releases.powersync.com once it is published. */}

<Warning>
**Sync Rules are deprecated**

PowerSync is phasing out Sync Rules in favor of [Sync Streams](/sync/streams/overview), which support everything Sync Rules do and add on-demand syncing, JOINs, CTEs, and subqueries. Nothing changes for your instance today: Sync Rules keep working and stay supported while you migrate. New Sync Config features are added to Sync Streams only.
PowerSync is phasing out Sync Rules in favor of [Sync Streams](/sync/streams/overview), which support everything Sync Rules do and add on-demand syncing, JOINs, CTEs, and subqueries. Nothing changes for your instance today: Sync Rules keep working and stay supported while you migrate. New Sync Config features are added to Sync Streams only. See [our plan for phasing out Sync Rules](https://releases.powersync.com/announcements/our-plan-for-phasing-out-sync-rules) for the full timeline.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I can't reach releases.powersync.com from this review environment, so I can't confirm the linked announcement is live or that it actually contains a timeline. Please confirm the page is published and covers the timeline before merging, and link straight to the timeline section if the page has one.


To migrate, click **Migrate to Sync Streams** in the PowerSync Dashboard, or run `powersync migrate sync-rules` in the CLI to convert your current config. Migrating does not change what your app syncs. See [Migrate to Sync Streams](/sync/rules/migrate-to-sync-streams).
</Warning>
Expand Down
Loading