Update docs for new connection strings and disk/compute pages in the dashboard (#35128)

* Update all docs that make references to the database settings to find the connection strings.

Update all docs that references the database settings for the compute and disk page

* run prettier

* run pnpm format instead of prettier directly.

* first run through, fix grammar and reword awkward sentences

* Fix typos and remove unnecessary whitespace

* Apply suggestions from code review

Co-authored-by: Tyler <dshukertjr@gmail.com>

---------

Co-authored-by: Tyler <dshukertjr@gmail.com>
This commit is contained in:
PeterandTyler authored and GitHub committed 2025-04-21 08:59:43 -05:00
1 parent 4f2c9e5c45
commit 6a812a04b6
48 files changed
+97 -99

No files matched your search

@@ -9,7 +9,8 @@ Your database will be available in less than a minute.
**Finding your credentials:**
You can find your project credentials inside the project [settings](https://supabase.com/dashboard/project/_/settings/), including:
You can find your project credentials on the dashboard:
- [Database credentials](https://supabase.com/dashboard/project/_/settings/database): connection strings and connection pooler details.
- [API credentials](https://supabase.com/dashboard/project/_/settings/database): your serverless API URL and `anon` / `service_role` keys.
- [Database connection strings](https://supabase.com/dashboard/project/_/settings/api?showConnect=true): Direct and Pooler connection details including the connection string and parameters.
- [Database password](https://supabase.com/dashboard/project/_/settings/database): Reset database password here if you do not have it.
- [API credentials](https://supabase.com/dashboard/project/_/settings/api): your serverless API URL and `anon` / `service_role` keys.
@@ -2,7 +2,7 @@
- If you're planning to migrate a database larger than 6 GB, we recommend [upgrading to at least a Large compute add-on](/docs/guides/platform/compute-add-ons). This will ensure you have the necessary resources to handle the migration efficiently.
- For databases smaller than 150 GB, you can increase the size of the disk on paid projects by navigating to [Database Settings](/dashboard/project/_/settings/database).
- For databases smaller than 150 GB, you can increase the size of the disk on paid projects by navigating to the [Compute and Disk Settings](dashboard/project/_/settings/compute-and-disk) page.
- If you're dealing with a database larger than 150 GB, we strongly advise you to [contact our support team](/dashboard/support/new) for assistance in provisioning the required resources and ensuring a smooth migration process.
@@ -34,7 +34,7 @@ If you haven't already, head over to [database.new](https://database.new) and cr
When creating your project, make sure to note down your database password as you will need it to construct the `DB_URL` in the next step.
You can find the database connection string in your Supabase Dashboard [database settings](https://supabase.com/dashboard/project/_/settings/database). Select "Use connection pooling" with `Mode: Session` for a direct connection to your Postgres database. It will look something like this:
You can find your database connection string on your project dashboard, click [Connect](https://supabase.com/dashboard/project/_?showConnect=true). Use the Session pooler connection string which looks like this:
```txt
postgresql://postgres.[PROJECT-REF]:[YOUR-PASSWORD]@aws-0-[REGION].pooler.supabase.com:5432/postgres
+1 -1
View File
@@ -37,7 +37,7 @@ pip install vecs
## Connect to your database
Find the Postgres pooler connection string for your Supabase project in the [database settings](https://supabase.com/dashboard/project/_/settings/database) of the dashboard. Copy the "URI" format, which should look something like `postgres://postgres.xxxx:password@xxxx.pooler.supabase.com:6543/postgres`
On your project dashboard, click [Connect](https://supabase.com/dashboard/project/_?showConnect=true). The connection string should look like `postgres://postgres.xxxx:password@xxxx.pooler.supabase.com:6543/postgres`
Create a new code block below the install block (`ctrl+m b`) and add the following code using the Postgres URI you copied above:
@@ -42,7 +42,7 @@ DB_CONNECTION = "postgresql://<user>:<password>@<host>:<port>/<db_name>"
vx = vecs.create_client(DB_CONNECTION)
```
Replace the `DB_CONNECTION` with your own connection string for your database. You can find the Postgres connection string in the [Database Settings](https://supabase.com/dashboard/project/_/settings/database) of your Supabase project.
Replace the `DB_CONNECTION` with your own connection string. You can find the connection string on your project dashboard by clicking [Connect](https://supabase.com/dashboard/project/_?showConnect=true).
<Admonition type='note'>
@@ -40,7 +40,7 @@ DB_CONNECTION = "postgresql://<user>:<password>@<host>:<port>/<db_name>"
vx = vecs.create_client(DB_CONNECTION)
```
Replace the `DB_CONNECTION` with your own connection string for your database. You can find the Postgres connection string in the [Database Settings](https://supabase.com/dashboard/project/_/settings/database) of your Supabase project.
Replace the `DB_CONNECTION` with your own connection string. You can find the connection string on your project dashboard by clicking [Connect](https://supabase.com/dashboard/project/_?showConnect=true).
<Admonition type='note'>
@@ -41,7 +41,7 @@ DB_CONNECTION = "postgresql://<user>:<password>@<host>:<port>/<db_name>"
vx = vecs.create_client(DB_CONNECTION)
```
Replace the `DB_CONNECTION` with your own connection string for your database. You can find the Postgres connection string in the [Database Settings](https://supabase.com/dashboard/project/_/settings/database) of your Supabase project.
Replace the `DB_CONNECTION` with your Session pooler connection string. You can find the connection string on your project dashboard by clicking [Connect](https://supabase.com/dashboard/project/_?showConnect=true).
<Admonition type='note'>
@@ -51,7 +51,7 @@ SQLAlchemy requires the connection string to start with `postgresql://` (instead
<Admonition type='note'>
You must use the "connection pooling" string (domain ending in `*.pooler.supabase.com`) with Google Colab since Colab does not support IPv6.
You must use the Session pooler connection string with Google Colab since Colab does not support IPv6.
</Admonition>
@@ -41,7 +41,7 @@ DB_CONNECTION = "postgresql://<user>:<password>@<host>:<port>/<db_name>"
vx = vecs.create_client(DB_CONNECTION)
```
Replace the `DB_CONNECTION` with your own connection string for your database. You can find the Postgres connection string in the [Database Settings](https://supabase.com/dashboard/project/_/settings/database) of your Supabase project.
Replace the `DB_CONNECTION` with your own connection string. You can find the connection string on your project dashboard by clicking [Connect](https://supabase.com/dashboard/project/_?showConnect=true).
<Admonition type='note'>
@@ -77,11 +77,7 @@ The connection string looks like this:
postgresql://postgres:[YOUR-PASSWORD]@db.apbkobhfnmcqqzqeeqss.supabase.co:5432/postgres
```
Get your project's direct string from the [Database Settings](/dashboard/project/_/settings/database) page:
1. Go to the `Settings` section.
2. Click `Database`.
3. Under `Connection string`, make sure `Display connection pooler` is unchecked. Copy the URI.
Get your project's direct connection string from your project dashboard by clicking [Connect](https://supabase.com/dashboard/project/_?showConnect=true).
## Shared pooler
@@ -97,11 +93,7 @@ The connection string looks like this:
postgres://postgres.apbkobhfnmcqqzqeeqss:[YOUR-PASSWORD]@aws-0-[REGION].pooler.supabase.com:5432/postgres
```
Get your project's session mode string from the [Database Settings](/dashboard/project/_/settings/database) page:
1. Go to the `Settings` section.
2. Click `Database`.
3. Under `Connection string`, make sure `Display connection pooler` is checked and `Session mode` is selected. Copy the URI.
Get your project's Session pooler connection string from your project dashboard by clicking [Connect](https://supabase.com/dashboard/project/_?showConnect=true).
### Supavisor transaction mode
@@ -119,11 +111,7 @@ The connection string looks like this:
postgres://postgres.apbkobhfnmcqqzqeeqss:[YOUR-PASSWORD]@aws-0-[REGION].pooler.supabase.com:6543/postgres
```
Get your project's transaction mode string from the [Database Settings](/dashboard/project/_/settings/database) page:
1. Go to the `Settings` section.
2. Click `Database`.
3. Under `Connection string`, make sure `Display connection pooler` is checked and `Transaction mode` is selected. Copy the URI.
Get your project's Transaction pooler connection string from your project dashboard by clicking [Connect](https://supabase.com/dashboard/project/_?showConnect=true).
## Dedicated pooler
@@ -32,7 +32,7 @@ If you do not have DBeaver, you can download it from its [website](https://dbeav
<StepHikeCompact.Step step={3}>
<StepHikeCompact.Details title="Get Your Credentials">
Inside the Dashboard's [Database Settings](https://supabase.com/dashboard/project/_/settings/database), note your session mode's:
On your project dashboard, click [Connect](https://supabase.com/dashboard/project/_?showConnect=true), note your session pooler's:
- host
- username
@@ -40,7 +40,7 @@ hideToc: true
<StepHikeCompact.Details title="Connect to Postgres">
Connect your Postgres server to Metabase.
- On your project dashboard click on [Connect](https://supabase.com/dashboard/project/_?showConnect=true)
- On your project dashboard, click [Connect](https://supabase.com/dashboard/project/_?showConnect=true)
- View parameters under "Session pooler"
<Admonition type="note" label="connection notice">
@@ -42,7 +42,7 @@ If you use special symbols in your Postgres password, you must remember to [perc
### Changing your project password
When you created your project you were also asked to enter a password. This is actually the password for the `postgres` role in your database. You can update this from the Dashboard under the [database settings](https://supabase.com/dashboard/project/_/settings/database) page. You should _never_ give this to third-party service unless you absolutely trust them. Instead, we recommend that you create a new user for every service that you want to give access too. This will also help you with debugging - you can see every query that each role is executing in your database within `pg_stat_statements`.
When you created your project you were also asked to enter a password. This is the password for the `postgres` role in your database. You can update this from the Dashboard under the [database settings](https://supabase.com/dashboard/project/_/settings/database) page. You should _never_ give this to third-party service unless you absolutely trust them. Instead, we recommend that you create a new user for every service that you want to give access too. This will also help you with debugging - you can see every query that each role is executing in your database within `pg_stat_statements`.
Changing the password does not result in any downtime. All connected services, such as PostgREST, PgBouncer, and other Supabase managed services, are automatically updated to use the latest password to ensure availability. However, if you have any external services connecting to the Supabase database using hardcoded username/password credentials, a manual update will be required.
+2 -2
View File
@@ -122,8 +122,8 @@ If you plan to solely use Prisma instead of the Supabase Data API (PostgREST), t
<StepHikeCompact.Step step={3}>
<StepHikeCompact.Details title="Add your connection information to your .env file">
- Visit the [Database Settings](https://supabase.com/dashboard/project/_/settings/database)
- Find your Supavisor Session Mode string. It should end with 5432. It will be used in your `.env` file.
- On your project dashboard, click [Connect](https://supabase.com/dashboard/project/_?showConnect=true)
- Find your Supavisor Session pooler string. It should end with 5432. It will be used in your `.env` file.
<Admonition type="note">
If you're in an [IPv6 environment](https://github.com/orgs/supabase/discussions/27034) or have the IPv4 Add-On, you can use the direct connection string instead of Supavisor in Session mode.
</Admonition>
@@ -56,7 +56,7 @@ Prisma couldn't establish a connection with Postgres or Supavisor before the tim
### Solutions: [#solution-cant-reach-database-server-at]
- **Check database health**: Use the [Reports Dashboard](https://supabase.com/dashboard/project/_/reports/database) to monitor CPU, memory, and I/O usage. If the database is overloaded, consider increasing your [compute size](https://supabase.com/docs/guides/platform/compute-add-ons) or [optimizing your queries](https://supabase.com/docs/guides/database/query-optimization).
- **Verify connection string**: Double-check the connection string in your Prisma configuration to ensure it matches one in your [Database Settings](https://supabase.com/dashboard/project/_/settings/database).
- **Verify connection string**: Double-check the connection string in your Prisma configuration to ensure it matches in your [project connect page](https://supabase.com/dashboard/project/_?showConnect=true).
- **Increase connection timeout**: Try increasing the `connect_timeout` parameter in your Prisma configuration to give it more time to establish a connection.
```md
@@ -106,14 +106,17 @@ You can use the [Supabase CLI](/docs/guides/cli) to manage changes inside a loca
<StepHikeCompact.Step step={2}>
<StepHikeCompact.Details title="Pull your database migration" fullWidth>
Pull your database changes using `supabase db pull`. You can find your database URL in your [database settings](https://supabase.com/dashboard/project/_/settings/database), under the URI tab of the Connection String settings panel. Make sure **Use connection pooling** is checked so you can use the IPv4-enabled connection pooler. (Without connection pooling, your database is only accessible over IPv6, which isn't yet supported by all network providers.)
Pull your database changes using `supabase db pull`. To get your database connection string, go to your project dashboard, click [Connect](https://supabase.com/dashboard/project/_?showConnect=true) and look for the Session pooler connection string.
```markdown
supabase db pull --db-url <db_url>
supabase db pull --db-url <db_connection_string>
# Your Database URL looks something like:
# Your Database connection string will look like this:
# postgres://postgres.xxxx:password@xxxx.pooler.supabase.com:6543/postgres
```
<Admonition type="note">
If you're in an [IPv6 environment](https://github.com/orgs/supabase/discussions/27034) or have the IPv4 Add-On, you can use the direct connection string instead of Supavisor in Session mode.
</Admonition>
</StepHikeCompact.Details>
</StepHikeCompact.Step>
@@ -49,13 +49,13 @@ hideToc: true
Go to [database.new](https://database.new) and create a new Supabase project. Save your database password securely.
When your project is up and running, navigate to the [database settings](https://supabase.com/dashboard/project/_/settings/database) to find the URI connection string. Make sure **Use connection pooling** is checked and **Session mode** is selected. Then copy the URI. Replace the password placeholder with your saved database password.
When your project is up and running, navigate to your project dashboard and click on [Connect](https://supabase.com/dashboard/project/_?showConnect=true).
<Admonition type="tip">
Look for the Session Pooler connection string and copy the string. You will need to replace the Password with your saved database password. You can reset your database password in your [database settings](https://supabase.com/dashboard/project/_/settings/database) if you do not have it.
If your network supports IPv6 connections, you can also use the direct connection string. Uncheck **Use connection pooling** and copy the new URI.
</Admonition>
<Admonition type="note">
If you're in an [IPv6 environment](https://github.com/orgs/supabase/discussions/27034) or have the IPv4 Add-On, you can use the direct connection string instead of Supavisor in Session mode.
</Admonition>
</StepHikeCompact.Details>
@@ -31,13 +31,13 @@ hideToc: true
Go to [database.new](https://database.new) and create a new Supabase project. Save your database password securely.
When your project is up and running, navigate to the [database settings](https://supabase.com/dashboard/project/_/settings/database) to find the URI connection string. Make sure **Use connection pooling** is checked and **Session mode** is selected. Then copy the URI. Replace the password placeholder with your saved database password.
When your project is up and running, navigate to your project dashboard and click on [Connect](https://supabase.com/dashboard/project/_?showConnect=true).
<Admonition type="tip">
Look for the Session Pooler connection string and copy the string. You will need to replace the Password with your saved database password. You can reset your database password in your [database settings](https://supabase.com/dashboard/project/_/settings/database) if you do not have it.
If your network supports IPv6 connections, you can also use the direct connection string. Uncheck **Use connection pooling** and copy the new URI.
</Admonition>
<Admonition type="note">
If you're in an [IPv6 environment](https://github.com/orgs/supabase/discussions/27034) or have the IPv4 Add-On, you can use the direct connection string instead of Supavisor in Session mode.
</Admonition>
</StepHikeCompact.Details>
@@ -72,7 +72,7 @@ nslookup db.<PROJECT_REF>.supabase.co
## Identifying your connections
The pooler and direct connection strings can be found in the [database settings](https://supabase.com/dashboard/project/_/settings/database):
The pooler and direct connection strings can be found in the [project connect page](https://supabase.com/dashboard/project/_?showConnect=true):
#### Direct connection
@@ -23,8 +23,8 @@ Supabase's core is Postgres, enabling the use of row-level security and providin
## Retrieve your Supabase host [#retrieve-supabase-host]
1. If you're new to Supabase, [create a project](https://database.new). Make a note of your password, you will need this later. If you forget it, you can [reset it here](https://supabase.com/dashboard/project/_/settings/database).
1. Go to the [Database settings](https://supabase.com/dashboard/project/_/settings/database) for your project in the Supabase Dashboard.
1. Under **Connection Info**, note your Host (`$SUPABASE_HOST`).
1. On your project dashboard, click [Connect](https://supabase.com/dashboard/project/_?showConnect=true)
1. Under the Session pooler, click on the View parameters under the connect string. Note your Host (`$SUPABASE_HOST`).
![Finding Supabase host address](/docs/img/guides/resources/migrating-to-supabase/amazon-rds/database-settings-host.png)
@@ -30,8 +30,8 @@ Supabase provides several [tools](https://github.com/supabase-community/firebase
}
```
1. Go to the [Database settings](https://supabase.com/dashboard/project/_/settings/database) for your project in the Supabase Dashboard.
1. Under `Connection parameters`, enable `Use connection pooling` and set the mode to `Session`. Replace the `Host` and `User` fields with the values shown.
1. On your project dashboard, click [Connect](https://supabase.com/dashboard/project/_?showConnect=true)
1. Under the Session pooler, click on the View parameters under the connect string. Replace the `Host` and `User` fields with the values shown.
1. Enter the password you used when you created your Supabase project in the `password` entry in the `supabase-service.json` file.
## Generate a Firebase private key [#generate-firebase-private-key]
@@ -29,8 +29,8 @@ The Firestore `collection` is "flattened" and converted to a table with basic co
}
```
1. Go to the [Database settings](https://supabase.com/dashboard/project/_/settings/database) for your project in the Supabase Dashboard.
1. Under `Connection parameters`, enable `Use connection pooling` and set the mode to `Session`. Replace the `Host` and `User` fields with the values shown.
1. On your project dashboard, click [Connect](https://supabase.com/dashboard/project/_?showConnect=true)
1. Under the Session pooler, click on the View parameters under the connect string. Replace the `Host` and `User` fields with the values shown.
1. Enter the password you used when you created your Supabase project in the `password` entry in the `supabase-service.json` file.
## Generate a Firebase private key [#generate-firebase-private-key]
@@ -35,8 +35,8 @@ Alternatively, use the [Heroku to Supabase migration tool](https://migrate.supab
## Retrieve your Supabase connection string [#retrieve-supabase-connection-string]
1. If you're new to Supabase, [create a project](https://supabase.com/dashboard).
1. Go to the [Database settings](https://supabase.com/dashboard/project/_/settings/database) for your project in the Supabase Dashboard.
1. Under **Connection string**, make sure `Use connection pooling` is enabled. Copy the URI and replace the password placeholder with your database password.
1. Get your project's Session pooler connection string from your project dashboard by clicking [Connect](https://supabase.com/dashboard/project/_?showConnect=true).
1. Replace [YOUR-PASSWORD] in the connection string with your database password. You can reset your database password on the [Database settings page](https://supabase.com/dashboard/project/_/settings/database) if you do not have it.
## Export your Heroku database to a file [#export-heroku-database]
@@ -22,8 +22,8 @@ Before you begin the migration, you need to collect essential information about
1. If you're new to Supabase, [create a project](https://supabase.com/dashboard).
Make a note of your password, you will need this later. If you forget it, you can [reset it here](https://supabase.com/dashboard/project/_/settings/database).
1. Go to the [Database settings](https://supabase.com/dashboard/project/_/settings/database) for your project in the Supabase Dashboard.
1. Under **Connection Info**, note your Host (`$SUPABASE_HOST`).
1. On your project dashboard, click [Connect](https://supabase.com/dashboard/project/_?showConnect=true)
1. Under the Session pooler, click on the View parameters under the connect string. Note your Host (`$SUPABASE_HOST`).
![Finding Supabase host address](/docs/img/guides/resources/migrating-to-supabase/mssql/database-settings-host.png)
@@ -23,8 +23,8 @@ Before you begin the migration, you need to collect essential information about
1. If you're new to Supabase, [create a project](https://supabase.com/dashboard).
Make a note of your password, you will need this later. If you forget it, you can [reset it here](https://supabase.com/dashboard/project/_/settings/database).
1. Go to the [Database settings](https://supabase.com/dashboard/project/_/settings/database) for your project in the Supabase Dashboard.
1. Under **Connection Info**, note your Host (`$SUPABASE_HOST`).
1. On your project dashboard, click [Connect](https://supabase.com/dashboard/project/_?showConnect=true)
1. Under the Session pooler, click on the View parameters under the connect string. Note your Host (`$SUPABASE_HOST`).
![Finding Supabase host address](/docs/img/guides/resources/migrating-to-supabase/mysql/database-settings-host.png)
@@ -34,9 +34,8 @@ export OLD_DB_URL="postgresql://neondb_owner:xxxxxxxxxxxxxxx-random-word-yyyyyyy
1. If you're new to Supabase, [create a project](https://supabase.com/dashboard).
Make a note of your password, you will need this later. If you forget it, you can [reset it here](https://supabase.com/dashboard/project/_/settings/database).
1. Go to the [Database settings](https://supabase.com/dashboard/project/_/settings/database) for your project in the Supabase Dashboard.
1. Under **Connection string**, select **URI**, make sure **Display connection pooler** is checked, and **Mode: Session** is set.
1. Click the **Copy** button to the right of your connection string to copy it to the clipboard.
1. On your project dashboard, click [Connect](https://supabase.com/dashboard/project/_?showConnect=true)
1. Under the Session pooler, click the **Copy** button to the right of your connection string to copy it to the clipboard.
## Set your `NEW_DB_URL` environment variable
@@ -25,8 +25,13 @@ Example:
1. If you're new to Supabase, [create a project](https://supabase.com/dashboard).
Make a note of your password, you will need this later. If you forget it, you can [reset it here](https://supabase.com/dashboard/project/_/settings/database).
1. Go to the [Database settings](https://supabase.com/dashboard/project/_/settings/database) for your project in the Supabase Dashboard.
1. Under **Connection string**, make sure `Use connection pooling` is enabled. Copy the URI and replace the password placeholder with your database password.
1. On your project dashboard, click [Connect](https://supabase.com/dashboard/project/_?showConnect=true)
1. Under Session pooler, Copy the connection string and replace the password placeholder with your database password.
<Admonition type="note">
If you're in an [IPv6 environment](https://github.com/orgs/supabase/discussions/27034) or have
the IPv4 Add-On, you can use the direct connection string instead of Supavisor in Session mode.
</Admonition>
![Finding Supabase host address](/docs/img/guides/resources/migrating-to-supabase/postgres/database-settings-host.png)
@@ -29,8 +29,13 @@ Example:
1. If you're new to Supabase, [create a project](https://supabase.com/dashboard).
Make a note of your password, you will need this later. If you forget it, you can [reset it here](https://supabase.com/dashboard/project/_/settings/database).
1. Go to the [Database settings](https://supabase.com/dashboard/project/_/settings/database) for your project in the Supabase Dashboard.
1. Under **Connection string**, make sure `Use connection pooling` is enabled. Copy the URI and replace the password placeholder with your database password.
1. On your project dashboard, click [Connect](https://supabase.com/dashboard/project/_?showConnect=true)
1. Under Session pooler, Copy the connection string and replace the password placeholder with your database password.
<Admonition type="note">
If you're in an [IPv6 environment](https://github.com/orgs/supabase/discussions/27034) or have
the IPv4 Add-On, you can use the direct connection string instead of Supavisor in Session mode.
</Admonition>
## Migrate the database
@@ -41,9 +41,8 @@ export OLD_DB_URL="postgres://default:xxxxxxxxxxxx@yy-yyyyy-yyyyyy-yyyyyyy.us-we
1. If you're new to Supabase, [create a project](https://supabase.com/dashboard).
Make a note of your password, you will need this later. If you forget it, you can [reset it here](https://supabase.com/dashboard/project/_/settings/database).
1. Go to the [Database settings](https://supabase.com/dashboard/project/_/settings/database) for your project in the Supabase Dashboard.
1. Under **Connection string**, select **URI**, make sure **Display connection pooler** is checked, and **Mode: Session** is set.
1. Click the **Copy** button to the right of your connection string to copy it to the clipboard.
1. On your project dashboard, click [Connect](https://supabase.com/dashboard/project/_?showConnect=true)
1. Under the Session pooler, click the **Copy** button to the right of your connection string to copy it to the clipboard.
## Set your `NEW_DB_URL` environment variable
@@ -21,10 +21,10 @@ breadcrumb: 'Migrations'
<StepHikeCompact.Step step={3}>
<StepHikeCompact.Details title="Get the new database connection string" fullWidth>
Go to the [project page](/dashboard/project/_/) and click the "**Connect**" button at the top of the page for the connection string.
On your project dashboard, click [Connect](https://supabase.com/dashboard/project/_?showConnect=true).
<Admonition type="note">
Use the Session pooler connection string by default. If your ISP supports IPv6, use the direct connection string.
Use the Session pooler connection string by default. If your ISP supports IPv6 or you have the IPv4 add-on enabled, use the direct connection string.
</Admonition>
Session pooler connection string:
@@ -131,7 +131,7 @@ breadcrumb: 'Migrations'
<StepHikeCompact.Step step={4}>
<StepHikeCompact.Details title="Get the database password" fullWidth>
Reset the password in the [Database Settings](/dashboard/project/_/settings/database).
Reset the password in the [project connect page](/dashboard/project/_?showConnect=true).
Replace ```[YOUR-PASSWORD]``` in the connection string with the database password.
@@ -59,20 +59,15 @@ Here are some things that are not stored directly in your database and will requ
- Database extensions and settings
- Read Replicas
Here is a non-exhaustive list of items that are commonly asked about and will be migrated with your backup restoration:
- Database triggers
- Database functions
## Restore backup
<StepHikeCompact>
<StepHikeCompact.Step step={1}>
<StepHikeCompact.Details title="Get the new database connection string" fullWidth>
Go to the [project page](/dashboard/project/_/) and click the "**Connect**" button at the top of the page for the connection string.
On your project dashboard, click [Connect](https://supabase.com/dashboard/project/_?showConnect=true).
<Admonition type="note">
Use the Session pooler connection string by default. If your ISP supports IPv6, use the direct connection string.
Use the Session pooler connection string by default. If your ISP supports IPv6 or you have the IPv4 add-on enabled, use the direct connection string.
</Admonition>
Session pooler connection string:
@@ -33,7 +33,7 @@ sudo apt-get update
sudo apt-get install postgresql-client
```
Once installed, you can find your PSQL string in the [Database Settings](https://supabase.com/dashboard/project/_/settings/database). Make sure if you are using the pooler connection that it is in session mode (port 5432).
Once installed, you can find your PSQL string on the dashboard by clicking [connect](https://supabase.com/dashboard/project/_?showConnect=true). Make sure if you are using the pooler connection that it is the Session pooler (port 5432).
<Admonition type="tip">
@@ -46,7 +46,7 @@ sudo apt-get update
sudo apt-get install postgresql-client
```
Once installed, you can find your PSQL string from the [Database Settings](https://supabase.com/dashboard/project/_/settings/database), which can be executed in the terminal to create a psql session.
Once installed, you can find your PSQL string on the dashboard by clicking [connect](https://supabase.com/dashboard/project/_?showConnect=true). Make sure if you are using the pooler connection that it is the Session pooler (port 5432).
If your network can use IPv6, consider using the direct connection string instead of Supavisor. It's not mandatory, but for tasks that run a long time, it's best to reduce network complexity. To check if your network is compatible, use this cURL command to request your IPv6 address:
@@ -54,7 +54,7 @@ If your network can use IPv6, consider using the direct connection string instea
curl -6 https://ifconfig.co/ip
```
If an address is returned, you should be able to use your direct connection string found in the [Database Settings](https://supabase.com/dashboard/project/_/settings/database):
If an address is returned, you should use your direct connection string found on the dashboard by clicking [connect](https://supabase.com/dashboard/project/_?showConnect=true).
**3. Increase memory for index creation (optional)**
@@ -104,7 +104,8 @@ If your task is particularly long, you can speed it up by boosting your computin
**7. Consider increasing disk size (optional)**
HSNW indexes can produce temporary files during their construction that may consume a few GBs worth of disk. Consider increasing the disk size in the [Database Settings](https://supabase.com/dashboard/project/_/settings/database) to accommodate for short-term disk stress.
HSNW indexes can produce temporary files during their construction that may consume a few GBs worth of disk.
Consider increasing the disk size in the [Compute and Disk settings](https://supabase.com/dashboard/project/_/settings/compute-and-disk) to accommodate for short-term disk stress.
<img
width="947"
@@ -63,7 +63,7 @@ If a database exhibited some of these metrics for prolonged periods, then there
- Scale the database to get more IO if possible
- Optimize queries/tables or refactor database/app to reduce IO
- Spin-up a [read-replica](https://supabase.com/dashboard/project/_/settings/infrastructure)
- Modify IO configs in the [Database Settings](https://supabase.com/dashboard/project/_/settings/database)
- Modify IO configs in the [Compute and Disk settings](https://supabase.com/dashboard/project/_/settings/compute-and-disk)
- [Partitions](https://supabase.com/docs/guides/database/partitions): Generally should be used on very large tables to minimize data pulled from disk
Other useful Supabase Grafana guides:
@@ -148,7 +148,7 @@ Useful Links:
- [How to Monitor Connections and Find the Correct Pool Size](https://github.com/orgs/supabase/discussions/27141).
- [Supavisor FAQ](https://github.com/orgs/supabase/discussions/21566)
Supabase provides 3 connection strings in the [Database Settings](https://supabase.com/dashboard/project/_/settings/database). You can use all three or just the ones most relevant to your project.
Supabase provides 3 database connection strings that can be used simultaneously if necessary. You can find them on the dashboard by clicking [Connect](https://supabase.com/dashboard/project/_?showConnect=true).
### Direct connection:
@@ -9,7 +9,9 @@ database_id = "c89147f8-a66a-4c04-a1a7-45442fd7f2ee"
### Finding your database hostname
Your database's hostname is crucial for establishing a direct connection. It resolves to the underlying IP address of your database. To find your hostname, navigate to your [Database Settings](https://supabase.com/dashboard/project/_/settings/database). It's important to note that the pooler (connection pooler) has a different IP than your database. Therefore, to reveal the database host and direct connection string, you must hide the pooler connection string.
Your database's hostname is crucial for establishing a direct connection. It resolves to the underlying IP address of your database.
To find your hostname, navigate to the dashboard and click [Connect](https://supabase.com/dashboard/project/_?showConnect=true). Look at the Direct connection string and click the View parameters under it to see the hostname.
Example Hostname: `db.zcjtzmeifsoteyjytnbc.supabase.co`
@@ -59,7 +59,7 @@ Example IPv6 Address: `2a05:d014:1c06:5f0c:d7a9:8616:bee2:30df`
### Identifying your connections:
The pooler and direct connection strings can be found in the [database settings](https://supabase.com/dashboard/project/_/settings/database):
The pooler and direct connection strings can be found on the dashboard by clicking [Connect](https://supabase.com/dashboard/project/_?showConnect=true).
> "Note uses an IPv6 address by default
@@ -33,7 +33,7 @@ They sit between the database and your client servers. They are solely optimized
### Where are the connection strings
Supabase provides 3 database connection strings that can be used simultaneously if necessary. All can be viewed in the connection string section of the [Database Settings](https://supabase.com/dashboard/project/_/settings/database)
Supabase provides 3 database connection strings that can be used simultaneously if necessary. You can find them on the dashboard by clicking [Connect](https://supabase.com/dashboard/project/_?showConnect=true).
<img
width="999"
@@ -89,7 +89,7 @@ Now, imagine the tournament organizers decide to expand the venue to house 200 p
### In the context of Supavisor, what does "pool size" mean?
"Pool size" refers to the maximum number of direct connections the pooler can maintain per unique user, database, and mode combination. You can adjust it in the [Database Settings](https://supabase.com/dashboard/project/_/settings/database) to strike a balance between efficient resource utilization and accommodating peak traffic.
"Pool size" refers to the maximum number of direct connections the pooler can maintain per unique user, database, and mode combination. You can adjust it in the [project connect page](https://supabase.com/dashboard/project/_?showConnect=true) to strike a balance between efficient resource utilization and accommodating peak traffic.
### What is the "user+db+mode" combination?
@@ -15,7 +15,7 @@ If you are deploying to:
- serverless functions
- horizontally auto-scaling deployments
It is recommended that you connect with the pooler in transaction mode (port 6543), which can be found in the [Database Settings](https://supabase.com/dashboard/project/_/settings/database):
It is recommended that you connect with the pooler in transaction mode (port 6543), which can be found on the dashboard by clicking [Connect](https://supabase.com/dashboard/project/_?showConnect=true).
```sh
# Example transaction mode string:
@@ -36,7 +36,7 @@ When relying on Supavisor, it's important to pick an adequate pool size. This gu
## Deploying to stationary servers
For stationary servers, such as VMs and long-running containers, it is recommended to use your direct connection string, which can be found in the [Database Settings](https://supabase.com/dashboard/project/_/settings/database)
For stationary servers, such as VMs and long-running containers, it is recommended to use your direct connection string, which can be found on the dashboard by clicking [Connect](https://supabase.com/dashboard/project/_?showConnect=true).
```
# Example DB string:
Binary file not shown.

Before

Width:  |  Height:  |  Size: 40 KiB

After

Width:  |  Height:  |  Size: 277 KiB

@@ -113,7 +113,7 @@ If you're using the PgBouncer connection string and haven't migrated to the new
## Getting started
If you're using the Supabase platform, you can already access the pooler URL in your [database settings](https://supabase.com/dashboard/project/_/settings/database).
If you're using the Supabase platform, you can already access the pooler URL in your [project connect page](https://supabase.com/dashboard/project/_?showConnect=true).
If you're looking to self-host Supavisor, check out [GitHub repository](https://github.com/supabase/supavisor) and [documentation](https://supabase.github.io/supavisor/).
+1 -1
View File
@@ -129,6 +129,6 @@ If you want to ensure your company continues to run smoothly, start making as ma
If you are a Supabase customer, we have 3 simple solutions:
1. Switch your “direct” database connection to our new Supavisor database proxy. You can find these details in the [Database Settings](https://supabase.com/dashboard/project/_/settings/database).
1. Switch your “direct” database connection to our new Supavisor database proxy. You can find these details in the [project connect page](https://supabase.com/dashboard/project/_?showConnect=true).
2. We will bring out a paid add-on for IPv4. This will be $4/m - we will simply pass on the AWS cost to you. Update: The add-on is now available on all paid plans.
3. We'll support you. We know that this period will be difficult for many. If you encounter any issues, simply reach out to us via [supabase.help](https://supabase.help) and we will make sure your databases continue to run smoothly.
@@ -65,7 +65,7 @@ Note: this template does not use [Supabase Auth](/auth) but rather Laravel's bui
Go to [database.new](https://database.new) and create a new Supabase project. Save your database password securely.
When your project is up and running, navigate to the [database settings](/dashboard/project/_/settings/database) to find the URI connection string.
When your project is up and running, navigate to the [project connect page](/dashboard/project/_?showConnect=true) to find the URI connection string.
Laravel ships with a Postgres adapter out of the box, you can simply configure it via the environment variables. You can find the database URL in your [Supabase Dashboard](/dashboard/project/_/settings/database).
@@ -54,7 +54,7 @@ rails new blog -d=postgresql
Go to [database.new](https://database.new) and create a new Supabase project. Save your database password securely.
When your project is up and running, navigate to the [database settings](https://supabase.com/dashboard/project/_/settings/database) to find the URI connection string.
When your project is up and running, navigate to the [project connect page](https://supabase.com/dashboard/project/_?showConnect=true) to find the URI connection string.
Rails ships with a Postgres adapter included, you can simply configure it via the environment variables. You can find the database URL in your [Supabase Dashboard](/dashboard/project/_/settings/database).
@@ -42,7 +42,7 @@ If you haven't already, head over to [database.new](https://database.new) and cr
When creating your project, make sure to note down your database password as you will need it to construct the `DB_URL` in the next step.
You can find the database connection string in your Supabase Dashboard [database settings](https://supabase.com/dashboard/project/_/settings/database). Select "Use connection pooling" with `Mode: Session` for a direct connection to your Postgres database. It will look something like this:
You can find the database connection string in your Supabase Dashboard [project connect page](https://supabase.com/dashboard/project/_?showConnect=true). Select "Use connection pooling" with `Mode: Session` for a direct connection to your Postgres database. It will look something like this:
```txt
postgresql://postgres.[PROJECT-REF]:[YOUR-PASSWORD]@aws-0-[REGION].pooler.supabase.com:5432/postgres
@@ -50,7 +50,7 @@ POSTGRES_PRISMA_URL="postgres://postgres.YOUR-PROJECT-REF:[YOUR-PASSWORD]@aws-0-
POSTGRES_URL_NON_POOLING="postgres://postgres.YOUR-PROJECT-REF:[YOUR-PASSWORD]@aws-0-[REGION].pooler.supabase.com:5432/postgres" # Session Mode
```
You can find the values in the [Database settings](/dashboard/project/_/settings/database) of your Supabase Dashboard.
You can find the values in the [project connect page](/dashboard/project/_?showConnect=true) of your Supabase Dashboard.
For more details on using Prisma with Supabase, read the [official docs](/partners/integrations/prisma).
@@ -84,7 +84,7 @@ Import the open map data into a `places` table in Supabase:
psql -h aws-0-us-west-1.pooler.supabase.com -p 5432 -d postgres -U postgres.project-ref < places.sql
```
You can find the credentials in the [Database settings](/dashboard/project/_/settings/database) of your Supabase Dashboard.
You can find the credentials in the [project connect page](/dashboard/project/_?showConnect=true) of your Supabase Dashboard.
### Enable RLS and create a public read policy
+1 -1
View File
@@ -201,7 +201,7 @@
"The [`vecs`](https://supabase.github.io/vecs/api/) library wraps a pythonic interface around PostgreSQL and pgvector.\n",
"A collection in `vecs` maps 1:1 with a PostgreSQL table.\n",
"\n",
"First you will need to establish a connection to your database. You can find the Postgres connection string in the [Database Settings](https://supabase.com/dashboard/project/_/settings/database) of your Supabase project.\n",
"First you will need to establish a connection to your database. You can find the Postgres connection string in the [project connect page](https://supabase.com/dashboard/project/_?showConnect=true) of your Supabase project.\n",
"\n",
"> **Note:** SQLAlchemy requires the connection string to start with `postgresql://` (instead of `postgres://`). Don't forget to rename this after copying the string from the dashboard.\n",
"\n",
+1 -1
View File
@@ -58,7 +58,7 @@
"\n",
"Before you can interact with vecs, create the client to communicate with Postgres.\n",
"\n",
"In Supabase, you can find the Postgres connection string in the [Database Settings](https://supabase.com/dashboard/project/_/settings/database) of your Supabase project.\n",
"In Supabase, you can find the Postgres connection string in the [project connect screen](https://supabase.com/dashboard/project/_?showConnect=true) of your Supabase project.\n",
"\n",
"> **Note:** SQLAlchemy requires the connection string to start with `postgresql://` (instead of `postgres://`). Don't forget to rename this after copying the string from the dashboard.\n",
"\n",