Database Setup Guide

This guide helps you connect your PostgreSQL database and obtain the necessary connection credentials for Codeless Sync (CLS).

CLS works with PostgreSQL databases including Supabase, Neon, Railway, Render, and other PostgreSQL-compatible providers.

Prerequisites

A PostgreSQL database (Supabase, Neon, Railway, Render, or other provider)
Your database should already be created in your provider's dashboard
Access to your database connection credentials

Step 1: Access Your Database Provider

Navigate to your database provider's dashboard:

Supabase: app.supabase.com
Neon: console.neon.tech
Railway: railway.app
Render: dashboard.render.com
Other providers: Check your provider's documentation

If you're creating a new database, wait for the setup to complete before proceeding (usually takes 1-2 minutes).

Step 2: Find Your Connection String

Your connection string is typically found in your provider's dashboard under "Connection" or "Database Settings".

The connection string format is:

postgresql://username:password@host:port/database

For Supabase

Go to Project Settings → Database
Look for Connection string section
Select Transaction Pooler (recommended for best performance)
Copy the connection string (starts with postgresql://)
Important: Replace [YOUR-PASSWORD] in the connection string with your actual database password

How to Sync Stripe Data to Supabase in 5 Minutes

For Neon

Go to your project dashboard
Click on Connection Details
Copy the connection string (starts with postgresql:// or postgres://)

How to Sync Stripe Data to Neon in 5 Minutes

For Railway

Go to your project dashboard
Click on your PostgreSQL service
Navigate to Connect tab
Copy the DATABASE_URL connection string

For Render

Go to your PostgreSQL database in the dashboard
Click on Info in the left sidebar
Find External Database URL under Connections
Copy the connection string (starts with postgresql://)

For Other Providers

Look for:

"Connection string", "Database URL", or "Connection URI"
The string should start with postgresql:// or postgres://
Ensure it includes your password (may need to reveal or replace placeholder)

Your connection string contains your database password. Treat it like a sensitive credential and never expose it in client-side code or commit it to version control.

Connection String Requirements

Before connecting your database to CLS, ensure your connection string meets these requirements:

Network Protocol

IPv4 connections are fully supported. IPv6 compatibility varies by platform and may require additional formatting configuration.

Using IPv6 addresses directly? Wrap the IPv6 address in square brackets: postgresql://user:password@[2001:db8::1]:5432/database Most database providers (Supabase, Neon, Railway, Render) use hostnames, so this is rarely needed.

URL Type

Use an external or public connection URL. Internal URLs (used for same-network connections) are unlikely to work with CLS since our servers need to reach your database over the public internet.

✅ External/Public URL: postgresql://user:pass@db.provider.com:5432/mydb
❌ Internal URL: postgresql://user:pass@internal.cluster.local:5432/mydb

PostgreSQL Version

PostgreSQL 11 or higher is required. All major platforms are fully compatible:

Supabase
Neon
Railway
Render
Heroku
AWS RDS
Any PostgreSQL 11+ database

Step 3: Connection String Components

Understanding what's in your connection string:

postgresql://username:password@host:port/database

Component	Description	Example
`username`	Database user	`postgres`
`password`	User password	`your-password`
`host`	Database server address	`db.abc123.supabase.co`
`port`	Connection port	`5432` or `6543` (pooler)
`database`	Database name	`postgres`

Step 4: Use in Codeless Sync

Go to your CLS dashboard
Navigate to Projects → New Project
Enter a Project Name (e.g., "Production Database")
Select your Database Platform (Supabase, Neon, Railway, Render, or Other)
Paste your Connection String from Step 2
Click Test Connection to verify
Click Create when validation succeeds

We recommend using a Transaction Pooler or Session Pooler connection string for better performance. Most providers offer pooled connections.

Security Best Practices

Keep Connection String Private

Your connection string should be treated like a database password:

Store in environment variables
Use secrets management (e.g., 1Password, AWS Secrets Manager)
Restrict access to authorized team members only
Never commit to Git repositories
Never expose in client-side code
Never share in public forums or screenshots

Rotate Credentials if Compromised

If you suspect your connection string has been exposed:

Go to your database provider's dashboard
Navigate to database settings or security
Reset your database password
Important: This will immediately invalidate the old connection string
Copy the new connection string
Update all CLS projects with the new credentials

Resetting your database password will immediately break all existing connections using the old credentials. Update CLS and any other services before resetting.