diff --git a/.claude/CLAUDE.md b/.claude/CLAUDE.md index 02ffdb95..18e3a91b 100644 --- a/.claude/CLAUDE.md +++ b/.claude/CLAUDE.md @@ -154,9 +154,12 @@ Always use the left column. Never use the right. | Postgres | PostgreSQL | | partial sync | dynamic partial replication | | PowerSync Service | powersync service | +| the Service (short for the PowerSync Service) | the service | | Sync Rules | sync rules | | Sync Streams | sync streams | +When referring to the PowerSync Service in shortened form, write "the Service" (capitalized), never "the service". Generic services (a Docker Compose service, a third-party service) stay lowercase. + ## Mintlify Components ### When to Use What diff --git a/.claude/agents/document-reviewer.md b/.claude/agents/document-reviewer.md index b7d8a94e..2d23d312 100644 --- a/.claude/agents/document-reviewer.md +++ b/.claude/agents/document-reviewer.md @@ -38,8 +38,9 @@ These require judgment. Each item maps to a section of CLAUDE.md; apply the full 8. **Code examples**: language tag on every block; realistic data; no real secrets; filenames only on self-hosted examples; no SQL table aliases unless required. 9. **Links and navigation**: internal links use relative paths, never absolute URLs; new pages appear in `docs.json` navigation; moved or removed pages have redirects. 10. **Sync Streams policy**: no new content that teaches or promotes Sync Rules; where both appear side by side, the examples must return the same data with matching filters. In prose, "(or legacy Sync Rules)" is the approved pairing but only once per page or major section; later mentions omit Sync Rules. -11. **Technical accuracy**: flag claims, APIs, or examples you cannot verify. -12. **Legal and compliance content**: contractual or commercial terms may deviate from standard terminology (for example, "Synchronization Service" in the HIPAA shared-responsibility table). Don't "fix" these; outside legal contexts, the standard terms apply. +11. **"the Service" shorthand**: shortened references to the PowerSync Service are capitalized ("the Service", never "the service"). Generic services (a Docker Compose service, a third-party service) stay lowercase. Vale cannot distinguish these; judge from context. +12. **Technical accuracy**: flag claims, APIs, or examples you cannot verify. +13. **Legal and compliance content**: contractual or commercial terms may deviate from standard terminology (for example, "Synchronization Service" in the HIPAA shared-responsibility table). Don't "fix" these; outside legal contexts, the standard terms apply. ## Output Format diff --git a/.claude/skills/doc-author/SKILL.md b/.claude/skills/doc-author/SKILL.md index 9dfd5e7b..2133c075 100644 --- a/.claude/skills/doc-author/SKILL.md +++ b/.claude/skills/doc-author/SKILL.md @@ -78,6 +78,7 @@ The `description` and opening paragraph must not duplicate each other — the op | Postgres | PostgreSQL | | partial sync | dynamic partial replication | | PowerSync Service | powersync service | +| the Service (short for the PowerSync Service) | the service | | Sync Rules | sync rules | | Sync Streams | sync streams | diff --git a/.github/vale/config/vocabularies/PowerSync/accept.txt b/.github/vale/config/vocabularies/PowerSync/accept.txt index c850d0ba..fd042d00 100644 --- a/.github/vale/config/vocabularies/PowerSync/accept.txt +++ b/.github/vale/config/vocabularies/PowerSync/accept.txt @@ -4,6 +4,7 @@ addon addons agnostically allowlisting +anonymized autoscaling backpressure baz @@ -124,6 +125,7 @@ toolchains ttl uncomment uncheck +unicast unprovisioned unmounts unsynced @@ -313,6 +315,7 @@ WASQLite WinForms Windsurf WorkManager +Xata Xcode Yjs Zod diff --git a/client-sdks/full-text-search.mdx b/client-sdks/full-text-search.mdx index e93a3e18..86f2dd67 100644 --- a/client-sdks/full-text-search.mdx +++ b/client-sdks/full-text-search.mdx @@ -10,7 +10,7 @@ PowerSync supports full-text search using the [SQLite FTS5 extension](https://ww Full-text search has been demonstrated in the following SDKs: - [**Dart/Flutter SDK**](/client-sdks/reference/flutter): Uses the [sqlite_async](https://pub.dev/documentation/sqlite_async/latest/) package for migrations -- [**JavaScript Web SDK**](/client-sdks/reference/javascript-web): Requires version 0.5.0 or greater (including [wa-sqlite](https://github.com/powersync-ja/wa-sqlite) 0.2.0+) +- [**JavaScript Web SDK**](/client-sdks/reference/javascript-web) - [**React Native SDK**](/client-sdks/reference/react-native-and-expo): Requires additional configuration to enable FTS5, see [the README](https://www.npmjs.com/package/@powersync/react-native). - [**Swift SDK**](/client-sdks/reference/swift) diff --git a/client-sdks/reference/flutter.mdx b/client-sdks/reference/flutter.mdx index 89d8e2fa..045fc8f4 100644 --- a/client-sdks/reference/flutter.mdx +++ b/client-sdks/reference/flutter.mdx @@ -351,7 +351,7 @@ class TodosWidget extends StatelessWidget { ## Configure Logging -Since version 1.1.2 of the SDK, logging is enabled by default and outputs logs from PowerSync to the console in debug mode. +Logging is enabled by default and outputs logs from PowerSync to the console in debug mode. To disable this, or to configure logging in release-mode configurations, use the `logger` parameter on the `PowerSyncDatabase` constructor. PowerSync uses [`package:logging`](https://pub.dev/packages/logging) to emit logs. See that package for additional information. diff --git a/client-sdks/usage-examples.mdx b/client-sdks/usage-examples.mdx index 3c1a957e..a3cef62c 100644 --- a/client-sdks/usage-examples.mdx +++ b/client-sdks/usage-examples.mdx @@ -1001,7 +1001,7 @@ import JavaScriptCallbackWatch from '/snippets/basic-watch-query-javascript-call - Use the [hasSynced](https://pub.dev/documentation/powersync/latest/powersync/SyncStatus/hasSynced.html) property (available since version 1.5.1 of the SDK) and register a listener to indicate to the user whether the initial sync is in progress. + Use the [hasSynced](https://pub.dev/documentation/powersync/latest/powersync/SyncStatus/hasSynced.html) property and register a listener to indicate to the user whether the initial sync is in progress. ```dart // Example of using hasSynced to show whether the first sync has completed @@ -1043,7 +1043,7 @@ import JavaScriptCallbackWatch from '/snippets/basic-watch-query-javascript-call - Use the [hasSynced](https://powersync-ja.github.io/powersync-js/common/interfaces/SyncStatus#hassynced) property (available since version 1.4.1 of the SDK) and register an event listener with [PowerSyncDatabase.registerListener](https://powersync-ja.github.io/powersync-js/common/interfaces/CommonPowerSyncDatabase#registerlistener) to indicate to the user whether the initial sync is in progress. + Use the [hasSynced](https://powersync-ja.github.io/powersync-js/common/interfaces/SyncStatus#hassynced) property and register an event listener with [PowerSyncDatabase.registerListener](https://powersync-ja.github.io/powersync-js/common/interfaces/CommonPowerSyncDatabase#registerlistener) to indicate to the user whether the initial sync is in progress. ```js // Example of using hasSynced to show whether the first sync has completed @@ -1067,7 +1067,7 @@ import JavaScriptCallbackWatch from '/snippets/basic-watch-query-javascript-call - Use the [hasSynced](https://powersync-ja.github.io/powersync-js/common/interfaces/SyncStatus#hassynced) property (available since version 0.4.1 of the SDK) and register an event listener with [PowerSyncDatabase.registerListener](https://powersync-ja.github.io/powersync-js/common/interfaces/CommonPowerSyncDatabase#registerlistener) to indicate to the user whether the initial sync is in progress. + Use the [hasSynced](https://powersync-ja.github.io/powersync-js/common/interfaces/SyncStatus#hassynced) property and register an event listener with [PowerSyncDatabase.registerListener](https://powersync-ja.github.io/powersync-js/common/interfaces/CommonPowerSyncDatabase#registerlistener) to indicate to the user whether the initial sync is in progress. ```js // Example of using hasSynced to show whether the first sync has completed @@ -1155,7 +1155,7 @@ import JavaScriptCallbackWatch from '/snippets/basic-watch-query-javascript-call - Use the [HasSynced](https://powersync-ja.github.io/powersync-dotnet/api/PowerSync.Common.DB.Crud.SyncStatus.HasSynced.html) property (available since version 0.0.6-alpha.1 of the SDK) to indicate to the user whether the initial sync is in progress. + Use the [HasSynced](https://powersync-ja.github.io/powersync-dotnet/api/PowerSync.Common.DB.Crud.SyncStatus.HasSynced.html) property to indicate to the user whether the initial sync is in progress. ```cs using PowerSync.Common.Client; @@ -1174,7 +1174,6 @@ import JavaScriptCallbackWatch from '/snippets/basic-watch-query-javascript-call await db.WaitForFirstSync(); // Wait for a specific priority level to complete syncing - // The priority parameter is available since version 0.0.6-alpha.1 of the SDK var prioritySyncRequest = new PowerSyncDatabase.PrioritySyncRequest{ Priority = 1 }; await db.WaitForFirstSync(request: prioritySyncRequest); ``` @@ -1458,10 +1457,6 @@ import JavaScriptCallbackWatch from '/snippets/basic-watch-query-javascript-call You can show users a progress bar when data downloads using the `DownloadProgress()` method from the [SyncStatus](https://powersync-ja.github.io/powersync-dotnet/api/PowerSync.Common.DB.Crud.SyncStatus.html) class. `DownloadProgress().DownloadedFraction` gives you a value from 0.0 to 1.0 representing the total sync progress. This is especially useful for long-running initial syncs. - - **Version compatibility**: The `DownloadProgress()` method is available since version 0.0.6-alpha.1 of the SDK. The event listener uses `db.Events.OnStatusChanged.ListenAsync` (since v0.0.11-alpha.1). - - Example: ```cs diff --git a/configuration/powersync-service/cloud-instances.mdx b/configuration/powersync-service/cloud-instances.mdx index b0208d39..2e3e8db1 100644 --- a/configuration/powersync-service/cloud-instances.mdx +++ b/configuration/powersync-service/cloud-instances.mdx @@ -5,18 +5,34 @@ description: "Create and configure PowerSync Cloud instances with a database con --- import CreateCloudInstance from '/snippets/create-cloud-instance.mdx'; +import CreateCloudInstanceCli from '/snippets/create-cloud-instance-cli.mdx'; + +A PowerSync instance is a running deployment of the [PowerSync Service](/architecture/powersync-service): it replicates data from your source database and streams it to clients based on your [Sync Streams](/sync/streams/overview). On PowerSync Cloud, instances are hosted and managed for you, and you create and configure them in the [PowerSync Dashboard](https://dashboard.powersync.com) or with the [PowerSync CLI](/tools/cli). ## Create a PowerSync Instance - + + + + + + + + + + +## Configure Your Instance + +A new instance needs three things before clients can sync: -## Instance Settings +1. A connection to your source database. See [Source Database Connection](/configuration/source-db/connection). +2. Client authentication. See [Authentication Setup](/configuration/auth/overview). When getting started, you can use temporary [development tokens](/configuration/auth/development-tokens) instead of setting up a full auth provider. +3. A sync configuration defining what data syncs to which clients, written as [Sync Streams](/sync/streams/overview). -After creating an instance, you can configure various settings through the [PowerSync Dashboard](https://dashboard.powersync.com/): +In the Dashboard, each of these has its own view in the instance's sidebar. With the CLI, the database connection and client auth settings live in `service.yaml` and the sync configuration in `sync-config.yaml`; run `powersync deploy` to apply changes. -- **Database Connections**: Connect your instance to your source database. See [Source Database Connection](/configuration/source-db/connection) for details. -- **Client Auth**: Configure how clients authenticate. See [Authentication Setup](/configuration/auth/overview) for details. -- **Sync Streams / Sync Rules (legacy)**: Define what data to sync to clients. See [Sync Streams & Sync Rules Overview](/sync/overview) for details. -- **Settings**: Advanced instance-specific settings. +Other lower-level instance options, such as compacting buckets and deprovisioning, are available in the Dashboard under the instance's Settings view. The CLI has corresponding commands for most of these operations. -For more information about managing instances, see the [PowerSync Dashboard](/tools/powersync-dashboard) documentation. +For more information, see: +- [PowerSync Dashboard](/tools/powersync-dashboard) documentation +- [PowerSync CLI](/tools/cli) documentation diff --git a/configuration/powersync-service/self-hosted-instances.mdx b/configuration/powersync-service/self-hosted-instances.mdx index 5025a2fc..a58a489c 100644 --- a/configuration/powersync-service/self-hosted-instances.mdx +++ b/configuration/powersync-service/self-hosted-instances.mdx @@ -1,22 +1,21 @@ --- title: "Self-Hosted Instance Configuration" -description: "Configure self-hosted PowerSync Service deployments using YAML or environment variables." +description: "How to configure a self-hosted PowerSync Service instance with a config file, and a reference of all available options." sidebarTitle: "Self-Hosted Instances" --- -## Configuration Methods +A PowerSync instance is a running deployment of the [PowerSync Service](/architecture/powersync-service): it replicates data from your source database and streams it to clients based on your [Sync Streams](/sync/streams/overview). When self-hosting, you run the Service in your own infrastructure and configure each instance with a config file, as described below. -The PowerSync Service is configured using key/value pairs in a config file, and supports the following configuration methods: +## Configure Your Instance -1. Inject config as an environment variable (which contains the Base64 encoding of a config file) -2. Use a config file mounted on a volume -3. Specify the config as a command line parameter (again Base64 encoded) +A self-hosted instance needs four things before clients can sync: -Both YAML and JSON config files are supported. You can see examples of the above configuration methods in the [docker-compose](https://github.com/powersync-ja/self-host-demo/blob/d61cea4f1e0cc860599e897909f11fb54420c3e6/docker-compose.yaml#L46) file of our `self-host-demo` app. +1. A connection to your [source database](/configuration/source-db/setup), which PowerSync replicates data from. +2. A [bucket storage](/architecture/powersync-service#bucket-storage) database, where the PowerSync Service stores the data it prepares for syncing to clients. MongoDB and Postgres are supported. +3. [Client authentication](/configuration/auth/overview). When getting started, you can use temporary [development tokens](/configuration/auth/development-tokens) instead of setting up a full auth provider. +4. A sync configuration defining what data syncs to which clients, written as [Sync Streams](/sync/streams/overview). -## Configuration File Structure - -Below is a skeleton config file you can copy and paste to edit locally: +You define all of these in the main config file, along with some operational settings. We recommend keeping the sync configuration in a separate file that the main config references, though it can also be defined inline. The skeleton below shows the most common options; the [Configuration Reference](#configuration-reference) documents all of them. ```yaml service.yaml # Settings for source database replication @@ -51,11 +50,10 @@ storage: # uri: postgresql://powersync_storage_user:secure_password@storage-db:5432/postgres # sslmode: disable -# The port which the PowerSync API server will listen on -port: 80 +# The port which the PowerSync API server will listen on (defaults to 8080) +port: 8080 -# Specify Sync Streams or legacy Sync Rules (see Sync Streams section below). -# Referencing a separate file is recommended so you can edit streams/rules without nesting YAML. +# Sync configuration (see the sync_config section below) sync_config: path: sync-config.yaml @@ -71,96 +69,505 @@ client_auth: # JWKS audience audience: ['powersync-dev', 'powersync'] - # Settings for telemetry reporting - # See https://docs.powersync.com/maintenance-ops/self-hosting/usage-reporting - telemetry: - # Opt out of reporting anonymized usage metrics to PowerSync telemetry service - disable_telemetry_sharing: false +# Settings for telemetry reporting +# See https://docs.powersync.com/maintenance-ops/self-hosting/usage-reporting +telemetry: + # Opt out of reporting anonymized usage metrics to PowerSync telemetry service + disable_telemetry_sharing: false # System-level configuration options system: # Service logging configuration logging: - # Log level for the service logs + # Log level for the Service logs level: info # 'silly', 'debug', 'verbose', 'http', 'info', 'warn', 'error' format: text # 'json' or 'text' ``` -### Example + + The config used by our `self-host-demo` app. Use the demo as a working reference for your own setup. + -A detailed `service.yaml` config example with additional comments can be found here: +## Supplying the Config File - - - +Both YAML and JSON config files are supported. The PowerSync Service can read the config in three ways: -### Config File Schema +1. From a config file mounted on a volume +2. From an environment variable containing the Base64 encoding of the config file +3. From a command line parameter (also Base64 encoded) -The config file schema is available here: +You can see examples of these methods in the [docker-compose](https://github.com/powersync-ja/self-host-demo/blob/d61cea4f1e0cc860599e897909f11fb54420c3e6/docker-compose.yaml#L46) file of our `self-host-demo` app. - - - +### Environment Variable Substitution -## Source Database Connections +The config file uses custom tags for environment variable substitution. -Specify the connection to your source database in the `replication` section of the config file: +`!env [variable name]` substitutes the value of the environment variable named `[variable name]`. For example, with the environment variable `PS_MONGO_URI=mongodb://mongo:27017/powersync`, the YAML ```yaml service.yaml -# Settings for source database replication -replication: - # Specify database connection details - # Note only 1 connection is currently supported - # Multiple connection support is on the roadmap - connections: - - type: postgresql - # The PowerSync server container can access the Postgres DB via the DB's service name. - # In this case the hostname is pg-db +storage: + type: mongodb + uri: !env PS_MONGO_URI +``` - # The connection URI or individual parameters can be specified. - uri: postgresql://postgres:mypassword@pg-db:5432/postgres +resolves to `uri: mongodb://mongo:27017/powersync`. - # SSL settings - sslmode: disable # 'verify-full' (default) or 'verify-ca' or 'disable' - # Note: 'disable' is only suitable for local/private networks, not for public networks +Only environment variables with names starting with `PS_` can be substituted. + +Substituted values are strings. For options that expect a number or boolean, append `::number` or `::boolean` to the variable name to cast the value. A `::boolean` cast accepts `true` or `false`. + +```yaml service.yaml +storage: + max_pool_size: !env PS_STORAGE_POOL_SIZE::number + +telemetry: + disable_telemetry_sharing: !env PS_DISABLE_TELEMETRY::boolean ``` -For details on connecting to your source database, see [Connect PowerSync to Your Source Database](/intro/setup-guide#3-connect-powersync-to-your-source-database) in the Setup Guide. +## Configuration Reference + +The config file supports the following top-level keys, documented in the sections below: + +| Key | Purpose | +| ------------------------------ | --------------------------------------------------------------------------- | +| [`replication`](#replication) | Source database connection(s) to replicate from | +| [`storage`](#storage) | Bucket storage database connection | +| [`port`](#port) | Port for the PowerSync API server | +| [`sync_config`](#sync_config) | Sync Streams (or legacy Sync Rules) definition | +| [`client_auth`](#client_auth) | JWT authentication for client connections | +| [`api`](#api) | Admin API tokens and performance/safety limits | +| [`telemetry`](#telemetry) | Telemetry sharing and Prometheus metrics | +| [`healthcheck`](#healthcheck) | Health check probe mechanisms | +| [`migrations`](#migrations) | Storage database schema migration behavior | +| [`system`](#system) | Service logging | + + + + A machine-readable [JSON schema](https://unpkg.com/@powersync/service-schema@latest/json-schema/powersync-config.json) of the config file is available, published as `@powersync/service-schema`. + + Add this comment to the top of your YAML config file to get validation and autocomplete in editors that support the [YAML language server](https://github.com/redhat-developer/yaml-language-server) (for example VS Code with the YAML extension): + + ```yaml + # yaml-language-server: $schema=https://unpkg.com/@powersync/service-schema@latest/json-schema/powersync-config.json + ``` + + +### `replication` + +The `replication` section defines the source database that PowerSync replicates data from. Specify the connection details in `replication.connections`. Only one connection is currently supported; multiple connection support is on our roadmap. + +For instructions on preparing your source database, see [Source Database Setup](/configuration/source-db/setup). - If you are using hosted Supabase, you will need to enable IPv6 for Docker as per [the Docker docs](https://docs.docker.com/config/daemon/ipv6/) + Hosted Supabase only allows direct database connections over IPv6, and PowerSync cannot connect using the connection pooler. You can: + + - Enable IPv6 for Docker as per [the Docker docs](https://docs.docker.com/config/daemon/ipv6/). + - Enable IPv4 on your Supabase project. + - Run Supabase locally. + - If your host OS does not support Docker IPv6 e.g. macOS, you will need to run Supabase locally. +All connection types support these common options: + + + The connection type. One of `postgresql`, `mongodb`, `mysql`, `mssql`, or `convex`. + + + + Unique identifier for the connection. Optional when only a single connection is present. + + + + Additional meta tag for the connection, used for categorization or grouping. + + +The remaining options depend on the connection type: + + + + ```yaml service.yaml + replication: + connections: + - type: postgresql + uri: postgresql://postgres:mypassword@pg-db:5432/postgres + sslmode: verify-full + ``` + + + Connection URI in the format `postgresql://user:password@hostname:5432/database`. Individual connection parameters take precedence over values in the URI. + + + + Database hostname. Required if not specified in `uri`. + + + + Database port. + + + + Database username. Required if not specified in `uri`. + + + + Database password. Required if not specified in `uri`. + + + + Database name. Required if not specified in `uri`. + + + + SSL mode: `verify-full`, `verify-ca`, or `disable`. `disable` is only suitable for local/private networks, not for public networks. + + + + CA certificate content in PEM format. Required for `verify-ca`, optional for `verify-full`. + + + + Client certificate content in PEM format, for TLS client authentication. + + + + Client private key content in PEM format, for TLS client authentication. + + + + Use a servername for TLS that is different from `hostname`. + + + + Prefix for Postgres logical replication slot names and replication stream names. + + + + Maximum number of connections to the source database, per Service process. + + + + Connection timeout in seconds. Takes precedence over a `connect_timeout` query parameter in the URI. + + + + Idle timeout in seconds for snapshot connection sockets. If the storage database cannot keep up during the initial snapshot, a storage flush can stall the snapshot for longer than this timeout, which closes the source connection mid-snapshot. This appears in the Service logs as `Socket timed out` errors during the initial snapshot. Increase the timeout if you see these errors. Available since Service version 1.26.0. + + + + Interval in seconds between source connection heartbeats. Must be between 5 and 60. Available since Service version 1.24.0. + + + + + ```yaml service.yaml + replication: + connections: + - type: mongodb + uri: mongodb+srv://myuser:mypassword@cluster0.abcde.mongodb.net/mydatabase + post_images: auto_configure + ``` + + + Connection URI in the format `mongodb://` or `mongodb+srv://`. Standard connection options such as `connectTimeoutMS`, `socketTimeoutMS`, `serverSelectionTimeoutMS`, `maxPoolSize` and `maxIdleTimeMS` can be set as query parameters in the URI. + + + + Database name. Defaults to the database in the URI path. + + + + Database username. Defaults to the username in the URI. + + + + Database password. Defaults to the password in the URI. + + + + Controls how change stream post-images are used: `off`, `auto_configure`, or `read_only`. `auto_configure` is recommended for new instances. See [Post Images](/configuration/source-db/setup#post-images) for details on each option. + + + + Interval in seconds between source connection heartbeats. Must be between 5 and 60. Available since Service version 1.24.0. + + + + + MySQL support is currently in a [Beta release](/resources/feature-status). + + ```yaml service.yaml + replication: + connections: + - type: mysql + uri: mysql://repl_user:mypassword@mysql-db:3306/inventory + ``` + + + Connection URI in the format `mysql://user:password@hostname:3306/database`. Individual connection parameters take precedence over values in the URI. + + + + Database hostname. Required if not specified in `uri`. + + + + Database port. + + + + Database username. Required if not specified in `uri`. + + + + Database password. Required if not specified in `uri`. + + + + Database name. Required if not specified in `uri`. + + + + CA certificate content in PEM format. + + + + Client certificate content in PEM format, for TLS client authentication. + + + + Client private key content in PEM format, for TLS client authentication. + + + + The combined size in MB of binlog events that can be queued in memory before throttling is applied. + + + + + SQL Server support is currently in a [Beta release](/resources/feature-status). Also see [SQL Server Additional Configuration](/configuration/source-db/sql-server-additional-configuration). + + ```yaml service.yaml + replication: + connections: + - type: mssql + uri: mssql://powersync_user:mypassword@mssql-db:1433/inventory + ``` + + + Connection URI in the format `mssql://user:password@hostname:1433/database`. Individual connection parameters take precedence over values in the URI. + + + + Database hostname. Required if not specified in `uri`. + + + + Database port. + + + + Database username. Required if not specified in `uri` or `authentication`. + + + + Database password. Required if not specified in `uri` or `authentication`. + + + + Database name. Required if not specified in `uri`. + + + + The database schema to replicate from. + + + + CA certificate content in PEM format. Available since Service version 1.25.0. + + + + Use a servername for TLS that is different from `hostname`. Available since Service version 1.25.0. + + + + Alternative authentication configuration, instead of `username` and `password`. + + + Authentication method: `default` (SQL Server login) or `azure-active-directory-service-principal-secret`. + + + For `default`: `userName` and `password`. For `azure-active-directory-service-principal-secret`: `clientId`, `clientSecret` and `tenantId` from your registered Azure application. + + + + + + Additional replication settings. + + + Interval in milliseconds to wait between CDC polling cycles. + + + Maximum number of transactions to poll per polling cycle. + + + Whether to trust the server certificate. Set to `true` for local development and self-signed certificates. + + + + + + Interval in seconds between source connection heartbeats. Must be between 5 and 60. Available since Service version 1.24.0. + + + + + The Convex replicator is currently released as an [experimental feature](/resources/feature-status) and is available since Service version v1.22.0. See [Convex source database setup](/configuration/source-db/setup#convex). + + ```yaml service.yaml + replication: + connections: + - type: convex + deployment_url: https://happy-animal-123.convex.cloud + deploy_key: !env PS_CONVEX_DEPLOY_KEY + ``` + + + The URL of your Convex deployment. + + + + A deploy key for the Convex deployment, used to authenticate against the Convex Streaming Export API. + + + + Interval in milliseconds between polling for new changes. + + + + Timeout in milliseconds for requests to the Convex API. + + + + +### `storage` + +The PowerSync Service requires a storage database to store the data and metadata for [buckets](/architecture/powersync-service#bucket-system). You can use either MongoDB or Postgres for this purpose. - This is because Supabase only allows direct database connections over IPv6 — PowerSync cannot connect using the connection pooler. + + The _bucket storage database_ is separate from your _source database_. -## Bucket Storage Database + + The storage backend type: `mongodb` or `postgresql`. + -The PowerSync Service requires a storage database to store the data and metadata for [buckets](/architecture/powersync-service#bucket-system). You can use either MongoDB or Postgres for this purpose. The bucket storage database should be specified in the `storage` section of the config file: + + Maximum number of connections to the storage database, per Service process. + + + + Storage version to use when deploying a sync configuration that does not specify a storage version. You typically do not need to change this. See [Storage Version](/sync/advanced/compatibility#storage-version) for the available versions and how they interact with the sync configuration's `storage_version` field. Available since Service version 1.26.0. + + +#### MongoDB Storage ```yaml service.yaml -# Connection settings for bucket storage (MongoDB and Postgres are supported) storage: - # Option 1: MongoDB Storage type: mongodb uri: mongodb://mongo:27017/powersync_demo - # Use these if authentication is required. The user should have `readWrite` and `dbAdmin` roles - # username: myuser - # password: mypassword +``` - # Option 2: Postgres Storage - # type: postgresql - # This accepts the same parameters as a Postgres replication source connection - # uri: postgresql://powersync_storage_user:secure_password@storage-db:5432/postgres - # sslmode: disable + + Connection URI in the format `mongodb://` or `mongodb+srv://`. + + + + Database name. Defaults to the database in the URI path. + + + + Database username. Defaults to the username in the URI. See **Required Permissions** below for the roles the user needs. + + + + Database password. Defaults to the password in the URI. + + + + Throttles the clearing of old bucket data after deploying a new sync configuration, by pausing between batches. The pause is proportional to the previous batch duration. Increase this to reduce the impact of clear operations on the storage cluster, or use `0` to clear as fast as possible. Must be between 0 and 20. Available since Service version 1.24.0. + + + + Read preference for bulk checksum and bucket data reads: `primary`, `primaryPreferred`, `secondary`, `secondaryPreferred`, or `nearest`. If unset, MongoDB driver defaults are used. This is an experimental option and may be removed in a future release. Available since Service version 1.23.2. + + + + Experimental support for storing large bucket data chunks in S3-compatible object storage instead of MongoDB. Available since Service version 1.24.0. Requires storage version 3, which is not the default. Set `storage_version: 3` under the `config` block of your sync config, as described in [Storage Version](/sync/advanced/compatibility#optional-config-storage_version). + + + + Must be `s3`. + + + Name of the S3 bucket. + + + Region of the S3 bucket. + + + Key prefix for stored objects. + + + Custom endpoint, for S3-compatible object storage providers. + + + Use path-style addressing, required by some S3-compatible providers. + + + Access key ID for authentication. + + + Secret access key for authentication. + + + Maximum number of concurrent object storage requests. + + + Sets the timeouts for all object storage requests at once, based on the expected latency between the Service and the object storage endpoint, mirroring the AWS SDK's [smart configuration defaults](https://docs.aws.amazon.com/sdkref/latest/guide/feature-smart-config-defaults.html). `standard` is safe for most deployments, so you can usually leave this unset. Use `in-region` when the Service and the bucket run in the same region and you want stalled requests to fail faster, or `mobile` when the endpoint is slow enough that the standard timeouts cause spurious failures. `cross-region` is accepted for compatibility with the AWS SDK. + + When this option is unset, the Service reads the `AWS_DEFAULTS_MODE` environment variable, then falls back to `standard`. Setting `defaults_mode` in an AWS shared config file has no effect. Available since Service version 1.26.0. + + + Chunks smaller than this byte threshold stay inline in MongoDB instead of being offloaded to object storage. + + + + +##### Required Permissions + +The Service creates and manages all collections and indexes in the storage database itself, so no manual schema setup is needed. When authentication is enabled, the user needs the built-in `readWrite` and `dbAdmin` roles on the storage database: + +``` +readWrite@ +dbAdmin@ ``` - - The _bucket storage database_ is separate from your _source database_. - +No access beyond the storage database is required. The `readWrite` role covers regular operation, including creating and dropping collections and indexes. The `dbAdmin` role is additionally needed to drop the database when an instance is torn down. -### MongoDB Storage +Create the user with: + +```javascript +use powersync_demo +db.createUser({ + user: "powersync_storage_user", + pwd: "secure_password", + roles: ["readWrite", "dbAdmin"] +}) +``` + +MongoDB authenticates against the database where the user was created, so creating the user in the storage database itself works with the connection URI shown above. If you create the user in a different database, such as `admin`, add `authSource=admin` to the connection URI. On MongoDB Atlas, assign the same two roles restricted to the storage database. + +##### Replica Set Requirement MongoDB requires at least one replica set node. A single node is fine for development/staging environments, but a 3-node replica set is recommended [for production](/maintenance-ops/self-hosting/deployment-architecture) deployments. @@ -174,7 +581,7 @@ mongosh "mongodb+srv://powersync.abcdef.mongodb.net/" --apiVersion 1 --username If you are rolling your own Docker environment, you can include this init script in your `docker-compose` file to configure a replica set as once-off operation: -```yaml +```yaml docker-compose.yaml # Initializes the MongoDB replica set. This service will not usually be actively running mongo-rs-init: image: mongo:7.0 @@ -187,11 +594,34 @@ If you are rolling your own Docker environment, you can include this init script - 'sleep 10 && mongosh --host mongo:27017 --eval ''try{rs.status().ok && quit(0)} catch {} rs.initiate({_id: "rs0", version: 1, members: [{ _id: 0, host : "mongo:27017" }]})''' ``` -### Postgres Storage +#### Postgres Storage -Available since version 1.3.8 of the [`powersync-service`](https://hub.docker.com/r/journeyapps/powersync-service), you can use Postgres as an alternative bucket storage database. +You can use Postgres as an alternative bucket storage database. + +```yaml service.yaml +storage: + type: postgresql + uri: postgresql://powersync_storage_user:secure_password@storage-db:5432/postgres +``` -#### Database Setup +Postgres storage accepts the same connection options as a [Postgres replication connection](#replication): `uri`, `hostname`, `port`, `username`, `password`, `database`, `sslmode`, `cacert`, `client_certificate`, `client_private_key`, `tls_servername` and `connect_timeout`. In addition, batch limits can be tuned: + + + Limits for batch operations during replication. Increasing these limits can improve replication performance, at the cost of higher memory usage. + + + Maximum estimated byte size of operations written in a single transaction. + + + Maximum number of records written in a single transaction. + + + Maximum byte size of `current_data` documents looked up at a time. + + + + +##### Database Setup You'll need to create a dedicated user and schema for PowerSync bucket storage. You can either: @@ -213,11 +643,9 @@ GRANT USAGE ON SCHEMA powersync TO powersync_storage_user; GRANT ALL PRIVILEGES ON ALL TABLES IN SCHEMA powersync TO powersync_storage_user; ``` -#### Demo App - A demo app with Postgres bucket storage is available [here](https://github.com/powersync-ja/self-host-demo/tree/main/demos/nodejs-postgres-bucket-storage). -#### Postgres Version Requirements +##### Postgres Version Requirements Separate Postgres servers are required for replication connections (i.e. source database) and bucket storage **if using Postgres versions below 14**. @@ -226,17 +654,25 @@ Separate Postgres servers are required for replication connections (i.e. source | Below 14 | Separate servers are required for the source and bucket storage. Replication will be blocked if the same server is detected. | | 14 and above | The source database and bucket storage database can be on the same server. Using the same database (with separate schemas) is supported but may lead to higher CPU usage. Using separate servers remains an option. | -## Sync Streams +### `port` -Your Sync Streams (or legacy Sync Rules) configuration can be in a separate file (recommended) or inline in the main config. The `sync_config:` key is used for both Sync Streams and Sync Rules. +The `port` setting determines where clients and tools connect to your instance. Change it if the default conflicts with another service in your deployment. - - **Separate file**: Referencing a file with `path:` keeps your main config tidy and makes editing Sync Streams/Sync Rules easier. Ensure the file is available at that path (e.g. in the same directory as your main config or on a mounted volume). - + + The port on which the PowerSync API server will listen for connections. Can be specified as a number or string. + + +### `sync_config` + +The `sync_config` section points the Service at your [Sync Streams](/sync/streams/overview) (or legacy [Sync Rules](/sync/rules/overview)) definition, usually a separate file referenced with `path`: -```yaml Sync Streams — Separate File (Recommended) -# sync-config.yaml (reference from main config with sync_config: path: sync-config.yaml) +```yaml service.yaml +sync_config: + path: sync-config.yaml +``` + +```yaml sync-config.yaml config: edition: 3 streams: @@ -244,57 +680,25 @@ streams: auto_subscribe: true query: SELECT * FROM todos WHERE owner_id = auth.user_id() ``` - -```yaml Sync Streams — Inline -sync_config: - content: | - config: - edition: 3 - streams: - todos: - auto_subscribe: true - query: SELECT * FROM todos WHERE owner_id = auth.user_id() -``` - -```yaml Sync Rules — Separate File (Legacy) -# sync-config.yaml (reference from main config with sync_config: path: sync-config.yaml) -bucket_definitions: - global: - data: - - SELECT * FROM lists - - SELECT * FROM todos -``` - -```yaml Sync Rules — Inline (Legacy) -sync_config: - content: | - bucket_definitions: - global: - data: - - SELECT * FROM lists - - SELECT * FROM todos -``` -For more information, see [Sync Streams](/sync/streams/overview) (recommended) or [Sync Rules](/sync/rules/overview) (legacy). - - - To verify that your Sync Rules are functioning correctly, inspect the contents of your bucket storage database. + + Path to the sync configuration YAML file. Ensure the file is available at that path, e.g. in the same directory as your main config or on a mounted volume. + - #### MongoDB Example + + The sync configuration inline as a string, as an alternative to `path`. + - If you are running MongoDB in Docker, run the following: + + Whether to exit the process if there is an error parsing the sync configuration. + - ```bash - docker exec -it {MongoDB container name} mongosh "mongodb://{MongoDB service host}/{MongoDB database name}" --eval "db.bucket_data.find().pretty()" - # Example - docker exec -it self-host-demo-mongo-1 mongosh "mongodb://localhost:27017/powersync_demo" --eval "db.bucket_data.find().pretty()" - ``` - +The top-level `sync_rules` key is a deprecated alias for `sync_config`. Use `sync_config` in new configurations. -## Client Authentication +### `client_auth` -Client authentication is configured in the `client_auth` section: +The `client_auth` section defines how the Service verifies your app's users when they connect to sync. Clients authenticate with JWTs, which the Service validates using the settings here. For more details, see [Client Authentication](/configuration/auth/overview). ```yaml service.yaml client_auth: @@ -318,22 +722,115 @@ client_auth: audience: ['powersync-dev', 'powersync'] ``` - - For production environments, we recommend using JWKS with asymmetric keys (RS256, EdDSA, or ECDSA) rather than shared secrets (HS256). Asymmetric keys provide better security through public/private key separation and easier key rotation. See [Custom Authentication](/configuration/auth/custom) for more details. - - -For more details, see [Client Authentication](/configuration/auth/overview). + + URI or array of URIs pointing to JWKS endpoints, used to fetch public keys for JWT verification. + -## Environment Variables + + Inline JWKS configuration, as an alternative or in addition to `jwks_uri`. + + + An array of JSON Web Keys (JWKs). Supported key types are RSA (`RS256`, `RS384`, `RS512`), HMAC (`HS256`, `HS384`, `HS512`), OKP (`EdDSA` with `Ed25519` or `Ed448`) and EC (`ES256`, `ES384`, `ES512` with curves `P-256`, `P-384` or `P-521`). See [Custom Authentication](/configuration/auth/custom) for details. + + + -The config file uses custom tags for environment variable substitution. + + Enables Supabase authentication integration. JWKS details are derived from the Supabase connection. See [Supabase Auth](/configuration/auth/supabase-auth). + -Using `!env [variable name]` will substitute the value of the environment variable named `[variable name]`. + + Legacy JWT secret for Supabase authentication (HS256 shared secret). + -Only environment variables with names starting with `PS_` can be substituted. + + Valid audiences for JWT validation. + -See examples here: + + For production environments, we recommend using JWKS with asymmetric keys (RS256, EdDSA, or ECDSA) rather than shared secrets (HS256). Asymmetric keys provide better security through public/private key separation and easier key rotation. See [Custom Authentication](/configuration/auth/custom) for more details. + - - - \ No newline at end of file +### `api` + +The `api` section protects the Service's admin API routes with access tokens, and sets limits that protect the Service from excessive load. Configure `tokens` if you use the [PowerSync CLI](/tools/cli) against this instance; the limits rarely need changing. + + + Access tokens for the Service's admin API routes, provided by clients as a Bearer token. If no tokens are configured, the admin API routes reject all requests. + + + + Performance and safety parameters for the API. + + + Maximum number of connections (HTTP streams or WebSockets) per API process. + + + Maximum concurrency when fetching data from storage. This should not be significantly more than `storage.max_pool_size`, otherwise it would block on the pool. Increasing this can significantly increase memory usage in some cases. + + + Maximum number of buckets for each connection. More buckets increase latency and memory usage. While the actual number is controlled by your sync configuration, this hard limit ensures that the Service errors instead of crashing when the sync configuration is misconfigured. + + + Related to `max_buckets_per_connection`, but this limit applies directly to parameter query results, before they are converted into a unique set of buckets. + + + Number of minutes to keep client-requested write checkpoint records. Expired records are removed by the compact job. Must be a positive integer. Available since Service version 1.24.0. + + + How long to keep cached bucket counts before refreshing them, in minutes. Bucket counts may be affected by compacting. Available since Service version 1.23.2. + + + + +### `telemetry` + +The `telemetry` section controls the operational metrics the Service shares with PowerSync and exposes for your own monitoring. See [Usage Reporting](/maintenance-ops/self-hosting/usage-reporting) and [Monitoring](/maintenance-ops/self-hosting/monitoring) for details. + + + When `true`, disables sharing of anonymized usage metrics with the PowerSync telemetry service. + + + + Port on which Prometheus metrics will be exposed. When set, metrics will be available on this port for scraping. + + +### `healthcheck` + +Configures how health check status is exposed. See [Health Checks](/maintenance-ops/self-hosting/healthchecks) for details on the available probes and endpoints. + + + Mechanisms for exposing health check data. If this is not configured, the Service defaults to legacy behavior for backwards compatibility (filesystem probes always enabled, plus HTTP probes depending on the Service mode). When `probes` is configured, each mechanism requires explicit opt-in. + + + Enables exposing health check status via filesystem files. + + + Enables exposing health check status via HTTP endpoints. + + + + +### `migrations` + +The `migrations` section controls whether the Service updates its bucket storage database schema automatically when a new version starts up. Most deployments can keep the default automatic behavior. + + + When `true`, disables automatic storage database schema migrations on startup. Migrations can then be triggered externally by altering the container `command`. + + +### `system` + +The `system` section configures how the Service itself runs. Currently this covers logging. + + + Service logging configuration. + + + Log level for the Service logs: `silly`, `debug`, `verbose`, `http`, `info`, `warn`, or `error`. The `PS_LOG_LEVEL` environment variable takes precedence over this option. + + + Log output format: `json` or `text`. Defaults to `text`, or to `json` when the `NODE_ENV` environment variable is set to `production`. The `PS_LOG_FORMAT` environment variable takes precedence over this option. + + + diff --git a/configuration/source-db/connection.mdx b/configuration/source-db/connection.mdx index 1cbd4cee..f5ef12e5 100644 --- a/configuration/source-db/connection.mdx +++ b/configuration/source-db/connection.mdx @@ -9,7 +9,7 @@ Each database provider has their quirks when it comes to specifying connection d Jump to: [Postgres](#postgres-provider-specifics) | [MongoDB](#mongodb-specifics) | [MySQL](#mysql-specifics) | [SQL Server](#sql-server-specifics) | [Convex](#convex-specifics) -The below instructions are currently written for PowerSync Cloud. For self-hosted PowerSync instances, specify database connection details in the config file as documented [here](/configuration/powersync-service/self-hosted-instances#source-database-connections). +The below instructions are currently written for PowerSync Cloud. For self-hosted PowerSync instances, specify database connection details in the config file as documented [here](/configuration/powersync-service/self-hosted-instances#replication). ## Postgres Provider Specifics diff --git a/configuration/source-db/setup.mdx b/configuration/source-db/setup.mdx index c6deef56..89222ad5 100644 --- a/configuration/source-db/setup.mdx +++ b/configuration/source-db/setup.mdx @@ -269,7 +269,11 @@ Due to the logical replication requirement, not all Postgres hosting providers a For more information on migrating from MongoDB Atlas Device Sync to PowerSync, see our [migration guide](/migration-guides/atlas-device-sync). PowerSync also supports **Azure DocumentDB** (formerly Azure Cosmos DB for MongoDB vCore) through this same MongoDB connector, as an [experimental](/resources/feature-status) feature. See [Azure DocumentDB](#azure-documentdb-cosmos-db-for-mongodb-vcore) below for supported variants and limitations. -### Permissions Required: MongoDB Atlas +### MongoDB Permissions + +The permissions PowerSync requires depend on whether you use MongoDB Atlas built-in roles, or a custom role on either self-hosted MongoDB or Atlas. + +#### Permissions Required: MongoDB Atlas For MongoDB Atlas databases, the minimum permissions when using built-in roles are: @@ -292,7 +296,7 @@ If you are replicating from multiple databases in the cluster, you need read per readAnyDatabase@admin ``` -### Privileges Required: Self-Hosted / Custom Roles +#### Privileges Required: Self-Hosted or Custom Roles For self-hosted MongoDB, or for creating custom roles on MongoDB Atlas, PowerSync requires the following privileges/granted actions: @@ -807,6 +811,6 @@ Next, connect PowerSync to your database: - + diff --git a/debugging/error-codes.mdx b/debugging/error-codes.mdx index 36bd2084..affbf86b 100644 --- a/debugging/error-codes.mdx +++ b/debugging/error-codes.mdx @@ -197,7 +197,7 @@ This reference documents PowerSync error codes organized by component, with trou - **PSYNC_S1307**: MongoDB authorization error. - Check that the user has the required privileges. + Check that the user has the required privileges. See the required permissions for the [MongoDB source database](/configuration/source-db/setup#mongodb-permissions) or the [MongoDB storage database](/configuration/powersync-service/self-hosted-instances#mongodb-storage), depending on which connection reported the error. - **PSYNC_S1341**: Sharded MongoDB Clusters are not supported yet. @@ -233,6 +233,8 @@ This reference documents PowerSync error codes organized by component, with trou This may happen if there is a significant delay on the source database in reading the change stream. If this is not resolved after retries, replication may need to be restarted from scratch. + + To help avoid this error, the Service writes periodic heartbeats to the `_powersync_checkpoints` collection when the change stream has not advanced recently. For self-hosted instances, the heartbeat frequency can be tuned with the `heartbeat_interval_seconds` [connection option](/configuration/powersync-service/self-hosted-instances#replication). - **PSYNC_S1346**: Failed to read MongoDB Change Stream. diff --git a/debugging/troubleshooting.mdx b/debugging/troubleshooting.mdx index be548c60..b4c7b0d7 100644 --- a/debugging/troubleshooting.mdx +++ b/debugging/troubleshooting.mdx @@ -79,7 +79,7 @@ Our client SDKs support logging to troubleshoot issues. Here's how to enable log * **JavaScript-based SDKs** (Web, React Native, and Node.js) - Implement the `PowerSyncLogger` interface, or use `createConsoleLogger()`. For example: `const logger = createConsoleLogger({ minLevel: LogLevels.debug })`. Pass the logger to `PowerSyncDatabase` via the `logger` option. For the Web SDK, you can also enable the `debugMode` flag to log SQL queries on Chrome's Performance timeline. -* **Dart/Flutter SDK** - Logging is enabled by default since version 1.1.2 and outputs logs to the console in debug mode. +* **Dart/Flutter SDK** - Logging is enabled by default and outputs logs to the console in debug mode. * **Kotlin SDK** - Uses [Kermit Logger](https://kermit.touchlab.co/docs/). By default shows `Warnings` in release and `Verbose` in debug mode. diff --git a/intro/setup-guide.mdx b/intro/setup-guide.mdx index 4ecd0a20..d165c6cd 100644 --- a/intro/setup-guide.mdx +++ b/intro/setup-guide.mdx @@ -16,6 +16,7 @@ import SwiftInstallation from '/snippets/swift/installation.mdx'; import DotnetInstallation from '/snippets/dotnet/installation.mdx'; import RustInstallation from '/snippets/rust/installation.mdx'; import DevTokenSelfHostedSteps from '/snippets/dev-token-self-hosted-steps.mdx'; +import CreateCloudInstanceCli from '/snippets/create-cloud-instance-cli.mdx'; ## 1. Configure Your Source Database @@ -198,23 +199,9 @@ PowerSync is available as a cloud-hosted service (PowerSync Cloud) or can be sel If you haven't yet, sign up for a free PowerSync Cloud account [here](https://accounts.powersync.com/portal/powersync-signup?s=docs). - Install the [PowerSync CLI](/tools/cli) (requires Node.js/npm), then log in and scaffold the config directory: + - ```bash - npm install -g powersync - powersync login - powersync init cloud - ``` - - This creates a `powersync/` directory with `service.yaml` (instance name, region, connection, auth) and `sync-config.yaml` (sync config). Edit `powersync/service.yaml` to set your instance name and region. You'll configure the database connection in the next step. - - Then create the Cloud instance: - - ```bash - powersync link cloud --create --project-id= - ``` - - Find your project ID in the [PowerSync Dashboard](https://dashboard.powersync.com) URL, or run `powersync fetch instances` after logging in. + You'll configure the database connection in the next step. @@ -587,7 +574,7 @@ streams: path: sync-config.yaml ``` - Put your streams in `sync-config.yaml` (see [Self-Hosted Instance Configuration](/configuration/powersync-service/self-hosted-instances#sync-streams) for full examples). Alternatively, you can use inline `content: |` with the YAML nested under `sync_config`. + Put your streams in `sync-config.yaml` (see [Self-Hosted Instance Configuration](/configuration/powersync-service/self-hosted-instances#sync_config) for full examples). Alternatively, you can use inline `content: |` with the YAML nested under `sync_config`. diff --git a/maintenance-ops/self-hosting/aws-ecs.mdx b/maintenance-ops/self-hosting/aws-ecs.mdx index 6f873ab1..3852fabc 100644 --- a/maintenance-ops/self-hosting/aws-ecs.mdx +++ b/maintenance-ops/self-hosting/aws-ecs.mdx @@ -32,7 +32,7 @@ Your configuration must include: telemetry: prometheus_port: 9090 ``` -- [Bucket Storage](/configuration/powersync-service/self-hosted-instances#bucket-storage-database): Connection details for your bucket storage database. PowerSync supports MongoDB or Postgres as bucket storage databases. In this guide, we focus on MongoDB. +- [Bucket Storage](/configuration/powersync-service/self-hosted-instances#storage): Connection details for your bucket storage database. PowerSync supports MongoDB or Postgres as bucket storage databases. In this guide, we focus on MongoDB. For bucket storage, we recommend configuring an **AWS PrivateLink** to establish a secure, private connection between your ECS tasks and MongoDB Atlas that doesn't traverse the public internet. diff --git a/snippets/create-cloud-instance-cli.mdx b/snippets/create-cloud-instance-cli.mdx new file mode 100644 index 00000000..c00b418d --- /dev/null +++ b/snippets/create-cloud-instance-cli.mdx @@ -0,0 +1,17 @@ +Install the [PowerSync CLI](/tools/cli) (requires Node.js/npm), then log in and scaffold the config directory: + +```bash +npm install -g powersync +powersync login +powersync init cloud +``` + +This creates a `powersync/` directory with `service.yaml` (instance name, region, connection, auth) and `sync-config.yaml` (sync config). Edit `powersync/service.yaml` to set your instance name and region. + +Then create the instance and link the directory to it: + +```bash +powersync link cloud --create --project-id= +``` + +Find your project ID in the [PowerSync Dashboard](https://dashboard.powersync.com) URL, or run `powersync fetch instances` after logging in. diff --git a/sync/advanced/compatibility.mdx b/sync/advanced/compatibility.mdx index 55672bf6..ebad7620 100644 --- a/sync/advanced/compatibility.mdx +++ b/sync/advanced/compatibility.mdx @@ -58,7 +58,7 @@ streams: ## Storage Version -The PowerSync Service stores replicated bucket data in [bucket storage](/architecture/powersync-service#bucket-storage). That data uses a storage version that can evolve when you deploy new Sync Streams or Sync Rules. This versioning approach avoids large upfront migrations on existing bucket data when the Service introduces bigger storage changes. Each time your sync config is deployed and processed, the bucket data written for that deployment uses a specific storage version. +The PowerSync Service stores replicated bucket data in [bucket storage](/architecture/powersync-service#bucket-storage). That data uses a storage version that can evolve when you deploy new Sync Streams. This versioning approach avoids large upfront migrations on existing bucket data when the Service introduces bigger storage changes. Each time your sync config is deployed and processed, the bucket data written for that deployment uses a specific storage version. ### Optional `config.storage_version` @@ -67,7 +67,7 @@ You can pin the bucket storage version by setting it under the `config` block: ```yaml config: edition: 3 - storage_version: 2 # version 2 (stable) and 3 (unstable) are currently supported + storage_version: 2 # version 2 (stable) and 3 (experimental) are currently supported streams: todos: @@ -79,15 +79,15 @@ streams: In most deployments you can omit `storage_version`. The PowerSync Service then uses the latest stable storage version it supports. You should only set this field if you need more control, e.g.: 1. Service downgrade: If you need to run an older Service version that only supports up to a given storage version, deploy sync config with that `storage_version`, wait until reprocessing for that deployment has finished, then downgrade the Service. -2. Experiments: Opt into an odd, unstable storage version in non-production environments. +2. Experiments: Opt into an experimental storage version in non-production environments. 3. Delaying a storage upgrade: Change other sync config while keeping bucket data on an older stable storage version until you are ready for the newer format. ### Stable and Experimental Versions -The service distinguishes stable and experimental storage versions as follows: +The Service distinguishes stable and experimental storage versions as follows: - Even numbers (for example `2`, `4`) denote stable formats. Once a stable version is supported, newer Service releases are expected to keep supporting it until it is officially deprecated. -- Odd numbers (for example `3`) denote unstable formats. The layout may change without notice and support may be removed in a future release. Use odd versions only for testing, not production. +- Odd numbers (for example `3`) denote experimental formats. The layout may change without notice and support may be removed in a future release. Use odd versions only for testing, not production. ## Supported Fixes diff --git a/sync/streams/overview.mdx b/sync/streams/overview.mdx index 76160f45..3ec4013c 100644 --- a/sync/streams/overview.mdx +++ b/sync/streams/overview.mdx @@ -51,7 +51,7 @@ streams: query: SELECT * FROM todos WHERE owner_id = auth.user_id() ``` -You can also use inline `sync_config: content: |` with the YAML nested in your main config. See [Self-Hosted Instance Configuration](/configuration/powersync-service/self-hosted-instances#sync-streams) for both options. +You can also use inline `sync_config: content: |` with the YAML nested in your main config. See [Self-Hosted Instance Configuration](/configuration/powersync-service/self-hosted-instances#sync_config) for both options.