Skip to content
Draft
552 changes: 500 additions & 52 deletions client-sdks/advanced/raw-tables.mdx

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion client-sdks/reference/capacitor.mdx
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: "Capacitor SDK (alpha)"
description: "Full SDK guide for using PowerSync in Capacitor clients"
sidebarTitle: "Capacitor"
sidebarTitle: "SDK Reference"
---

import SdkFeatures from '/snippets/sdk-features.mdx';
Expand Down
2 changes: 1 addition & 1 deletion client-sdks/reference/javascript-web.mdx
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: "JavaScript Web SDK"
description: "Full SDK guide for using PowerSync in JavaScript Web clients"
sidebarTitle: "JavaScript Web"
sidebarTitle: "SDK Reference"
---

import SdkFeatures from '/snippets/sdk-features.mdx';
Expand Down
2 changes: 1 addition & 1 deletion client-sdks/reference/node.mdx
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: "Node.js client SDK (Beta)"
description: "SDK reference for using PowerSync in Node.js clients."
sidebarTitle: "Node.js"
sidebarTitle: "SDK Reference"
---

import SdkFeatures from '/snippets/sdk-features.mdx';
Expand All @@ -12,7 +12,7 @@
import LocalOnly from '/snippets/local-only-escape.mdx';

<Note>
This page describes the PowerSync _client_ SDK for Node.js.

Check warning on line 15 in client-sdks/reference/node.mdx

View check run for this annotation

Mintlify / Mintlify Validation (powersync) - vale-spellcheck

client-sdks/reference/node.mdx#L15

Did you really mean '_client_'?
If you're interested in using PowerSync for your Node.js backend, no special package is required.
Instead, follow our guides on [app backend setup](/configuration/app-backend/setup).
</Note>
Expand Down Expand Up @@ -299,9 +299,9 @@
```

<Note>
If you're using a custom compilation toolchain, for instance because you're compiling from TypeScript

Check warning on line 302 in client-sdks/reference/node.mdx

View check run for this annotation

Mintlify / Mintlify Validation (powersync) - vale-spellcheck

client-sdks/reference/node.mdx#L302

Did you really mean 'toolchain'?
or are applying a bundler to your project, loading workers may require additional configuration on that

Check warning on line 303 in client-sdks/reference/node.mdx

View check run for this annotation

Mintlify / Mintlify Validation (powersync) - vale-spellcheck

client-sdks/reference/node.mdx#L303

Did you really mean 'bundler'?
toolchain.

Check warning on line 304 in client-sdks/reference/node.mdx

View check run for this annotation

Mintlify / Mintlify Validation (powersync) - vale-spellcheck

client-sdks/reference/node.mdx#L304

Did you really mean 'toolchain'?
</Note>

### `node:sqlite`
Expand Down
3 changes: 1 addition & 2 deletions configuration/auth/development-tokens.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -30,8 +30,7 @@
</Tab>

<Tab title="Self-Hosted">
For self-hosted setups, you can generate development tokens using the [powersync-service test-client](https://github.com/powersync-ja/powersync-service/tree/main/test-client):

Follow the steps below. Steps 1 and 2 configure signing keys and your PowerSync Service config; in Step 3 you can use the PowerSync CLI (recommended) or the [test-client](https://github.com/powersync-ja/powersync-service/tree/main/test-client) to generate the token.

<DevTokenSelfHostedSteps />
</Tab>
Expand All @@ -47,7 +46,7 @@

1. Open the [Sync Diagnostics Client](https://diagnostics-app.powersync.com)
2. Enter the generated development token at **PowerSync Token**.
3. Enter your PowerSync Service endpoint URL at **PowerSync Endpoint** unless already prepopulated.

Check warning on line 49 in configuration/auth/development-tokens.mdx

View check run for this annotation

Mintlify / Mintlify Validation (powersync) - vale-spellcheck

configuration/auth/development-tokens.mdx#L49

Did you really mean 'prepopulated'?
4. Click **Proceed**.
4. Wait for the syncing to complete and inspect the synced data in SQLite.

Expand Down
2 changes: 1 addition & 1 deletion configuration/source-db/setup.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -436,7 +436,7 @@
| Database | Edition | Version | Min Service Tier |
| ---------------- | ------------------------------------------- | ------- | ------------------------------------------------------------------------------------- |
| SQL Server 2022+ | Standard, Enterprise, Developer, Evaluation | 16.0+ | N/A |
| Azure SQL\* | Database, Managed instance | N/A | Any service tier on vCore purchasing model. S3 tier and up on DTU purchasing model. See: [Azure SQL Database compute requirements](https://learn.microsoft.com/en-us/azure/azure-sql/database/change-data-capture-overview?view=azuresql#azure-sql-database-compute-requirements) |

Check warning on line 439 in configuration/source-db/setup.mdx

View check run for this annotation

Mintlify / Mintlify Validation (powersync) - vale-spellcheck

configuration/source-db/setup.mdx#L439

Did you really mean 'vCore'?

\* Azure SQL Database is always running on the latest version of the SQL Server DB Engine

Expand Down Expand Up @@ -469,7 +469,7 @@

- Read/Write permissions on the `_powersync_checkpoints` table
- Read permissions on the replicated tables
- `cdc_reader` role (grants access to CDC changetables and functions)

Check warning on line 472 in configuration/source-db/setup.mdx

View check run for this annotation

Mintlify / Mintlify Validation (powersync) - vale-spellcheck

configuration/source-db/setup.mdx#L472

Did you really mean 'changetables'?
- `SELECT` permission on the CDC schema (grants access to CDC metadata tables)
- `VIEW DATABASE PERFORMANCE STATE` (SQL Server and Azure SQL)
- `VIEW SERVER PERFORMANCE STATE` (SQL Server only)
Expand Down Expand Up @@ -615,7 +615,7 @@

2. **Polling Interval**: The frequency at which PowerSync polls the CDC change tables for changes. The default value is once every 1000ms. This can be changed by setting the `pollingIntervalMs` parameter in the PowerSync configuration.

<Warning>Configuration parameters for SQL Server like `pollingIntervalMs` and `pollingBatchSize` (see below) can currently only be [set when self-hosting](/intro/setup-guide#self-hosted-2) PowerSync. We are working on exposing these settings for SQL Server source database connections in the PowerSync Dashboard for PowerSync Cloud instances.</Warning>
<Warning>Configuration parameters for SQL Server like `pollingIntervalMs` and `pollingBatchSize` (see below) can currently only be set when self-hosting PowerSync (e.g. via your config file or the [PowerSync CLI](/tools/cli)). We are working on exposing these settings in the PowerSync Dashboard for PowerSync Cloud instances.</Warning>

### Memory Management

Expand Down
5 changes: 4 additions & 1 deletion intro/powersync-overview.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,10 @@
<Card title="Understand PowerSync" icon="lightbulb" href="/intro/powersync-philosophy" horizontal>
Learn about PowerSync's philosophy, key concepts and architecture.
</Card>
<Card title="MongoDB Atlas Device Sync Migration" icon="leaf" href="/migration-guides/atlas-device-sync" horizontal>
<Card title="Agent Skills" icon="sparkles" href="/tools/ai-tools#powersync-agent-skills" horizontal>
Use the official PowerSync Agent Skills to get started with PowerSync quickly using AI-powered coding tools.
</Card>
<Card title="MongoDB Atlas Device Sync Migration" icon="leaf" href="/migration-guides/atlas-device-sync" horizontal>
Step-by-step guide to migrate from Atlas Device Sync to PowerSync.
</Card>
</CardGroup>
Expand All @@ -44,7 +47,7 @@
<ClientSdks />

<Note>
Looking for an SDK that's not listed above? Upvote it or submit it on [our roadmap](https://roadmap.powersync.com/).

Check warning on line 50 in intro/powersync-overview.mdx

View check run for this annotation

Mintlify / Mintlify Validation (powersync) - vale-spellcheck

intro/powersync-overview.mdx#L50

Did you really mean 'Upvote'?
</Note>


Expand Down
5 changes: 2 additions & 3 deletions intro/self-hosting.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,6 @@ The [PowerSync Service](https://github.com/powersync-ja/powersync-service) can b

<Note>
* Note that the [PowerSync Dashboard](https://dashboard.powersync.com/) is currently not available when self-hosting PowerSync.
* The PowerSync Open Edition is currently considered a beta release as it still requires more detailed documentation and guides. From a stability perspective, the Open Edition is production-ready. It uses the same codebase as our Cloud version. See [Feature Status](/resources/feature-status) for how we define beta releases.
* Please reach out on our [Discord](https://discord.gg/powersync) if you have any questions not yet covered in these docs.
</Note>

Expand All @@ -27,9 +26,9 @@ The quickest way to get a feel for the system is to run our example project on y

<Card title="GitHub - powersync-ja/self-host-demo" icon="github" href="https://github.com/powersync-ja/self-host-demo" horizontal />

## Local Development With Docker Compose
## Local Development

If you plan to self-host for development purposes only, see [Local Development](/tools/local-development) for how to easily do this using Docker Compose.
To run PowerSync locally, see [Local Development](/tools/local-development). The easiest path is the [PowerSync CLI](/tools/cli), which sets up a Docker Compose stack for you.


## Full Installation
Expand Down
Loading