Skip to content

Commit

Permalink
upgrade docs to v6 (#6445)
Browse files Browse the repository at this point in the history
* continue upgrade docs

* continue upgrade docs

* update docs about Buffer type

* add docs about leaky .env logic

* fix links

* fix links

* docs for NotFoundError

* add fts docs

* Update content/200-orm/800-more/300-upgrade-guides/200-upgrading-versions/500-upgrading-to-prisma-6.mdx

Co-authored-by: Alexey Orlenko <[email protected]>

* fix broken links

* removed tacing

* add bun instructions

* add section about m-n relation changes

* revert tracing ga

* add context about schema change

* refine info about schema change

* refine prerequisites

* clarify version requirements for Node.js

* clarify version requirements for Node.js

* fix meta description

* drop leaky .env logic from upgrade guide

* add note about forbidden words

* Update content/200-orm/800-more/100-under-the-hood/100-engines.mdx

Co-authored-by: Alexey Orlenko <[email protected]>

* Update content/200-orm/800-more/300-upgrade-guides/200-upgrading-versions/500-upgrading-to-prisma-6.mdx

Co-authored-by: Alberto Schiabel <[email protected]>

* Update content/200-orm/800-more/300-upgrade-guides/200-upgrading-versions/500-upgrading-to-prisma-6.mdx

Co-authored-by: Alberto Schiabel <[email protected]>

* Update content/200-orm/800-more/100-under-the-hood/100-engines.mdx

Co-authored-by: Alexey Orlenko <[email protected]>

* Update content/200-orm/800-more/300-upgrade-guides/200-upgrading-versions/500-upgrading-to-prisma-6.mdx

Co-authored-by: Alberto Schiabel <[email protected]>

* Update content/200-orm/800-more/100-under-the-hood/100-engines.mdx

* fix code blocks

---------

Co-authored-by: Alexey Orlenko <[email protected]>
Co-authored-by: Alberto Schiabel <[email protected]>
  • Loading branch information
3 people authored Nov 28, 2024
1 parent c050161 commit bcc4519
Show file tree
Hide file tree
Showing 42 changed files with 706 additions and 389 deletions.
4 changes: 2 additions & 2 deletions content/100-getting-started/01-quickstart-prismaPostgres.mdx
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: 'Quickstart'
metaTitle: 'Quickstart with TypeScript & Prisma Postgres'
metaDescription: 'Get started with Prisma ORM in 5 minutes. You will learn how to send queries to a SQLite database in a plain TypeScript script using Prisma Client.'
metaDescription: 'Get started with Prisma ORM in 5 minutes. You will learn how to run migrations, send queries and receive real-time updates with a Prisma Postgres database.'
search: true
sidebar_class_name: hidden-sidebar
dbSwitcher: ['sqlite', 'prismaPostgres']
Expand All @@ -20,7 +20,7 @@ In this Quickstart guide, you'll learn how to get started from scratch with Pris

To successfully complete this tutorial, you need:
- a [Prisma Data Platform](https://console.prisma.io/) (PDP) account
- Node.js v16.13.0 or higher (learn more about [system requirements](/orm/reference/system-requirements))
- [Node.js](https://nodejs.org/en/) installed on your machine (see [system requirements](/orm/reference/system-requirements) for officially supported versions)

## 1. Set up a Prisma Postgres database in the Platform Console

Expand Down
2 changes: 1 addition & 1 deletion content/100-getting-started/01-quickstart-sqlite.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ If you want to use Prisma ORM with your own PostgreSQL, MySQL, MongoDB or any ot

## Prerequisites

You need Node.js v16.13.0 or higher for this guide (learn more about [system requirements](/orm/reference/system-requirements)).
You need [Node.js](https://nodejs.org/en/) installed on your machine (see [system requirements](/orm/reference/system-requirements) for officially supported versions).

## 1. Create TypeScript project and set up Prisma ORM

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ Learn how to create a new Node.js or TypeScript project from scratch by connecti

In order to successfully complete this guide, you need:

- [Node.js](https://nodejs.org/en/) installed on your machine
- [Node.js](https://nodejs.org/en/) installed on your machine (see [system requirements](/orm/reference/system-requirements) for officially supported versions)
- a [CockroachDB](https://www.cockroachlabs.com/) database server running

> See [System requirements](/orm/reference/system-requirements) for exact version requirements.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ Learn how to create a new Node.js or TypeScript project from scratch by connecti

In order to successfully complete this guide, you need:

- [Node.js](https://nodejs.org/en/) installed on your machine
- [Node.js](https://nodejs.org/en/) installed on your machine (see [system requirements](/orm/reference/system-requirements) for officially supported versions)
- a [MySQL](https://www.mysql.com/) database server running

> See [System requirements](/orm/reference/system-requirements) for exact version requirements.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ Learn how to create a new Node.js or TypeScript project from scratch by connecti

In order to successfully complete this guide, you need:

- [Node.js](https://nodejs.org/en/) installed on your machine
- [Node.js](https://nodejs.org/en/) installed on your machine (see [system requirements](/orm/reference/system-requirements) for officially supported versions)
- a [PlanetScale](https://planetscale.com/) database server running

<Admonition type="warning">
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ Learn how to create a new Node.js or TypeScript project from scratch by connecti

In order to successfully complete this guide, you need:

- [Node.js](https://nodejs.org/en/) installed on your machine
- [Node.js](https://nodejs.org/en/) installed on your machine (see [system requirements](/orm/reference/system-requirements) for officially supported versions)
- a [PostgreSQL](https://www.postgresql.org/) database server running

> See [System requirements](/orm/reference/system-requirements) for exact version requirements.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ Learn how to create a new Node.js or TypeScript project from scratch by connecti

In order to successfully complete this guide, you need:

- [Node.js](https://nodejs.org/en/) installed on your machine
- [Node.js](https://nodejs.org/en/) installed on your machine (see [system requirements](/orm/reference/system-requirements) for officially supported versions)
- A [Microsoft SQL Server](https://learn.microsoft.com/en-us/sql/?view=sql-server-ver16) database
- [Microsoft SQL Server on Linux for Docker](/orm/overview/databases/sql-server/sql-server-docker)
- [Microsoft SQL Server on Windows (local)](/orm/overview/databases/sql-server/sql-server-local)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ Learn how to create a new Node.js or TypeScript project from scratch by connecti

In order to successfully complete this guide, you need:

- [Node.js](https://nodejs.org/en/) installed on your machine
- [Node.js](https://nodejs.org/en/) installed on your machine (see [system requirements](/orm/reference/system-requirements) for officially supported versions)
- a [CockroachDB](https://www.cockroachlabs.com/) database server running

> See [System requirements](/orm/reference/system-requirements) for exact version requirements.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ Learn how to create a new Node.js or TypeScript project from scratch by connecti

In order to successfully complete this guide, you need:

- [Node.js](https://nodejs.org/en/) installed on your machine
- [Node.js](https://nodejs.org/en/) installed on your machine (see [system requirements](/orm/reference/system-requirements) for officially supported versions)
- a [MySQL](https://www.mysql.com/) database server running

> See [System requirements](/orm/reference/system-requirements) for exact version requirements.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ Learn how to create a new Node.js or TypeScript project from scratch by connecti

In order to successfully complete this guide, you need:

- [Node.js](https://nodejs.org/en/) installed on your machine
- [Node.js](https://nodejs.org/en/) installed on your machine (see [system requirements](/orm/reference/system-requirements) for officially supported versions)
- a [PlanetScale](https://planetscale.com/) database server running

<Admonition type="warning">
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ Learn how to create a new Node.js or TypeScript project from scratch by connecti

In order to successfully complete this guide, you need:

- [Node.js](https://nodejs.org/en/) installed on your machine
- [Node.js](https://nodejs.org/en/) installed on your machine (see [system requirements](/orm/reference/system-requirements) for officially supported versions)
- a [PostgreSQL](https://www.postgresql.org/) database server running

> See [System requirements](/orm/reference/system-requirements) for exact version requirements.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -23,9 +23,7 @@ Learn how to create a new TypeScript project with a Prisma Postgres database fro

To successfully complete this tutorial, you need:
- a [Prisma Data Platform](https://console.prisma.io/) (PDP) account
- Node.js v16.13.0 or higher (learn more about [system requirements](/orm/reference/system-requirements))

> See [System requirements](/orm/reference/system-requirements) for exact version requirements.
- [Node.js](https://nodejs.org/en/) installed on your machine (see [system requirements](/orm/reference/system-requirements) for officially supported versions) (see [system requirements](/orm/reference/system-requirements) for officially supported versions)

## Create project setup

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ Learn how to create a new Node.js or TypeScript project from scratch by connecti

In order to successfully complete this guide, you need:

- [Node.js](https://nodejs.org/en/) installed on your machine
- [Node.js](https://nodejs.org/en/) installed on your machine (see [system requirements](/orm/reference/system-requirements) for officially supported versions)
- A [Microsoft SQL Server](https://learn.microsoft.com/en-us/sql/?view=sql-server-ver16) database
- [Microsoft SQL Server on Linux for Docker](/orm/overview/databases/sql-server/sql-server-docker)
- [Microsoft SQL Server on Windows (local)](/orm/overview/databases/sql-server/sql-server-local)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ Learn how to create a new Node.js or TypeScript project from scratch by connecti

In order to successfully complete this guide, you need:

- [Node.js](https://nodejs.org/en/) installed on your machine
- [Node.js](https://nodejs.org/en/) installed on your machine (see [system requirements](/orm/reference/system-requirements) for officially supported versions)
- Access to a MongoDB 4.2+ server with a replica set deployment. We recommend using [MongoDB Atlas](https://www.mongodb.com/cloud/atlas).

<Admonition type="warning">
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ Learn how to create a new Node.js or TypeScript project from scratch by connecti

In order to successfully complete this guide, you need:

- [Node.js](https://nodejs.org/en/) installed on your machine
- [Node.js](https://nodejs.org/en/) installed on your machine (see [system requirements](/orm/reference/system-requirements) for officially supported versions)
- Access to a MongoDB 4.2+ server with a replica set deployment. We recommend using [MongoDB Atlas](https://www.mongodb.com/cloud/atlas).

<Admonition type="warning">
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ If you're migrating to Prisma ORM from another ORM, see our [Migrate from TypeOR
In order to successfully complete this guide, you need:

- an existing Node.js project with a `package.json`
- [Node.js](https://nodejs.org/en/) installed on your machine
- [Node.js](https://nodejs.org/en/) installed on your machine (see [system requirements](/orm/reference/system-requirements) for officially supported versions)
- a [CockroachDB](https://www.cockroachlabs.com) database server running and a database with at least one table

> See [System requirements](/orm/reference/system-requirements) for exact version requirements.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ If you're migrating to Prisma ORM from another ORM, see our [Migrate from TypeOR
In order to successfully complete this guide, you need:

- an existing Node.js project with a `package.json`
- [Node.js](https://nodejs.org/en/) installed on your machine
- [Node.js](https://nodejs.org/en/) installed on your machine (see [system requirements](/orm/reference/system-requirements) for officially supported versions)
- a [MySQL](https://www.mysql.com/) database server running and a database with at least one table


Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ If you're migrating to Prisma ORM from another ORM, see our [Migrate from TypeOR
In order to successfully complete this guide, you need:

- an existing Node.js project with a `package.json`
- [Node.js](https://nodejs.org/en/) installed on your machine
- [Node.js](https://nodejs.org/en/) installed on your machine (see [system requirements](/orm/reference/system-requirements) for officially supported versions)
- a [PlanetScale](https://planetscale.com/) database server running and a database with at least one table

> See [System requirements](/orm/reference/system-requirements) for exact version requirements.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ If you're migrating to Prisma ORM from another ORM, see our [Migrate from TypeOR
In order to successfully complete this guide, you need:

- an existing Node.js project with a `package.json`
- [Node.js](https://nodejs.org/en/) installed on your machine
- [Node.js](https://nodejs.org/en/) installed on your machine (see [system requirements](/orm/reference/system-requirements) for officially supported versions)
- a [PostgreSQL](https://www.postgresql.org/) database server running and a database with at least one table

> See [System requirements](/orm/reference/system-requirements) for exact version requirements.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ If you're migrating to Prisma ORM from another ORM, see our [Migrate from TypeOR

In order to successfully complete this guide, you need:

- [Node.js](https://nodejs.org/en/) installed on your machine
- [Node.js](https://nodejs.org/en/) installed on your machine (see [system requirements](/orm/reference/system-requirements) for officially supported versions)
- A [Microsoft SQL Server](https://learn.microsoft.com/en-us/sql/?view=sql-server-ver16) database
- [Microsoft SQL Server on Linux for Docker](/orm/overview/databases/sql-server/sql-server-docker)
- [Microsoft SQL Server on Windows (local)](/orm/overview/databases/sql-server/sql-server-local)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ If you're migrating to Prisma ORM from another ORM, see our [Migrate from TypeOR
In order to successfully complete this guide, you need:

- an existing Node.js project with a `package.json`
- [Node.js](https://nodejs.org/en/) installed on your machine
- [Node.js](https://nodejs.org/en/) installed on your machine (see [system requirements](/orm/reference/system-requirements) for officially supported versions)
- a [CockroachDB](https://www.cockroachlabs.com) database server running and a database with at least one table

> See [System requirements](/orm/reference/system-requirements) for exact version requirements.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ If you're migrating to Prisma ORM from another ORM, see our [Migrate from TypeOR
In order to successfully complete this guide, you need:

- an existing Node.js project with a `package.json`
- [Node.js](https://nodejs.org/en/) installed on your machine
- [Node.js](https://nodejs.org/en/) installed on your machine (see [system requirements](/orm/reference/system-requirements) for officially supported versions)
- a [MySQL](https://www.mysql.com/) database server running and a database with at least one table

> See [System requirements](/orm/reference/system-requirements) for exact version requirements.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ If you're migrating to Prisma ORM from another ORM, see our [Migrate from TypeOR
In order to successfully complete this guide, you need:

- an existing Node.js project with a `package.json`
- [Node.js](https://nodejs.org/en/) installed on your machine
- [Node.js](https://nodejs.org/en/) installed on your machine (see [system requirements](/orm/reference/system-requirements) for officially supported versions)
- a [PlanetScale](https://planetscale.com/) database server running and a database with at least one table

> See [System requirements](/orm/reference/system-requirements) for exact version requirements.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ If you're migrating to Prisma ORM from another ORM, see our [Migrate from TypeOR
In order to successfully complete this guide, you need:

- an existing Node.js project with a `package.json`
- [Node.js](https://nodejs.org/en/) installed on your machine
- [Node.js](https://nodejs.org/en/) installed on your machine (see [system requirements](/orm/reference/system-requirements) for officially supported versions)
- a [PostgreSQL](https://www.postgresql.org/) database server running and a database with at least one table

> See [System requirements](/orm/reference/system-requirements) for exact version requirements.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ If you're migrating to Prisma ORM from another ORM, see our [Migrate from TypeOR

In order to successfully complete this guide, you need:

- [Node.js](https://nodejs.org/en/) installed on your machine
- [Node.js](https://nodejs.org/en/) installed on your machine (see [system requirements](/orm/reference/system-requirements) for officially supported versions)
- A [Microsoft SQL Server](https://learn.microsoft.com/en-us/sql/?view=sql-server-ver16) database
- [Microsoft SQL Server on Linux for Docker](/orm/overview/databases/sql-server/sql-server-docker)
- [Microsoft SQL Server on Windows (local)](/orm/overview/databases/sql-server/sql-server-local)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ If you're migrating to Prisma ORM from Mongoose, see our [Migrate from Mongoose

In order to successfully complete this guide, you need:

- [Node.js](https://nodejs.org/en/) installed on your machine
- [Node.js](https://nodejs.org/en/) installed on your machine (see [system requirements](/orm/reference/system-requirements) for officially supported versions)
- Access to a MongoDB 4.2+ server with a replica set deployment. We recommend using [MongoDB Atlas](https://www.mongodb.com/cloud/atlas).

<Admonition type="warning">
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ If you're migrating to Prisma ORM from Mongoose, see our [Migrate from Mongoose

In order to successfully complete this guide, you need:

- [Node.js](https://nodejs.org/en/) installed on your machine
- [Node.js](https://nodejs.org/en/) installed on your machine (see [system requirements](/orm/reference/system-requirements) for officially supported versions)
- Access to a MongoDB 4.2+ server with a replica set deployment. We recommend using [MongoDB Atlas](https://www.mongodb.com/cloud/atlas).

<Admonition type="warning">
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -390,12 +390,12 @@ In [3.5.0+](https://github.com/prisma/prisma/releases/3.5.0) for PostgreSQL and

This feature is further explain in [the PostgreSQL documentation](https://www.postgresql.org/docs/12/textsearch-controls.html) and [the MySQL documentation](https://dev.mysql.com/doc/refman/8.0/en/fulltext-search.html).

Enable order by relevance with the `fullTextSearch` [preview feature](/orm/prisma-client/queries/full-text-search):
**For PostgreSQL**, you need to enable order by relevance with the `fullTextSearchPostgres` [preview feature](/orm/prisma-client/queries/full-text-search):

```prisma
generator client {
provider = "prisma-client-js"
previewFeatures = ["fullTextSearch"]
previewFeatures = ["fullTextSearchPostgres"]
}
```

Expand Down
Loading

0 comments on commit bcc4519

Please sign in to comment.