Skip to main content
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 | MongoDB | Azure DocumentDB | MySQL | SQL Server | Convex
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.

​
Postgres Provider Specifics

Select your Postgres hosting provider for steps to connect your newly-created PowerSync instance to your Postgres database:
Try our new guided Supabase setup in the PowerSync Dashboard. It configures your Supabase project and PowerSync Cloud instance for you.Look for the Set Up with Supabase button in your instance’s Health or Database Connection view, then follow the on-screen steps.
Using Supabase? banner with a Set Up with Supabase button.

The Set Up with Supabase button in the PowerSync Dashboard

To set up Supabase manually instead, follow the steps below.
  1. In your Supabase Dashboard, click Connect in the top navigation bar, or open this link.
  2. Select Direct, keep Direct connection as the connection method, and copy the connection string, including the [YOUR-PASSWORD] placeholder.
  3. In the PowerSync Dashboard, select your project and instance and go to the Database Connection view.
  4. Select the Postgres tab.
  5. Paste the connection string into the URI field. PowerSync fills in the other connection fields from the URI.
  6. Change Username and Password to the powersync_role and password you created when you set up Supabase for PowerSync. See Source Database Setup.
  7. Keep SSL Mode set to verify-full. PowerSync trusts Supabase’s certificate by default, so you don’t need to add a server certificate.
  8. Click Test Connection and fix any errors.
  9. Click Save Connection.
PowerSync now creates an isolated cloud environment for your instance. This typically takes a minute or two.

​
Enable Supabase Auth

  1. In the PowerSync Dashboard, go to the Client Auth view.
  2. Select Use Supabase Auth.
  3. If your Supabase project uses legacy JWT secrets, copy the JWT secret from your project’s JWT Keys settings into Supabase JWT Secret (optional). If your project uses JWT signing keys, leave this field empty. PowerSync configures your project’s signing keys automatically.
  4. Click Save and Deploy.

​
Troubleshooting

Supabase allows 5 replication slots on compute sizes up to Medium, and more on larger compute sizes. Supabase Realtime (unrelated to PowerSync) often uses one of them.It is therefore easy to run out of replication slots, resulting in an error such as “All replication slots are in use” when deploying. To resolve this, delete inactive replication slots by running this query:
  1. In the PowerSync Dashboard, select your project and instance and go to the Database Connection view.
  2. Select the Postgres tab.
  3. Locate the connection details from AWS RDS:
    • Copy the “Endpoint” value from the AWS Management Console.
    • Paste the endpoint into the “Host” field in the PowerSync Dashboard.
    • Complete the remaining fields: “Name”, “Host”, “Port”, “Database name”, “Username”, “Password” and “SSL Mode” are required. You can paste a connection string into the “URI” field to simplify this.
    • “Name” can be any name for the connection.
    • “Port” is 5432 for Postgres databases.
    • “Username” and “Password” maps to the powersync_role created in Source Database Setup.
    • PowerSync has the AWS RDS CA certificate pre-configured — verify-full SSL mode can be used directly, without any additional configuration required.
  4. Click Test Connection and fix any errors.
  5. Click Save Connection.
PowerSync deploys and configures an isolated cloud environment for you, which can take a few minutes to complete.

​
Troubleshooting

If you get an error such as “IPs in this range are not supported”, the instance is likely not configured to be publicly accessible. A DNS lookup on the host should give a public IP, and not for example 10.x.x.x or 172.31.x.x.
  1. In the PowerSync Dashboard, select your project and instance and go to the Database Connection view.
  2. Select the Postgres tab.
  3. Use the cluster (writer) endpoint from the cluster’s details page in the RDS console as the “Host”. Aurora supports logical replication only from the writer. The cluster endpoint follows the writer through a failover. Do not use the reader endpoint or an instance endpoint.
  4. Complete the remaining fields:
    • “Name” can be any name for the connection.
    • “Port” is 5432 for Postgres databases.
    • “Database name” is the database in your cluster to replicate.
    • “Username” and “Password” maps to the powersync_role created in Source Database Setup.
    • PowerSync has the AWS RDS CA certificates pre-configured, so the default verify-full SSL mode works without additional configuration.
  5. Click Test Connection and fix any errors.
  6. Click Save Connection.
PowerSync deploys and configures an isolated cloud environment for you, which can take a few minutes to complete.

​
Troubleshooting

If you get an error such as “IPs in this range are not supported”, the host resolves to a private IP. Make the cluster publicly accessible, or connect through a Private Endpoint.If Sync Config validation fails with postgres query failed, check the instance logs for the underlying error.If the logs show Hostname/IP does not match certificate's altnames, the server certificate does not cover the hostname in “Host”. Check that “Host” is your cluster endpoint. If you use a Private Endpoint, check that the target group behind it forwards to the current writer in the same cluster. Correct the hostname or update the target group as needed.
  1. In the PowerSync Dashboard, select your project and instance and go to the Database Connection view.
  2. Select the Postgres tab.
  3. Fill in your connection details from Azure.
    1. “Name”, “Host”, “Port”, “Database name”, “Username”, “Password” and “SSL Mode” are required. You can also paste a connection string into the “URI” field to simplify data entry.
    2. “Name” can be any name for the connection.
    3. “Port” is 5432 for Postgres databases.
    4. “Username” and “Password” maps to the powersync_role created in Source Database Setup.
    5. PowerSync has the Azure CA certificate pre-configured — verify-full SSL mode can be used directly, without any additional configuration required.
  4. Click Test Connection and fix any errors.
    • If you encounter the error "must be superuser or replication role to start walsender", ensure that you’ve followed all the steps for enabling logical replication documented here.
  5. Click Save Connection.
PowerSync deploys and configures an isolated cloud environment for you, which can take a few minutes to complete.
  1. In the PowerSync Dashboard, select your project and instance and go to the Database Connection view.
  2. Select the Postgres tab.
  3. Fill in your connection details from Google Cloud SQL.
    • “Name”, “Host”, “Port”, “Database name”, “Username”, “Password” and “SSL Mode” are required. You can paste a connection string into the “URI” field to simplify data entry.
    • “Name” can be any name for the connection.
    • “Port” is 5432 for Postgres databases.
    • “Username” and “Password” maps to the powersync_role created in Source Database Setup.
    • The server certificate can be downloaded from Google Cloud SQL.
    • If SSL is enforced, a client certificate and key must also be created on Google Cloud SQL, and configured on the PowerSync instance.
  4. Click Test Connection and fix any errors.
  5. Click Save Connection.
PowerSync deploys and configures an isolated cloud environment for you, which can take a few minutes to complete.
  1. In the PowerSync Dashboard, select your project and instance and go to the Database Connection view.
  2. Select the Postgres tab.
  3. Fill in your connection details from Neon.
    1. “Name”, “Host”, “Port”, “Database name”, “Username”, “Password” and “SSL Mode” are required. You can paste a connection string into the “URI” field to simplify data entry.
    2. “Name” can be any name for the connection.
    3. “Port” is 5432 for Postgres databases.
    4. “Username” and “Password” maps to the powersync_role created in Source Database Setup.
    5. Note that if you’re using a self-signed SSL certificate for your database server, click the Download Certificate button to dynamically fetch the recommended certificate directly from your server.
    6. Also note if you get any error such as server certificate not trusted: SELF_SIGNED_CERT_IN_CHAIN, click Download Certificate to attempt automatic resolution.
  4. Click Test Connection and fix any errors.
  5. Click Save Connection.
PowerSync deploys and configures an isolated cloud environment for you, which can take a few minutes to complete.
  1. In the PowerSync Dashboard, select your project and instance and go to the Database Connection view.
  2. Select the Postgres tab.
  3. Fill in your connection details from Fly Postgres.
    1. “Name”, “Host”, “Port”, “Database name”, “Username”, “Password” and “SSL Mode” are required. You can paste a connection string into the “URI” field to simplify data entry.
    2. “Name” can be any name for the connection.
    3. “Port” is 5432 for Postgres databases.
    4. “Username” and “Password” maps to the powersync_role created in Source Database Setup.
    5. Note that if you’re using a self-signed SSL certificate for your database server, click the Download Certificate button to dynamically fetch the recommended certificate directly from your server.
    6. Also note if you get any error such as server certificate not trusted: SELF_SIGNED_CERT_IN_CHAIN, click Download Certificate to attempt automatic resolution.
  4. Click Test Connection and fix any errors.
  5. Click Save Connection.
PowerSync deploys and configures an isolated cloud environment for you, which can take a few minutes to complete.
  1. In the PowerSync Dashboard, select your project and instance and go to the Database Connection view.
  2. Select the Postgres tab.
  3. Head to your PlanetScale database dashboard page at https://app.planetscale.com/<ORGANIZATION>/<DATABASE_NAME> and click on the “Connect” button to get your database connection parameters.
    1. In the PowerSync Dashboard, “Name”, “Host”, “Port”, “Database name”, “Username” and “Password” are required.
    2. “Name” can be any name for the connection.
    3. “Host” is the host connection parameter for your database.
    4. “Port” is 5432 for Postgres databases.
    5. “Username” and “Password” maps to the powersync_role created in Source Database Setup.
      1. Important: PlanetScale requires your branch ID to be appended to your username. The username should be powersync_role.<branch_id>. Your PlanetScale branch ID can be found on the same connection details page.
    6. SSL Mode can remain the default verify-full.
  4. Click Test Connection and fix any errors.
  5. Click Save Connection.
PowerSync deploys and configures an isolated cloud environment for you, which can take a few minutes to complete.
  1. In the PowerSync Dashboard, select your project and instance and go to the Database Connection view.
  2. Select the Postgres tab.
  3. In your Xata dashboard, navigate to Overview -> Connect and copy the connection URI. Alternatively, use the Xata CLI and run xata branch url to obtain the URI and copy that.
  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.
PowerSync deploys and configures an isolated cloud environment for you, which can take a few minutes to complete.
For other providers and self-hosted databases:
  1. In the PowerSync Dashboard, select your project and instance and go to the Database Connection view.
  2. Select the Postgres tab.
  3. Fill in your connection details.
  4. “Name”, “Host”, “Port”, “Database name”, “Username”, “Password” and “SSL Mode” are required. You can paste a connection string into the “URI” field to simplify data entry.
  5. “Name” can be any name for the connection.
  6. “Port” is 5432 for Postgres databases.
  7. “Username” and “Password” maps to the powersync_role created in Source Database Setup.
  8. Note that if you’re using a self-signed SSL certificate for your database server, click the Download Certificate button to dynamically fetch the recommended certificate directly from your server.
  9. Also note if you get any error such as server certificate not trusted: SELF_SIGNED_CERT_IN_CHAIN, click Download Certificate to attempt automatic resolution.
  10. Click Test Connection and fix any errors.
  11. Click Save Connection.
PowerSync deploys and configures an isolated cloud environment for you, which can take a few minutes to complete.
Make sure that your Postgres database allows access to PowerSync’s IPs — see Security and IP Filtering
Also see:

​
MongoDB Specifics

  1. In the PowerSync Dashboard, select your project and instance and go to Database Connection.
  2. Select the MongoDB tab.
  3. Fill in your connection details from MongoDB:
    1. Copy your cluster’s connection string from MongoDB and paste it into the URI field in the PowerSync Dashboard. PowerSync will automatically parse this URI to populate other connection details.
      • The format should be mongodb+srv://[username:password@]host/[database]. For example, mongodb+srv://admin:<db_password>@cluster0.abcde1.mongodb.net/powersync
    2. Enter your database user’s password into the Password field. See the necessary permissions in Source Database Setup.
    3. “Database name” is the database in your cluster to replicate.
  4. Click Test Connection and fix any errors. If have any issues connecting, reach out to our support engineers on our Discord server or otherwise contact us.
  5. Click Save Connection.
PowerSync deploys and configures an isolated cloud environment for you, which can take a few minutes to complete.
Make sure that your MongoDB database allows access to PowerSync’s IPs — see Security and IP Filtering
Also see:

​
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 in alpha. See Azure DocumentDB for supported variants and limitations.

​
MySQL Specifics

MySQL support is currently in a Beta release.
Select your MySQL hosting provider for steps to connect your newly-created PowerSync instance to your MySQL database:
Before connecting, complete Aurora MySQL Setup.
1

Open the Connection Settings

In the PowerSync Dashboard, select your project and instance and go to Database Connection. Select the MySQL tab.
2

Enter the Connection Details

Use the cluster (writer) endpoint as Host. Do not use the reader endpoint: Aurora MySQL binary logs are available only on the writer. The cluster endpoint follows the writer through a failover, while an instance endpoint does not. If the new writer has a different server UUID, PowerSync takes a new snapshot before resuming replication.Complete the remaining required fields:
  • Name can be any name for the connection.
  • Port is your cluster’s database port (3306 by default).
  • Database name is the default database to replicate.
  • Username and Password are the credentials for the replication user created in Database User Configuration.
3

Test and Save the Connection

Click Test Connection and fix any errors. Click Save Connection.
PowerSync deploys and configures an isolated cloud environment for you, which can take a few minutes to complete.
For other providers and self-hosted databases:
  1. In the PowerSync Dashboard, select your project and instance and go to the Database Connection view.
  2. Select the MySQL tab.
  3. Fill in your MySQL connection details:
    1. “Name”, “Host”, “Port”, “Database name”, “Username”, “Password” are required.
    2. “Name” can be any name for the connection.
    3. “Host” the endpoint for your database.
    4. “Database name” is the default database to replicate. Additional databases are derived by qualifying the tables in your Sync Streams.
    5. “Username” and “Password” maps to your database user.
  4. Click Test Connection and fix any errors.
  5. Click Save Connection.
PowerSync deploys and configures an isolated cloud environment for you, which can take a few minutes to complete.
Make sure that your MySQL database allows access to PowerSync’s IPs — see Security and IP Filtering
Also see:

​
SQL Server Specifics

SQL Server support is currently in a Beta release.
SQL Server support was introduced in version 1.18.1 of the PowerSync Service.
  1. In the PowerSync Dashboard, select your project and instance and go to the Database Connection view.
  2. Select the SQL Server tab.
  3. Fill in your SQL Server connection details:
    1. “Name”, “Host”, “Port”, “Database name”, “Username”, “Password” are required.
    2. “Name” can be any name for the connection.
    3. “Host” is the endpoint for your SQL Server instance.
    4. “Port” is typically 1433 for SQL Server (default port).
    5. “Database name” is the database you want to replicate. CDC should be enabled on this database.
    6. “Username” and “Password” maps to the database user created in Source Database Setup (e.g., powersync_user).
  4. Click Test Connection and fix any errors.
  5. Click Save Connection.
PowerSync deploys and configures an isolated cloud environment for you, which can take a few minutes to complete.
Make sure that your SQL Server database allows access to PowerSync’s IPs — see Security and IP Filtering
Also see:

​
Convex Specifics

The Convex replicator is currently released as an experimental feature. APIs and behavior may change, and we can’t yet guarantee continued support or long-term stability.
Before connecting PowerSync, add the required powersync_checkpoints table and mutation to your Convex deployment. See Convex Source Database Setup.
  1. In the PowerSync Dashboard, select your project and instance and go to Database Connection.
  2. Select the Convex tab.
  3. Fill in your Convex connection details:
    1. Deployment URL is your Convex deployment URL, for example https://<your-deployment>.convex.cloud.
    2. Deploy key is the deploy key for the Convex deployment. In the Convex Dashboard, go to Settings → General and generate a deploy key with Custom permissions that include deployment:data:view. The Deploy only option does not work for PowerSync replication.
  4. Click Test Connection and fix any errors.
  5. Click Save Connection.
PowerSync deploys and configures an isolated cloud environment for you, which can take a few minutes to complete.
Use a deploy key for the correct environment, grant only the permissions PowerSync needs, store it as a secret, and rotate it if it is exposed.
Also see: