Connect to your database
Connect to Postgres from your frontend, backend, or serverless environment
Quick summary
How you connect to your database depends on where you're connecting from:
- For frontend applications, use the Data API
- For Postgres clients, use a connection string
- For persistent clients (for example, long-running servers or database GUIs) use the direct connection string if your environment supports IPv6, and Supavisor session mode if not
- For temporary clients (for example, serverless or edge functions) use Supavisor transaction mode
Quickstarts
Data APIs and client libraries
The Data APIs allow you to interact with your database using REST or GraphQL requests. You can use these APIs to fetch and insert data from the frontend, as long as you have RLS enabled.
For convenience, you can also use the Supabase client libraries, which wrap the Data APIs with a developer-friendly interface and automatically handle authentication:
Direct connection
The direct connection string connects directly to your Postgres instance. It is ideal for persistent servers, such as virtual machines (VMs) and long-lasting containers. Examples include AWS EC2 machines, Fly.io VMs, and DigitalOcean Droplets.
Direct connections use IPv6 by default. If your environment doesn't support IPv6, use Supavisor session mode or get the IPv4 addon.
The connection string looks like this:
_10postgresql://postgres:[YOUR-PASSWORD]@db.apbkobhfnmcqqzqeeqss.supabase.co:5432/postgres
Get your project's direct string from the Database Settings page:
- Go to the
Settingssection. - Click
Database. - Under
Connection string, make sureDisplay connection pooleris unchecked. Copy the URI.
Supavisor session mode
The session mode connection string connects to your Postgres instance via a proxy. This is ideal for persistent servers when IPv6 is not supported.
The connection string looks like this:
_10postgres://postgres.apbkobhfnmcqqzqeeqss:[YOUR-PASSWORD]@aws-0-ca-central-1.pooler.supabase.com:5432/postgres
Get your project's session mode string from the Database Settings page:
- Go to the
Settingssection. - Click
Database. - Under
Connection string, make sureDisplay connection pooleris checked andSession modeis selected. Copy the URI.
Supavisor transaction mode
The transaction mode connection string connects to your Postgres instance via a proxy which serves as a connection pooler. This is deal for serverless or edge functions, which require many transient connections.
Transaction mode does not support prepared statements. To avoid errors, turn off prepared statements for your connection library.
The connection string looks like this:
_10postgres://postgres.apbkobhfnmcqqzqeeqss:[YOUR-PASSWORD]@aws-0-ca-central-1.pooler.supabase.com:6543/postgres
Get your project's transaction mode string from the Database Settings page:
- Go to the
Settingssection. - Click
Database. - Under
Connection string, make sureDisplay connection pooleris checked andTransaction modeis selected. Copy the URI.
More about connection pooling
Connection pooling improves database performance by reusing existing connections between queries. This reduces the overhead of establishing connections and improves scalability.
You can use an application-side pooler or a server-side pooler (Supabase automatically provides one called Supavisor), depending on whether your backend is persistent or serverless.
Application-side poolers
Application-side poolers are built into connection libraries and API servers, such as Prisma, SQLAlchemy, and PostgREST. They maintain several active connections with Postgres or a server-side pooler, reducing the overhead of establishing connections between queries. When deploying to static architecture, such as long-standing containers or VMs, application-side poolers are satisfactory on their own.
Serverside poolers
Postgres connections are like a WebSocket. Once established, they are preserved until the client (application server) disconnects. A server might only make a single 10 ms query, but needlessly reserve its database connection for seconds or longer.
Serverside-poolers, such as Supabase's Supavisor in transaction mode, sit between clients and the database and can be thought of as load balancers for Postgres connections.
They maintain hot connections with the database and intelligently share them with clients only when needed, maximizing the amount of queries a single connection can service. They're best used to manage queries from auto-scaling systems, such as edge and serverless functions.
Connecting with SSL
You should connect to your database using SSL wherever possible, to prevent snooping and man-in-the-middle attacks.
You can obtain your connection info and Server root certificate from your application's dashboard:
