Skip to content

Commit

Permalink
chore: delete legacy platform content and put in place redirects (#5575)
Browse files Browse the repository at this point in the history
* delete legacy platform content and put in place redirects

* remove any mentions of data proxy from remaining docs

* remove any internal links to classic-projects

* Update content/200-orm/500-reference/100-prisma-schema-reference.mdx

Co-authored-by: Jan Piotrowski <[email protected]>

* Update content/200-orm/200-prisma-client/000-setup-and-configuration/050-databases-connections/index.mdx

Co-authored-by: Jan Piotrowski <[email protected]>

* Update content/200-orm/200-prisma-client/500-deployment/301-edge/550-deploy-to-deno-deploy.mdx

Co-authored-by: Jan Piotrowski <[email protected]>

* Update 05-prisma-product-names.mdx

* Update content/300-accelerate/200-getting-started.mdx

* Update content/200-orm/500-reference/500-preview-features/050-client-preview-features.mdx

* Update content/200-orm/500-reference/200-prisma-cli-reference.mdx

* Update content/200-orm/500-reference/200-prisma-cli-reference.mdx

* Update content/200-orm/500-reference/200-prisma-cli-reference.mdx

Co-authored-by: Jon Harrell <[email protected]>

* Update content/200-orm/500-reference/200-prisma-cli-reference.mdx

Co-authored-by: Jon Harrell <[email protected]>

---------

Co-authored-by: Jan Piotrowski <[email protected]>
Co-authored-by: Jon Harrell <[email protected]>
  • Loading branch information
3 people authored Jan 23, 2024
1 parent 1cb40c3 commit 01a4de3
Show file tree
Hide file tree
Showing 147 changed files with 42 additions and 2,709 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,7 @@ datasource db {

The block above uses a PgBouncer connection string as the primary URL using `url`, allowing Prisma Client to take advantage of the PgBouncer connection pooler.

It also provides a connection string directly to the database, without PgBouncer, using the `directUrl` field. This connection string will be used when [commands that require a single connection](/platform/classic-projects/data-proxy/prisma-cli-with-data-proxy#prisma-cli-commands-that-require-a-direct-database-connection) to the database, such as `prisma migrate dev` or `prisma db push`, are invoked.
It also provides a connection string directly to the database, without PgBouncer, using the `directUrl` field. This connection string will be used when commands that require a single connection to the database, such as `prisma migrate dev` or `prisma db push`, are invoked.

### PgBouncer with different database providers

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -298,7 +298,7 @@ datasource db {

## External connection poolers

Connection poolers like the Data Proxy and PgBouncer prevent your application from exhausting the database's connection limit.
Connection poolers like [Prisma Accelerate](/accelerate) and PgBouncer prevent your application from exhausting the database's connection limit.

If you would like to use the Prisma CLI in order to perform other actions on your database ,e.g. migrations and introspection, you will need to add an environment variable that provides a direct connection to your database in the `datasource.directUrl` property in your Prisma schema:

Expand All @@ -322,9 +322,9 @@ datasource db {

More information about the `directUrl` field can be found [here](/orm/reference/prisma-schema-reference#fields).

### Data Proxy
### Prisma Accelerate

The [Data Proxy](/platform/classic-projects/data-proxy) is a managed external connection pooler built by Prisma that is integrated in the [Prisma Data Platform](/platform) and handles connection pooling for you.
[Prisma Accelerate](/accelerate) is a managed external connection pooler built by Prisma that is integrated in the [Prisma Data Platform](/platform) and handles connection pooling for you.

### PgBouncer

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -200,11 +200,7 @@ Sometimes you need more control over what queries execute within a transaction.

<Admonition type="info">

Interactive transactions are available in the following versions of Prisma:

- Interactive transactions are generally available from version 4.7.0.
- In version 4.6, Data Proxy support for interactive transactions was available in preview.
- From version 2.29.0 to version 4.5, interactive transactions were available in preview, but did not support the [Data Proxy](/platform/classic-projects/data-proxy).
Interactive transactions have been generally available from version 4.7.0.

If you use interactive transactions in preview from version 2.29.0 to 4.6.1 (included), you need to add the `interactiveTransactions` preview feature to the generator block of your Prisma schema.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ generator client {

### Connection pooling

Generally, when you use a FaaS (Function as a Service) environment to interact with a database, every function invocation can result in a new connection to the database. This is not a problem with a constantly running Node.js server. Therefore, it is beneficial to pool DB connections to get better performance. To solve this issue, you can use the [Data Proxy](/platform/classic-projects/data-proxy). For other solutions, see the [connection management guide for serverless environments](/orm/prisma-client/setup-and-configuration/databases-connections#serverless-environments-faas).
Generally, when you use a FaaS (Function as a Service) environment to interact with a database, every function invocation can result in a new connection to the database. This is not a problem with a constantly running Node.js server. Therefore, it is beneficial to pool DB connections to get better performance. To solve this issue, you can use the [Prisma Accelerate](/accelerate). For other solutions, see the [connection management guide for serverless environments](/orm/prisma-client/setup-and-configuration/databases-connections#serverless-environments-faas).

## Summary

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -232,14 +232,6 @@ To set up a GitHub repository:
git push -u origin main
```

<Admonition>

**Note**<br /><br />

Optionally, you can now also [link your GitHub repository to your project](/platform/classic-projects/platform/environments/create#projects-with-an-introspected-schema-or-with-no-schema) in the Prisma Data Platform so that you can keep it up-to-date with any changes you make in the `schema.prisma` file.

</Admonition>

## 9. Deploy to Deno Deploy

Use the GitHub repository to add your application to Deno Deploy:
Expand Down
16 changes: 8 additions & 8 deletions content/200-orm/500-reference/100-prisma-schema-reference.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -15,14 +15,14 @@ Defines a [data source](/orm/prisma-schema/overview/data-sources) in the Prisma

A `datasource` block accepts the following fields:

| Name | Required | Type | Description |
| ------------------- | -------- | ------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `provider` | **Yes** | String (`postgresql`, `mysql`, `sqlite`, `sqlserver`, `mongodb`, `cockroachdb`) | Describes which data source connectors to use. |
| `url` | **Yes** | String (URL) | Connection URL including authentication info. Most connectors use [the syntax provided by the database](/orm/reference/connection-urls#format). |
| `shadowDatabaseUrl` | No | String (URL) | Connection URL to the shadow database used by Prisma Migrate. Allows you to use a cloud-hosted database as the shadow database. |
| `directUrl` | No | String (URL) | Connection URL for [direct connection to the database](/platform/classic-projects/data-proxy/prisma-cli-with-data-proxy#set-a-direct-database-connection-url-in-your-prisma-schema).<br /><br />If you use a connection pooler URL in the `url` argument (for example, if you use the Data Proxy or pgBouncer), Prisma CLI commands [that require a direct connection to the database](/platform/classic-projects/data-proxy/prisma-cli-with-data-proxy#prisma-cli-commands-that-require-a-direct-database-connection) use the URL in the `directUrl` argument. <br/> <br/> The `directUrl` property is supported by Prisma Studio from version 5.1.0 upwards. |
| `relationMode` | No | String (`foreignKeys`, `prisma`) | Sets whether [referential integrity](/orm/prisma-schema/data-model/relations/relation-mode) is enforced by foreign keys in the database or emulated in the Prisma Client.<br /><br />In preview in versions 3.1.1 and later. The field is named `relationMode` in versions 4.5.0 and later, and was previously named `referentialIntegrity`. |
| `extensions` | No | List of strings (PostgreSQL extension names) | Allows you to [represent PostgreSQL extensions in your schema](/orm/prisma-schema/postgresql-extensions#how-to-represent-postgresql-extensions-in-your-prisma-schema). Available in preview for PostgreSQL only in Prisma versions 4.5.0 and later. |
| Name | Required | Type | Description |
| ------------------- | -------- | ------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `provider` | **Yes** | String (`postgresql`, `mysql`, `sqlite`, `sqlserver`, `mongodb`, `cockroachdb`) | Describes which data source connectors to use. |
| `url` | **Yes** | String (URL) | Connection URL including authentication info. Most connectors use [the syntax provided by the database](/orm/reference/connection-urls#format). |
| `shadowDatabaseUrl` | No | String (URL) | Connection URL to the shadow database used by Prisma Migrate. Allows you to use a cloud-hosted database as the shadow database. |
| `directUrl` | No | String (URL) | Connection URL for direct connection to the database.<br /><br />If you use a connection pooler URL in the `url` argument (for example, if you use [Prisma Accelerate](/accelerate) or pgBouncer), Prisma CLI commands that require a direct connection to the database use the URL in the `directUrl` argument. <br/> <br/> The `directUrl` property is supported by Prisma Studio from version 5.1.0 upwards. |
| `relationMode` | No | String (`foreignKeys`, `prisma`) | Sets whether [referential integrity](/orm/prisma-schema/data-model/relations/relation-mode) is enforced by foreign keys in the database or emulated in the Prisma Client.<br /><br />In preview in versions 3.1.1 and later. The field is named `relationMode` in versions 4.5.0 and later, and was previously named `referentialIntegrity`. |
| `extensions` | No | List of strings (PostgreSQL extension names) | Allows you to [represent PostgreSQL extensions in your schema](/orm/prisma-schema/postgresql-extensions#how-to-represent-postgresql-extensions-in-your-prisma-schema). Available in preview for PostgreSQL only in Prisma versions 4.5.0 and later. |

The following providers are available:

Expand Down
14 changes: 7 additions & 7 deletions content/200-orm/500-reference/200-prisma-cli-reference.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -334,18 +334,18 @@ generator client {

#### Options

| Option | Required | Description | Default |
| -------------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------- |
| `--data-proxy` | No | The `generate` command will generate Prisma Client for use with the [Data Proxy](/platform/classic-projects/data-proxy). Mutually exclusive with `--accelerate` and `--no-engine`. |
| `--accelerate` | No | The `generate` command will generate Prisma Client for use with [Accelerate](/accelerate). Mutually exclusive with `--data-proxy` and `--no-engine`. Available in Prisma 5.1.0 and later. |
| `--no-engine` | No | The `generate` command will generate Prisma Client without an accompanied engine for use with [Data Proxy](/platform/classic-projects/data-proxy) or [Accelerate](/accelerate). Mutually exclusive with `--data-proxy` and `--accelerate`. Available in Prisma 5.2.0 and later. |
| `--watch` | No | The `generate` command will continue to watch the `schema.prisma` file and re-generate Prisma Client on file changes. |
| Option | Required | Description | Default |
| -------------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------- |
| `--data-proxy` | No | The `generate` command will generate Prisma Client for use with [Prisma Accelerate](/accelerate) prior to Prisma 5.0.0. Mutually exclusive with `--accelerate` and `--no-engine`.
| `--accelerate` | No | The `generate` command will generate Prisma Client for use with [Prisma Accelerate](/accelerate). Mutually exclusive with `--data-proxy` and `--no-engine`. Available in Prisma 5.1.0 and later. |
| `--no-engine` | No | The `generate` command will generate Prisma Client without an accompanied engine for use with [Prisma Accelerate](/accelerate). Mutually exclusive with `--data-proxy` and `--accelerate`. Available in Prisma 5.2.0 and later. |
| `--watch` | No | The `generate` command will continue to watch the `schema.prisma` file and re-generate Prisma Client on file changes. |

<Admonition type="warning">

**Deprecation Warning**

As of Prisma 5.2.0, `--data-proxy` and `--accelerate` are deprecated in favor of `--no-engine` as Prisma Client no longer requires an option to work with Accelerate or Data Proxy. All options are available and work similarly, but we recommend `--no-engine` as it prevents an engine from being downloaded which will greatly impact the size of apps deployed to serverless and edge functions.
As of Prisma 5.2.0, `--data-proxy` and `--accelerate` are deprecated in favor of `--no-engine` as Prisma Client no longer requires an option to work with Prisma Accelerate. All options are available and work similarly, but we recommend `--no-engine` as it prevents an engine from being downloaded which will greatly impact the size of apps deployed to serverless and edge functions.

</Admonition>

Expand Down
Loading

1 comment on commit 01a4de3

@vercel
Copy link

@vercel vercel bot commented on 01a4de3 Jan 23, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Successfully deployed to the following URLs:

docs – ./

docs-prisma.vercel.app
prisma2-docs.vercel.app
docs-git-main-prisma.vercel.app

Please sign in to comment.