diff --git a/README.md b/README.md index 6e847637..50a46460 100644 --- a/README.md +++ b/README.md @@ -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"` - MySQL: `icon="dolphin"` - SQL Server: `icon="server"` - Flutter: `icon="flutter"` diff --git a/configuration/source-db/connection.mdx b/configuration/source-db/connection.mdx index 1cbd4cee..2f16c61c 100644 --- a/configuration/source-db/connection.mdx +++ b/configuration/source-db/connection.mdx @@ -7,7 +7,7 @@ import SupabaseConnection from '/snippets/supabase-database-connection.mdx'; 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) 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). @@ -181,13 +181,16 @@ PowerSync deploys and configures an isolated cloud environment for you, which ca Make sure that your MongoDB database allows access to PowerSync's IPs — see [Security and IP Filtering](/configuration/source-db/security-and-ip-filtering) -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. - Also see: - [MongoDB Source Database Setup](/configuration/source-db/setup#mongodb) - [MongoDB Atlas Device Sync Migration Guide](/migration-guides/atlas-device-sync) +## 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. + + ## MySQL Specifics MySQL support is currently in a [Beta release](/resources/feature-status). diff --git a/configuration/source-db/setup.mdx b/configuration/source-db/setup.mdx index c6deef56..15589e34 100644 --- a/configuration/source-db/setup.mdx +++ b/configuration/source-db/setup.mdx @@ -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'; @@ -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. 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. +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. ### Permissions Required: MongoDB Atlas @@ -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 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. @@ -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 | | --- | --- | diff --git a/intro/powersync-overview.mdx b/intro/powersync-overview.mdx index 13de0847..1a5426f5 100644 --- a/intro/powersync-overview.mdx +++ b/intro/powersync-overview.mdx @@ -39,6 +39,8 @@ PowerSync is designed to be backend database agnostic, and supports these source + + diff --git a/intro/powersync-philosophy.mdx b/intro/powersync-philosophy.mdx index 535a7abb..6a30e36d 100644 --- a/intro/powersync-philosophy.mdx +++ b/intro/powersync-philosophy.mdx @@ -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