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
1 change: 1 addition & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -60,6 +60,7 @@ FontAwesome icons are supported: https://fontawesome.com/search
We use the following icons for supported backend databases and SDKs:
- Postgres: `icon="elephant"`
- MongoDB: `icon="leaf"`
- Azure DocumentDB: `icon="microsoft"`
Comment thread
cahofmeyr marked this conversation as resolved.
- MySQL: `icon="dolphin"`
- SQL Server: `icon="server"`
- Flutter: `icon="flutter"`
Expand Down
9 changes: 6 additions & 3 deletions configuration/source-db/connection.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@

Each database provider has their quirks when it comes to specifying connection details, so we have documented database-specific and provider-specific instructions below:

Jump to: [Postgres](#postgres-provider-specifics) | [MongoDB](#mongodb-specifics) | [MySQL](#mysql-specifics) | [SQL Server](#sql-server-specifics) | [Convex](#convex-specifics)
Jump to: [Postgres](#postgres-provider-specifics) | [MongoDB](#mongodb-specifics) | [Azure DocumentDB](#azure-documentdb-specifics) | [MySQL](#mysql-specifics) | [SQL Server](#sql-server-specifics) | [Convex](#convex-specifics)

<Note>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).</Note>

Expand Down Expand Up @@ -128,7 +128,7 @@
<Accordion title="Xata">
1. In the [PowerSync Dashboard](https://dashboard.powersync.com/), select your project and instance and go to the **Database Connections** view.
2. Click **Connect to Source Database** and ensure the **Postgres** tab is selected.
3. In your Xata dashboard, navigate to Overview -> Connect and copy the connection URI. Alternatively, use the [Xata CLI](https://xata.io/docs/cli) and run `xata branch url` to obtain the URI and copy that.

Check warning on line 131 in configuration/source-db/connection.mdx

View check run for this annotation

Mintlify / Mintlify Validation (powersync) - vale-spellcheck

configuration/source-db/connection.mdx#L131

Did you really mean 'Xata'?
4. Paste the connection details into the "**URI**" field in the PowerSync Dashboard.
5. Click **Test Connection** and fix any errors.
6. Click **Save Connection**.
Expand Down Expand Up @@ -181,13 +181,16 @@
Make sure that your MongoDB database allows access to PowerSync's IPs — see [Security and IP Filtering](/configuration/source-db/security-and-ip-filtering)
</Info>

<Note>Connecting to **Azure DocumentDB** (formerly Azure Cosmos DB for MongoDB vCore)? Use this same MongoDB tab and connection string. PowerSync detects DocumentDB automatically. This support is [experimental](/resources/feature-status). See [Azure DocumentDB](/configuration/source-db/setup#azure-documentdb-cosmos-db-for-mongodb-vcore) for supported variants and limitations.</Note>

Also see:
- [MongoDB Source Database Setup](/configuration/source-db/setup#mongodb)
- [MongoDB Atlas Device Sync Migration Guide](/migration-guides/atlas-device-sync)


## <Icon icon="microsoft" iconType="solid" size={32}/> Azure DocumentDB Specifics

To connect to **Azure DocumentDB** (formerly Azure Cosmos DB for MongoDB vCore), use the same instructions as for MongoDB above. PowerSync detects DocumentDB automatically. Azure DocumentDB support is [experimental](/resources/feature-status). See [Azure DocumentDB](/configuration/source-db/setup#azure-documentdb) for supported variants and limitations.


## <Icon icon="dolphin" iconType="solid" size={32}/> MySQL Specifics

<Note>MySQL support is currently in a [Beta release](/resources/feature-status).</Note>
Expand Down
9 changes: 5 additions & 4 deletions configuration/source-db/setup.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: "Source Database Setup"
description: "Prepare your Postgres, MongoDB, MySQL, SQL Server or Convex database for PowerSync replication."
---

Jump to: [Postgres](#postgres) | [MongoDB](#mongodb) | [MySQL](#mysql) | [SQL Server](#sql-server) | [Convex](#convex)
Jump to: [Postgres](#postgres) | [MongoDB](#mongodb) | [Azure DocumentDB](#azure-documentdb) | [MySQL](#mysql) | [SQL Server](#sql-server) | [Convex](#convex)

import PostgresPowerSyncUser from '/snippets/postgres-powersync-user.mdx';
import PostgresPowerSyncPublication from '/snippets/postgres-powersync-publication.mdx';
Expand Down Expand Up @@ -267,7 +267,7 @@ Due to the logical replication requirement, not all Postgres hosting providers a
**Version compatibility**: PowerSync requires MongoDB version 6.0 or greater.
</Check>
<Tip>For more information on migrating from MongoDB Atlas Device Sync to PowerSync, see our [migration guide](/migration-guides/atlas-device-sync).</Tip>
<Note>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.</Note>
<Note>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) below for supported variants and limitations.</Note>

### Permissions Required: MongoDB Atlas

Expand Down Expand Up @@ -352,7 +352,8 @@ Post-images can be configured for PowerSync instances as follows:

If you need to use private endpoints with MongoDB Atlas, see [Private Endpoints](/configuration/source-db/private-endpoints) (AWS only).

### Azure DocumentDB (Cosmos DB for MongoDB vCore)

### Azure DocumentDB

<Warning>
Azure DocumentDB support is **experimental**. APIs and behavior may change, and it is not yet covered by SLAs. See [Feature Status](/resources/feature-status) for what this means for production readiness and support.
Expand All @@ -362,7 +363,7 @@ PowerSync replicates from Azure DocumentDB (formerly Azure Cosmos DB for MongoDB

#### Supported Variants

"Cosmos DB" spans several Microsoft products that are not interchangeable for replication. PowerSync supports only the vCore engine:
There are several related Microsoft products that are not interchangeable for replication. PowerSync supports only Azure DocumentDB, formerly known as Azure Cosmos DB for MongoDB vCore:

| Variant | Supported |
| --- | --- |
Expand Down
2 changes: 2 additions & 0 deletions intro/powersync-overview.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,8 @@ PowerSync is designed to be backend database agnostic, and supports these source

<Card title="SQL Server (Beta)" icon="server" href="/configuration/source-db/setup#sql-server" />

<Card title="Azure DocumentDB (Experimental)" icon="microsoft" href="/configuration/source-db/setup#azure-documentdb" />

<Card title="Convex (Experimental)" icon="database" href="/configuration/source-db/setup#convex" />
</CardGroup>

Expand Down
2 changes: 1 addition & 1 deletion intro/powersync-philosophy.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ The app is always [fast and responsive](https://www.powersync.com/blog/local-fir

PowerSync lets you avoid the complexities of using APIs to move app state [over the network](https://www.powersync.com/blog/escaping-the-network-tarpit). Its goal is to solve the hard problems of keeping data in sync, without getting in your way.

You use a supported backend source such as Postgres, MongoDB, MySQL, SQL Server, or Convex \[[1](#footnotes)\] on the server, a standard SQLite database on the client, and your [own backend](/configuration/app-backend/setup) to process mutations. PowerSync keeps the SQLite database in sync with your backend source.
You use a supported backend source such as Postgres, MongoDB, MySQL, SQL Server, Azure DocumentDB (experimental), or Convex (experimental) \[[1](#footnotes)\] on the server, a standard SQLite database on the client, and your [own backend](/configuration/app-backend/setup) to process mutations. PowerSync keeps the SQLite database in sync with your backend source.

### State Management

Expand Down
Loading