Skip to content

Commit d108c15

Browse files
mhartingtonaidankmcalisterankur-archArthurGambyArthur Gamby
authored
docs(postgres): remove accelerate reference (#7246)
* DC-5044 `prisma-client-js` deprecated (#7219) * `prisma-client-js` deprecated * chore: empty commit * broken link updated * DC-5040 Env Vars via Config (#7227) * added env vars section to various pages * minor coderabbit updates * verbose removed * test removed redirect list * removed quickstart addition * converted quickstarts back * urls deprecated (#7226) * minimum version uodated (#7234) * DC-5043 Middleware removed from docs (#7233) * middleware deleted * more middleware removed * more middleware removed * coderabbit changes * DC-6174: Remove adapter, engine, directUrl, studio from config (#7256) * feat: add new features * fix: revert links * fix: broken links * fix: broken link * feat: restructure getting started side nav (#7245) * feat(docs): add youtube embeded link to blog post (#7220) Co-authored-by: Arthur Gamby <[email protected]> * feat(docs): add quick section to blog after the prompt (#7221) Co-authored-by: Arthur Gamby <[email protected]> * DC-5242 Astro Better-Auth Guide (#7215) * doc created * nextjs betterauth fixed * guide broken down into manageable steps * image added * Optimised images with calibre/image-actions * image updated * Optimised images with calibre/image-actions * lychee only comments on broken links * config updated * lychee updated based on CR comment * chore: trigger CI checks * ignore gnu * fix: update naming to better-auth DC-6120 * Optimised images with calibre/image-actions * chore: shorten word --------- Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com> Co-authored-by: Ankur Datta <[email protected]> * feat: restructure getting started side nav * DC-5841 Removed Linkspector (#7231) * removed linkspector * retrigger * retrigger * retrigger * Update label for Prisma Postgres tab (#7236) * fix: content changes for getting started page (#7216) * fix: content changes for getting started page * fix: add redirects * getting started checkpoint * css styles fixed * updates --------- Co-authored-by: Aidan McAlister <[email protected]> Co-authored-by: Aidan McAlister <[email protected]> * DC-5820 AI Agents Served Markdown (#7237) * ai crawler check successful * ai crawlers checked * update * added anthropic * middleware update * improve detection --------- Co-authored-by: Mike Hartington <[email protected]> * feat: add prisma-orm quickstarts * fix: update times and add proper links * fix: instropspect changes * feat: add get started from prisma orm page * feat: add other orms * fix: update other tools + ppg * fix: add more clarity * fix: add prisma postgres * feat: clear migrate from early access * fix: add to existing dbs sections * Remove MCP server exploration tip (#7241) Removed tip about using Cloudflare's AI Playground for MCP server exploration, as it no longer seems to reliably work. * fix: clean-up docs files * fix: typeorm missing urls * fix: broken link * fix: update titles * fix: clear redirect loop (#7250) * fix: add generate step + sqlite fixes * fix: clean-up redirects file DC-6228 * fix: clean-up unnecessary file * fix: remove unknown word * fix: add links --------- Co-authored-by: Arthur <[email protected]> Co-authored-by: Arthur Gamby <[email protected]> Co-authored-by: Aidan McAlister <[email protected]> Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com> Co-authored-by: Petra Donka <[email protected]> Co-authored-by: Aidan McAlister <[email protected]> Co-authored-by: Mike Hartington <[email protected]> * feat: update .env docs DC-6204 (#7259) * fix: clarify config file path better (#7261) * Update ORM docs (#7260) * update * use pg adapter instead of accelerate * update * add dotenv in prisma.config.ts * fix warning note * update * update * Update guides to use prisma.config.ts (#7243) * (feat) Update guides to use prisma.config.ts * refactor: Updated guides for Prisma 7 changes --------- Co-authored-by: Aman Varshney <[email protected]> * feat: update ppg for other dbs section (#7264) * feat: add kysley * feat: add drizzle * feat: add typeorm * fix: clean-up * feat: separate the sections better * fix: remove badges * feat: update prisma init related changes in other parts (#7267) * feat: add kysley * feat: add drizzle * feat: add typeorm * fix: clean-up * fix: update prisma init command changes * feat: update prisma cli docs * fix: clarify the usage of prisma init better * fix: add type defs * feat: add pg as a dependency * fix: broken internal link * Update docs to perform migrations with connection pooling and Prisma config (#7266) * feat: add mentions of new Prisma Studio (#7270) * feat: add mentions of new Prisma Studio * feat: add note for Studio for SQLite * Update content/100-getting-started/02-prisma-orm/100-quickstart/200-sqlite.mdx * Update content/100-getting-started/02-prisma-orm/200-add-to-existing-project/200-sqlite.mdx * fix: make prisma studio docs more accurate * fix: add missing punctuation * feat: add mention of mongo support coming for P7 (#7271) * feat: add mention of mongo support coming for mongo * fix: refinements * Update content/100-getting-started/02-prisma-orm/200-add-to-existing-project/800-mongodb.mdx * docs(postgres): remove accelerate reference Remove reference to accelerate and rework the docs to account for the new v7 changes * Optimised images with calibre/image-actions * docs(): update with feedback * Optimised images with calibre/image-actions * docs(ppg): updates * docs(): update based on feedback * docs(): update based on feedback --------- Co-authored-by: Aidan McAlister <[email protected]> Co-authored-by: Ankur Datta <[email protected]> Co-authored-by: Arthur <[email protected]> Co-authored-by: Arthur Gamby <[email protected]> Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com> Co-authored-by: Petra Donka <[email protected]> Co-authored-by: Aidan McAlister <[email protected]> Co-authored-by: Aman Varshney <[email protected]> Co-authored-by: Nurul Sundarani <[email protected]>
1 parent 143b0c8 commit d108c15

File tree

17 files changed

+102
-438
lines changed

17 files changed

+102
-438
lines changed

content/100-getting-started/03-prisma-postgres/100-quickstart/50-prisma-orm.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -257,4 +257,4 @@ You should see the created user and all users printed to the console!
257257
- [Prisma Postgres documentation](/postgres)
258258
- [Prisma Config reference](/orm/reference/prisma-config-reference)
259259
- [Database connection management](/orm/prisma-client/setup-and-configuration/databases-connections)
260-
- [Cache your queries](/postgres/database/caching#setting-up-caching-in-prisma-postgres)
260+
- [Cache your queries](/postgres/database/caching#setting-up-caching-in-prisma-postgres)

content/100-getting-started/index.mdx

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -127,11 +127,26 @@ You can also use Prisma Postgres with different tools or ORMs. Pick one of the o
127127
image={'/img/technologies/drizzle.svg'}
128128
tech="Drizzle"
129129
/>
130+
{/* <SquareLogo
131+
url="/getting-started/prisma-postgres/quickstart/typeorm"
132+
image={'/img/technologies/sequelize.svg'}
133+
tech="Sequelize"
134+
/> */}
130135
<SquareLogo
131136
url="/getting-started/setup-prisma/start-from-scratch/relational-databases-typescript-sqlserver"
132137
image={'/img/technologies/sequelize.svg'}
133138
tech="Sequelize"
134139
/>
140+
</List>
141+
142+
<br/>
143+
<br/>
144+
145+
### <Plus color="#16A394" width="24" height="24" /> Add Prisma to your favorite framework?
146+
147+
Working with **Next.js**, **Remix**, or another framework? You can easily add Prisma to your setup in just a few steps and start using it right away.
148+
149+
<List>
135150
<SquareLogo
136151
url="/getting-started/setup-prisma/start-from-scratch/relational-databases-typescript-planetscale"
137152
image={'/img/technologies/typeorm.svg'}

content/250-postgres/100-introduction/220-npx-create-db.mdx

Lines changed: 11 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -96,31 +96,24 @@ Here is an example output:
9696
┌ 🚀 Creating a Prisma Postgres database
9797
9898
│ Provisioning a temporary database in us-east-1...
99-
10099
│ It will be automatically deleted in 24 hours, but you can claim it.
101-
102100
◇ Database created successfully!
103101
104-
● Connect to your database →
105-
106-
│ Use this connection string optimized for Prisma ORM:
107-
│ prisma+postgres://accelerate.prisma-data.net/?api_key=...
108-
109-
│ Use this connection string for everything else:
102+
● Database Connection
103+
│ Connection String:
110104
│ postgresql://<username>:<password>@db.prisma.io:5432/postgres
111105
112106
◆ Claim your database →
113-
114-
│ Want to keep your database? Claim for free:
107+
│ Keep your database for free:
115108
│ https://create-db.prisma.io?projectID=proj_...
116109
117110
```
118111

119112

120-
Once you have the output, take the **Prisma ORM-optimized connection string** (`prisma+postgres://...`) and add it to your `.env` file as `DATABASE_URL`:
113+
Once you have the output, take the connection string and add it to your `.env` file as `DATABASE_URL`:
121114

122115
```env
123-
DATABASE_URL="prisma+postgres://accelerate.prisma-data.net/?api_key=..."
116+
DATABASE_URL="postgresql://<username>:<password>@db.prisma.io:5432/postgres"
124117
```
125118

126119
You can now follow the [Prisma Postgres quickstart guide](/getting-started/prisma-orm/quickstart/prisma-postgres) to connect your Prisma project to this database.
@@ -163,12 +156,12 @@ When you claim a database:
163156

164157
Here are the CLI flags for the `npx create-db` command:
165158

166-
| Flag | Shorthand | Description |
167-
|---------------|-----------|----------------------------------------------------------------------------------------------|
168-
| `--region` | `-r` | Specify a region. <br /> **Available regions:** `ap-southeast-1`, `ap-northeast-1`, `eu-central-1`, `eu-west-3`, `us-east-1`, `us-west-1` |
169-
| `--interactive` | `-i` | Run in interactive mode (select region from a list). |
170-
| `--json` | `-j` | Output machine-readable JSON and exit. |
171-
| `--help` | `-h` | Show this help message. |
159+
| Flag | Shorthand | Description |
160+
|-----------------|-----------|-------------------------------------------------------------------------------------------------------------------------------------------|
161+
| `--region` | `-r` | Specify a region. <br /> **Available regions:** `ap-southeast-1`, `ap-northeast-1`, `eu-central-1`, `eu-west-3`, `us-east-1`, `us-west-1` |
162+
| `--interactive` | `-i` | Run in interactive mode (select region from a list). |
163+
| `--json` | `-j` | Output machine-readable JSON and exit. |
164+
| `--help` | `-h` | Show this help message. |
172165

173166

174167
To view all CLI options use the `--help` or `-h` flag:

content/250-postgres/100-introduction/250-overview.mdx

Lines changed: 1 addition & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ toc: true
1212
It supports the following workflows:
1313

1414
- Schema migrations and queries (via [Prisma ORM](https://www.prisma.io/orm) or any other ORM/database library)
15-
- Connection pooling and caching (via [Prisma Accelerate](https://www.prisma.io/accelerate))
15+
- Connection pooling and caching
1616
- Local database workflows via [`prisma dev`](/postgres/database/local-development)
1717

1818
## Usage metrics
@@ -63,22 +63,6 @@ When changing your subscription from Free to Starter/Pro/Business or from Starte
6363
This is temporary. In the future, there won't be any downtime when up- or downgrading a plan.
6464
:::
6565

66-
## Bundling with Prisma Accelerate
67-
68-
Prisma Postgres comes bundled with [Prisma Accelerate](/accelerate).
69-
70-
### Using the Client extension for Prisma Accelerate (required)
71-
72-
Because all traffic to Prisma Postgres is routed through Accelerate's connection pool, your project must have the [`@prisma/extension-accelerate`](https://www.npmjs.com/package/@prisma/extension-accelerate) npm package installed. The extension then needs to be applied to the `PrismaClient` instance you use to interact with your database:
73-
74-
```ts
75-
import { PrismaClient } from '@prisma/client'
76-
import { withAccelerate } from '@prisma/extension-accelerate'
77-
78-
const prisma = new PrismaClient()
79-
.$extends(withAccelerate())
80-
```
81-
8266
## Technical details
8367

8468
### PostgreSQL version

content/250-postgres/1200-more/1000-faq.mdx

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -29,11 +29,8 @@ If you previously signed up using GitHub and want to switch to email and passwor
2929
3. Test Your Login
3030
- Log out and try logging in with your email and the password you just created.
3131

32-
:::note
33-
3432
If you encounter any issues, please contact our support team for help linking your accounts.
3533

36-
:::
3734

3835
### VS Code does not recognize the `$extends` method
3936

content/250-postgres/1200-more/900-troubleshooting.mdx

Lines changed: 0 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -33,28 +33,6 @@ npx prisma@latest init --db
3333

3434
This ensures that you're using the most up-to-date CLI, preventing issues with outdated command syntax.
3535

36-
## Warning: In production, we recommend using `prisma generate --no-engine`
37-
38-
### Problem
39-
40-
You're seeing the following error in your logs:
41-
42-
```
43-
prisma:warn: In production, we recommend using 'prisma generate --no-engine'
44-
```
45-
46-
### Cause
47-
48-
Prisma ORM by default uses a [query engine](/orm/overview/) binary that's deployed as part of the `@prisma/client` package. However, with Prisma Postgres, this is not needed.
49-
50-
### Solution
51-
52-
To remove this warning and generate Prisma Client without the query engine, you can run the following command:
53-
54-
```
55-
npx prisma generate --no-engine
56-
```
57-
5836
## Workspace plan limit reached when running `prisma init --db`
5937

6038
### Problem

content/250-postgres/300-database/400-connection-pooling.mdx

Lines changed: 6 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -6,48 +6,25 @@ tocDepth: 3
66
toc: true
77
---
88

9-
Prisma Postgres provides built-in [connection pooling](https://www.prisma.io/dataguide/database-tools/connection-pooling) by default, enabled by [Prisma Accelerate](/accelerate/). By using Prisma Postgres, you get the benefits of connection pooling without having to configure anything. The efficient management of database connections allows the database to process more queries without exhausting the available database connections, making your application more scalable.
10-
11-
In some cases, however, it may be beneficial to further configure connection pooling in order to optimize the performance of your application.
12-
13-
:::note
14-
15-
This document focuses on the connection pooling features of Prisma Postgres. For more information about the internal connection pool of Prisma ORM specifically, see our [ORM connection pooling documentation](/orm/prisma-client/setup-and-configuration/databases-connections/connection-pool).
16-
17-
:::
9+
Prisma Postgres provides built-in [connection pooling](https://www.prisma.io/dataguide/database-tools/connection-pooling) without you having to configure anything. The efficient management of database connections allows the database to process more queries without exhausting the available database connections, making your application more scalable.
1810

1911

2012
### Connection pooling in Prisma Postgres
2113

22-
Currently, Prisma Postgres allows a maximum of 10 concurrent database connections per Prisma Schema. This limit is typically sufficient due to Prisma Postgres's efficient unikernel-based architecture, which minimizes the need for large connection pools.
23-
24-
:::note
2514

26-
If you're using **your own database** with Prisma Accelerate, the connection limits differ:
15+
For Prisma Postgres, the connection limit depends on the plan you have signed up for.
2716

28-
- **Free plan**: Maximum of `10` connections.
29-
- **Starter plan**: Maximum of `10` connections. This is often sufficient for most workloads, but if you're expecting high traffic or intensive compute operations, you may want to [increase this limit](#configuring-the-connection-pool-size).
30-
- **Pro plan**: Supports up to `100` concurrent connections.
31-
- **Business plan**: Supports up to `1000` concurrent connections.
17+
| | Free | Starter | Pro | Business |
18+
|---------------------------|------|---------|-----|----------|
19+
| Connection Limit (Pooled) | 10 | 100 | 500 | 1000 |
3220

3321
You can compare plans on the [Prisma pricing page](https://www.prisma.io/pricing).
3422

35-
:::
36-
37-
38-
### Configuring the connection pool size
39-
40-
If you're **not using Prisma Postgres**, you can configure the connection pool size for Prisma ORM by specifying it [in the connection string](/orm/prisma-client/setup-and-configuration/databases-connections/connection-pool#setting-the-connection-pool-size).
41-
42-
For Prisma Postgres, the connection limit is currently **fixed at `10`** and cannot be changed.
43-
44-
If you're using Prisma Accelerate with your own database, you can configure the connection pool size through the `Connection limit` setting in your project on the [Accelerate setup page](/accelerate/getting-started).
4523

46-
### Configuring the connection pool timeout
24+
### Connection pool timeout
4725

4826
The connection pool timeout is the maximum number of seconds that a query will block while waiting for a connection from Prisma Postgres's internal connection pool. This occurs if the number of concurrent requests exceeds the connection limit, resulting in queueing of additional requests until a free connection becomes available. An exception is thrown if a free connection does not become available within the pool timeout. The connection pool timeout can be disabled by setting the value to 0.
4927

50-
Similar to the connection pool size, you may also configure the connection pool timeout via the _database connection string_. To adjust this value, you may add the `pool_timeout` parameter to the database connection string.
5128

5229
For example:
5330

content/250-postgres/300-database/550-local-development.mdx

Lines changed: 1 addition & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -10,21 +10,13 @@ sidebar_class_name: preview-badge
1010

1111
[Prisma Postgres](/postgres) is a production-grade, cloud-native database and is ideal for staging and production environments. For rapid iteration and isolated testing, you can run a _local_ Prisma Postgres instance (powered by [PGlite](https://pglite.dev)) via the `prisma dev` command. This page explains how to install and launch a local Prisma Postgres database.
1212

13-
:::note
14-
1513
Local Prisma Postgres is in [Preview](/orm/more/releases#preview) and is being actively developed.
1614

17-
:::
18-
1915
## Setting up local development for Prisma Postgres
2016

2117
Follow these steps to set up local Prisma Postgres for development.
2218

23-
:::note
24-
25-
Please ensure you're running Node.js 20 or later, as it's required for local Prisma Postgres.
26-
27-
:::
19+
Node.js v20 or later is required for local Prisma Postgres
2820

2921
### 1. Launching local Prisma Postgres
3022

@@ -58,16 +50,6 @@ If you want to connect via Prisma ORM, hit <kbd>h</kbd> on your keyboard, copy t
5850
DATABASE_URL="prisma+postgres://localhost:51213/?api_key=__API_KEY__"
5951
```
6052

61-
The `DATABASE_URL` is a connection string that Prisma uses to connect to the local Prisma Postgres server and is compatible with the [Prisma Postgres extension](https://www.npmjs.com/package/@prisma/extension-accelerate):
62-
63-
```ts
64-
import { withAccelerate } from '@prisma/extension-accelerate'
65-
66-
const prisma = new PrismaClient().$extends(withAccelerate())
67-
```
68-
69-
This ensures no additional code changes are needed when switching from local Prisma Postgres to Prisma Postgres in production.
70-
7153
Keep the local Prisma Postgres server running in the background while you work on your application.
7254

7355
### 2. Applying migrations and seeding data

content/250-postgres/300-database/650-direct-connections.mdx

Lines changed: 9 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ toc: true
88

99
## Overview
1010

11-
Prisma Postgres is the perfect choice for your applications, whether you connect to it via [Prisma ORM](/orm) or any other ORM, database library / tool of your choice. If you use it with Prisma ORM, Prisma Postgres comes with built-in connection pooling and an integrated caching layer (powered by [Prisma Accelerate](/accelerate/)).
11+
Prisma Postgres is the perfect choice for your applications, whether you connect to it via [Prisma ORM](/orm) or any other ORM, database library / tool of your choice. If you use it with Prisma ORM, Prisma Postgres comes with built-in connection pooling, and an integrated caching layer (powered by [Prisma Accelerate](/accelerate/)).
1212

1313
If you connect to it via another tool, you can do so with a [direct connection string](#connection-string) following the conventional PostgreSQL format.
1414

@@ -18,10 +18,12 @@ In order to get a direct connection string, you need to:
1818

1919
1. Open a project in your [Prisma Console](https://console.prisma.io) account (or create a new one)
2020
1. Navigate to your active Prisma Postgres instance.
21-
1. Click the **API Keys** tab in the project's sidenav.
22-
1. Click the **Create API key** button.
23-
1. In the popup, provide a **Name** for the API key and click **Create**.
24-
1. Copy the connection string starting with `postgres://`, this is your direct connection string.
21+
1. Click the **Connect to your database** button in your dashboard.
22+
1. Click the **Generate new connection string** button.
23+
1. If enabling connection pooling, click the toggle button
24+
1. Copy the connection string that is generated below.
25+
26+
![](/img/postgres/connection-string.png)
2527

2628
## Connection string
2729

@@ -45,7 +47,7 @@ SSL mode is required when connecting to Prisma Postgres via direct TCP, so you n
4547

4648
## Billing
4749

48-
When using direct TCP to connect to a Prisma Postgres instance, every SQL query is counted as a [billable operation](/postgres/introduction/overview#usage-based-pricing). Learn more on our [pricing page](https://www.prisma.io/pricing).
50+
When using direct TCP to connect to a Prisma Postgres instance, every request is counted as a [billable operation](/postgres/introduction/overview#usage-based-pricing). Learn more on our [pricing page](https://www.prisma.io/pricing).
4951

5052
## Temporary limitations
5153

@@ -55,16 +57,12 @@ Prisma Postgres closes idle connections after an extended period of time. If tha
5557

5658
### Connection limit
5759

58-
While direct connections are in Early Access, the following connection limits apply:
59-
6060
| | Free | Starter | Pro | Business |
6161
| ------------------------------------ | ---------------- | ---------------- | ---------------- | ---------------- |
6262
| **Connection limit** | Max 10 | Max 10 | Max 50 | Max 100 |
6363

6464
### Query and transaction timeouts
6565

66-
While direct connections are in Early Access, the following timeouts apply:
67-
6866
| | Free | Starter | Pro | Business |
6967
| ------------------------------------ | ---------------- | ---------------- | ---------------- | ---------------- |
7068
| **Query timeout** | Up to 10 seconds | Up to 10 seconds | Up to 10 seconds | Up to 10 seconds |
@@ -190,4 +188,4 @@ When using the TCP tunnel, keep the following in mind:
190188
- The tunnel does not support schema management (i.e., DDL queries outside of Prisma Migrate).
191189
- The tunnel should not be exposed to untrusted networks.
192190
- Always store API keys securely and avoid hardcoding them.
193-
- Ensure that only necessary users have direct access to the Prisma Postgres database.
191+
- Ensure that only necessary users have direct access to the Prisma Postgres database.

0 commit comments

Comments
 (0)