mirror of
https://github.com/supabase/supabase.git
synced 2026-09-03 07:28:20 +08:00
docs: use an opaque placeholder for the pooler host
The rest of this PR aligns placeholders with what the Connect dialog emits. `aws-[REGION]` didn't: it reads as composable and isn't. Hosts are `aws-<index>-<region>.pooler.supabase.com`, and the index is a pooler cluster index, not part of the region. Both aws-0-us-west-1 and aws-1-us-west-1 appear in this repo, so a reader can't derive it, and Studio doesn't compose the host either. It comes from the API. - Use `[POOLER-HOST]` in the copyable strings, the convention the newer quickstarts already use. - Keep the full shape in the summary table, where showing the shape is the point, and name the index there. Composing the host produces `Tenant or user not found`, which reads like a credentials error. Naming the index and explaining how to avoid it follows in a later PR of this stack.
This commit is contained in:
@@ -16,12 +16,12 @@ How you connect to your database depends on where your code runs:
|
||||
|
||||
The following table summarizes each mode, its host and port, the IP version it supports on each plan, and what it's best used for:
|
||||
|
||||
| Mode | Host:Port | Free | Paid | Paid + IPv4 add-on | Best for |
|
||||
| ---------------------------------- | --------------------------------------- | ---- | ---- | ------------------ | ------------------------------------------ |
|
||||
| Direct connection | `db.[PROJECT-REF].supabase.co:5432` | IPv6 | IPv6 | IPv4 | Migrations, `pg_dump`, persistent backends |
|
||||
| Shared pooler, session mode | `aws-[REGION].pooler.supabase.com:5432` | IPv4 | IPv4 | IPv4 | Persistent backends on IPv4-only networks |
|
||||
| Shared pooler, transaction mode | `aws-[REGION].pooler.supabase.com:6543` | IPv4 | IPv4 | IPv4 | Serverless and edge functions |
|
||||
| Dedicated pooler, transaction mode | `db.[PROJECT-REF].supabase.co:6543` | - | IPv6 | IPv4 | High-performance app traffic on paid plans |
|
||||
| Mode | Host:Port | Free | Paid | Paid + IPv4 add-on | Best for |
|
||||
| ---------------------------------- | ----------------------------------------------- | ---- | ---- | ------------------ | ------------------------------------------ |
|
||||
| Direct connection | `db.[PROJECT-REF].supabase.co:5432` | IPv6 | IPv6 | IPv4 | Migrations, `pg_dump`, persistent backends |
|
||||
| Shared pooler, session mode | `aws-[INDEX]-[REGION].pooler.supabase.com:5432` | IPv4 | IPv4 | IPv4 | Persistent backends on IPv4-only networks |
|
||||
| Shared pooler, transaction mode | `aws-[INDEX]-[REGION].pooler.supabase.com:6543` | IPv4 | IPv4 | IPv4 | Serverless and edge functions |
|
||||
| Dedicated pooler, transaction mode | `db.[PROJECT-REF].supabase.co:6543` | - | IPv6 | IPv4 | High-performance app traffic on paid plans |
|
||||
|
||||
<Admonition type="caution">
|
||||
|
||||
@@ -105,7 +105,7 @@ The session mode connection string connects to your Postgres instance through th
|
||||
The connection string looks like this:
|
||||
|
||||
```txt
|
||||
postgresql://postgres.[PROJECT-REF]:[YOUR-PASSWORD]@aws-[REGION].pooler.supabase.com:5432/postgres
|
||||
postgresql://postgres.[PROJECT-REF]:[YOUR-PASSWORD]@[POOLER-HOST]:5432/postgres
|
||||
```
|
||||
|
||||
Get your project's session mode connection string from the Supabase Dashboard by clicking [Connect](/dashboard/project/_?showConnect=true&method=session) and choosing **Session pooler**.
|
||||
@@ -123,7 +123,7 @@ Transaction mode does not support [prepared statements](https://postgresql.org/d
|
||||
The connection string looks like this:
|
||||
|
||||
```txt
|
||||
postgresql://postgres.[PROJECT-REF]:[YOUR-PASSWORD]@aws-[REGION].pooler.supabase.com:6543/postgres
|
||||
postgresql://postgres.[PROJECT-REF]:[YOUR-PASSWORD]@[POOLER-HOST]:6543/postgres
|
||||
```
|
||||
|
||||
Get your project's transaction mode connection string from the Supabase Dashboard by clicking [Connect](/dashboard/project/_?showConnect=true&method=transaction) and choosing **Transaction pooler**.
|
||||
|
||||
@@ -49,7 +49,7 @@ Choose one of these Vercel Deploy Templates. They use the [Vercel Deploy Integra
|
||||
4. Save the result as the `POSTGRES_URL` environment variable.
|
||||
|
||||
```txt .env.local
|
||||
POSTGRES_URL="postgresql://postgres.[PROJECT-REF]:[YOUR-PASSWORD]@aws-[REGION].pooler.supabase.com:6543/postgres?workaround=supabase-pooler.vercel"
|
||||
POSTGRES_URL="postgresql://postgres.[PROJECT-REF]:[YOUR-PASSWORD]@[POOLER-HOST]:6543/postgres?workaround=supabase-pooler.vercel"
|
||||
```
|
||||
|
||||
<Tabs scrollable defaultActiveId="drizzle" type="underlined" size="small">
|
||||
|
||||
Reference in New Issue
Block a user