Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

upgrade docs to v6 #6445

Merged
merged 31 commits into from
Nov 28, 2024
Merged
Show file tree
Hide file tree
Changes from 29 commits
Commits
Show all changes
31 commits
Select commit Hold shift + click to select a range
1bbcf0d
continue upgrade docs
nikolasburk Nov 20, 2024
39e083f
continue upgrade docs
nikolasburk Nov 20, 2024
30607a5
update docs about Buffer type
nikolasburk Nov 20, 2024
4b8e504
add docs about leaky .env logic
nikolasburk Nov 20, 2024
75836ca
fix links
nikolasburk Nov 20, 2024
6dba5c1
fix links
nikolasburk Nov 20, 2024
0977f2d
docs for NotFoundError
nikolasburk Nov 21, 2024
306e594
add fts docs
nikolasburk Nov 21, 2024
b825de5
Update content/200-orm/800-more/300-upgrade-guides/200-upgrading-vers…
nikolasburk Nov 25, 2024
3657462
fix broken links
nikolasburk Nov 26, 2024
5354081
removed tacing
nikolasburk Nov 26, 2024
55aa3c8
Merge branch 'docs/v6' of github.com:prisma/docs into docs/v6
nikolasburk Nov 26, 2024
4b3ed31
add bun instructions
nikolasburk Nov 26, 2024
081cb18
add section about m-n relation changes
nikolasburk Nov 26, 2024
4f4cc21
revert tracing ga
nikolasburk Nov 27, 2024
5c976a8
add context about schema change
nikolasburk Nov 28, 2024
ca7e62b
Merge branch 'main' into docs/v6
nikolasburk Nov 28, 2024
111ad08
refine info about schema change
nikolasburk Nov 28, 2024
1b9e2fe
refine prerequisites
nikolasburk Nov 28, 2024
d78cc9c
clarify version requirements for Node.js
nikolasburk Nov 28, 2024
e13dde5
clarify version requirements for Node.js
nikolasburk Nov 28, 2024
820489b
fix meta description
nikolasburk Nov 28, 2024
9b707b1
drop leaky .env logic from upgrade guide
nikolasburk Nov 28, 2024
bcd4693
add note about forbidden words
nikolasburk Nov 28, 2024
ad739e0
Update content/200-orm/800-more/100-under-the-hood/100-engines.mdx
nikolasburk Nov 28, 2024
7e6f774
Update content/200-orm/800-more/300-upgrade-guides/200-upgrading-vers…
nikolasburk Nov 28, 2024
64a5cb3
Update content/200-orm/800-more/300-upgrade-guides/200-upgrading-vers…
nikolasburk Nov 28, 2024
0771a0d
Update content/200-orm/800-more/100-under-the-hood/100-engines.mdx
nikolasburk Nov 28, 2024
eb68d59
Update content/200-orm/800-more/300-upgrade-guides/200-upgrading-vers…
nikolasburk Nov 28, 2024
60e4d90
Update content/200-orm/800-more/100-under-the-hood/100-engines.mdx
aqrln Nov 28, 2024
e4b8c56
fix code blocks
nikolasburk Nov 28, 2024
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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
Loading