LICENSE Documentation

1. Project Overview & Quickstart (lukevella/LICENSE) Copy Chapter

LICENSE

Open-source repository lukevella/LICENSE

Repository Details Copy Section

• Repository: lukevella/LICENSE
• Primary Language: Code

Note: High-volume repository documentation is actively indexed and synchronized by YakaAI.

2. Official Technical Reference & Guides (lukevella/docs) Copy Chapter

File: README.md Copy Chapter

Prisma Documentation

[

This repository contains the source code and the content for the Prisma documentation.

Contributing to the docs Copy Chapter

Read through the contributing guide to learn how you can contribute to the Prisma documentation.

Run locally Copy Chapter

Clone this repository and get started by running the following commands:

npm install
npm run dev

Run functions locally Copy Chapter

Run a local build to run the functions using the following command:

netlify dev

Make sure you have the correct path to POSTGRES_URL in your local .env file to test the functions

To prettify or format the code, run:

npm run prettify

Visit http://localhost:8000/ to view the app.

Configure Copy Chapter

Write MDX files in content folder.

Open config.js for available config options for gatsby, header, footer and siteMetadata.

• gatsby config for global configuration like

  • pathPrefix - Gatsby Path Prefix

• header config for site header configuration like

  • title - The title that appears on the top left
  • links - The links for header
  • logoLink - The link to redirect on logo click

• footer config for site footer configuration like

  • title - The title that appears on the top left
  • logoLink - The link to redirect on logo click
  • products, community, company, resources - The links for various footer
  • newsletter - Newsletter config
  • findus - Social links

• siteMetadata config for website related configuration

  • title - Title of the website in main page
  • description - Description of the website
  • keywords - Keywords of the website for SEO

Inserting, moving and deleting files Copy Chapter

All files/folders in the context are prefixed with a position which indicates the order in which they appear in the sidenav on the docs website. This makes it cumbersome to insert, move and delete files because the positions of a number of other files (if not all) in the same folder might need to be adjusted. Thanks to Luca Steeb, you can perform these operations with a dedicated CLI called mdtool.

Install Copy Section

wget https://gist.githubusercontent.com/steebchen/bd085ebde1fcf4242e3fdd0df4d202a6/raw/c04e3d262eb6a302a9fab98f6428fec9329681e2/mdtool -qO /usr/local/bin/mdtool
chmod +x /usr/local/bin/mdtool

Usage Copy Section

Overview

mdtool insert 3
mdtool swap A B
mdtool move A B
mdtool remove 4

`mdtool insert`

Make place for a new file at given index and increment all numbers by one after that index:

$ mdtool insert INDEX

# e.g.:
$ mdtool insert 2

# Result: for files 01-a, 02-b, 03-c, and 04-d; 03-c is renamed to 04-c and 04-d is renamed to 05-d so you can create a new file at index 2

`mdtool swap`

Swap two files; specify both filenames (prefix numbers get automatically adjusted):

$ mdtool swap FILENAME1 FILENAME2

# e.g.:
$ mdtool swap 03-file1.mdx 07-file2.mdx

# Result: Files are now named: 03-file2.mdx 07-file1.mdx

`mdtool move`

Move a given file to another given index

$ mdtool move FILENAME INDEX

# e.g.:
$ mdtool move 05-file.mdx 2

# Result: 05-file.mdx is move to 02-file.mdx, plus previous files 02-*, 03-*, 04-* are incremented

`mdtool remove`

Shift all other items by -1 at a given index:

$ mdtool remove INDEX

# e.g.:
$ mdtool remove 2

# Result: 01-a, 02-b, 03-c, 04-d becomes 01-a, 02-b, 02-c, 03-d; 02-b is supposed to be manually deleted

Thanks Luca

Contributors ✨ Copy Chapter

Thanks goes to these wonderful people (emoji key):

This project follows the all-contributors specification. Contributions of any kind welcome!

File: content/600-about/200-prisma-docs/20-style-guide/01-mdx-examples.mdx Copy Chapter

title: 'MDX components' metaTitle: 'MDX components in the Prisma docs' metaDescription: 'MDX components components available on the Prisma documentation site.' navTitle: 'MDX components' Copy Chapter

TopBlock Copy Chapter

Required at the top of the page to avoid styling issues:

<TopBlock>

This page describes how to use [MDX](https://mdxjs.com/) components (e.g. code blocks) in the Prisma docs.

</TopBlock>

Code blocks Copy Chapter

Example:

async function main() {
  const allUsers = await prisma.user.findMany()
  console.log(allUsers)
}

Code:

```js
async function main() {
const allUsers = await prisma.user.findMany()
console.log(allUsers)
}
```

Prisma schema Copy Section

Example:

datasource db {
  provider = "sqlite"
  url      = env("DATABASE_URL")
}

generator client {
  provider = "prisma-client-js"
}

model Post {
  id        Int     @id @default(autoincrement())
  title     String
  content   String?
  published Boolean @default(false)
  author    User?   @relation(fields: [authorId], references: [id])
  authorId  Int?
}

model User {
  id    Int     @id @default(autoincrement())
  email String  @unique
  name  String?
  posts Post[]
}

Code:

```prisma
datasource db {
  provider = "sqlite"
  url      = env("DATABASE_URL")
}

generator client {
  provider = "prisma-client-js"
}

model Post {
  id        Int     @id @default(autoincrement())
  title     String
  content   String?
  published Boolean @default(false)
  author    User?   @relation(fields: [authorId], references: [id])
  authorId  Int?
}

model User {
  id    Int     @id @default(autoincrement())
  email String  @unique
  name  String?
  posts Post[]
}
```

Code block with file icon Copy Section

Example:

datasource db {
  provider = "sqlite"
  url      = env("DATABASE_URL")
}

generator client {
  provider = "prisma-client-js"
}

model Post {
  id        Int     @id @default(autoincrement())
  title     String
  content   String?
  published Boolean @default(false)
  author    User?   @relation(fields: [authorId], references: [id])
  authorId  Int?
}

model User {
  id    Int     @id @default(autoincrement())
  email String  @unique
  name  String?
  posts Post[]
}

Code:

```prisma file=schema.prisma
datasource db {
  provider = "sqlite"
  url      = env("DATABASE_URL")
}

generator client {
  provider = "prisma-client-js"
}

model Post {
  id        Int     @id @default(autoincrement())
  title     String
  content   String?
  published Boolean @default(false)
  author    User?   @relation(fields: [authorId], references: [id])
  authorId  Int?
}

model User {
  id    Int     @id @default(autoincrement())
  email String  @unique
  name  String?
  posts Post[]
}
```

Code block with copy Copy Section

Example:

async function main() {
  const allUsers = await prisma.user.findMany()
  console.log(allUsers)
}

Code:

```js copy
async function main() {
  const allUsers = await prisma.user.findMany()
  console.log(allUsers)
}
```

Code block without line numbers Copy Section

Example:

async function main() {
  const allUsers = await prisma.user.findMany()
  console.log(allUsers)
}

Code:

```js no-lines
async function main() {
  const allUsers = await prisma.user.findMany()
  console.log(allUsers)
}
```

Code block with highlighted code Copy Section

Example:

async function main() {
  added code

  deleted code

  edited
  code

  highlights
  over multiple
  lines can be done by using
  a hyphen
}

Code:

```js file=test.ts highlight=2;add|4;delete|6,7;edit|9-12;normal
async function main() {
  added code

  deleted code

  edited
  code

  highlights
  over multiple
  lines can be done by using
  a hyphen
}
```

File icons Copy Chapter

There are 4 icons available:

<FileWithIcon text="file.pdf" icon="file"/>
<FileWithIcon text="dev.db" icon="database"/>
<FileWithIcon text="Windows" icon="display"/>
<FileWithIcon text="schema.ts" icon="code"/>
<FileWithIcon text="prisma.schema" icon="prisma"/>

Tabbed blocks Copy Chapter

Example:

<TabbedContent tabs={[, ]}>

npm run dev

Code:

<TabbedContent tabs={[<FileWithIcon text="schema.ts" icon="file"/>, <FileWithIcon text="dev.db" icon="database"/>]}>

<tab>

| **id** | **email**           | **name**  |
| :----- | :------------------ | :-------- |
| `1`    | `"[email protected]"` | `"Sarah"` |
| `2`    | `"[email protected]"` | `"Maria"` |

</tab>

<tab>

```copy bash-symbol
npm run dev
```

</tab>

</TabbedContent>

Subsections Copy Chapter

Lists all child pages of the current page to the specified depth:

<Subsections depth="3" />

Expand/Collapse section Copy Chapter

Example:

Expand if you want to view more

Here's more!

Expand if you want to view more

Here's more!

Button link Copy Chapter

Example:

Button text

Code:

Button text

Code with output Copy Chapter

Example:

yarn prisma init

$ yarn prisma init
yarn run v1.22.0
warning package.json: No license field
$ /Users/nikolasburk/Desktop/tsdf/node_modules/.bin/prisma init

✔ Your Prisma schema was created at prisma/schema.prisma.
  You can now open it in your favorite editor.

Next steps:
1. Set the DATABASE_URL in the .env file to point to your existing database. If your database has no tables yet, read https://pris.ly/d/getting-started.
2. Set the provider of the datasource block in schema.prisma to match your database: postgresql, mysql or sqlite.
3. Run prisma db pull to turn your database schema into a Prisma data model.
4. Run prisma generate to install Prisma Client. You can then start querying your database.

More information in our documentation:
https://pris.ly/d/getting-started

Code:

<CodeWithResult expanded={true}>

<cmd>

```
yarn prisma init
```

</cmd>

<cmdResult>

```
$ yarn prisma init
yarn run v1.22.0
warning package.json: No license field
$ /Users/nikolasburk/Desktop/tsdf/node_modules/.bin/prisma init

✔ Your Prisma schema was created at prisma/schema.prisma.
  You can now open it in your favorite editor.

Next steps:
1. Set the DATABASE_URL in the .env file to point to your existing database. If your database has no tables yet, read https://pris.ly/d/getting-started.
2. Set the provider of the datasource block in schema.prisma to match your database: postgresql, mysql or sqlite.
3. Run prisma db pull to turn your database schema into a Prisma data model.
4. Run prisma generate to install Prisma Client. You can then start querying your database.

More information in our documentation:
https://pris.ly/d/getting-started
```

</cmdResult>

</CodeWithResult>

Example with custom output text

yarn prisma init

$ yarn prisma init
yarn run v1.22.0
warning package.json: No license field
$ /Users/nikolasburk/Desktop/tsdf/node_modules/.bin/prisma init

✔ Your Prisma schema was created at prisma/schema.prisma.
  You can now open it in your favorite editor.

Next steps:
1. Set the DATABASE_URL in the .env file to point to your existing database. If your database has no tables yet, read https://pris.ly/d/getting-started.
2. Set the provider of the datasource block in schema.prisma to match your database: postgresql, mysql or sqlite.
3. Run prisma db pull to turn your database schema into a Prisma data model.
4. Run prisma generate to install Prisma Client. You can then start querying your database.

More information in our documentation:
https://pris.ly/d/getting-started

Code:

<CodeWithResult outputResultText="some output" expanded={true}>

<cmd>

```
yarn prisma init
```

</cmd>

<cmdResult>

```
$ yarn prisma init
yarn run v1.22.0
warning package.json: No license field
$ /Users/nikolasburk/Desktop/tsdf/node_modules/.bin/prisma init

✔ Your Prisma schema was created at prisma/schema.prisma.
  You can now open it in your favorite editor.

Next steps:
1. Set the DATABASE_URL in the .env file to point to your existing database. If your database has no tables yet, read https://pris.ly/d/getting-started.
2. Set the provider of the datasource block in schema.prisma to match your database: postgresql, mysql or sqlite.
3. Run prisma db pull to turn your database schema into a Prisma data model.
4. Run prisma generate to install Prisma Client. You can then start querying your database.

More information in our documentation:
https://pris.ly/d/getting-started
```

</cmdResult>

</CodeWithResult>

Quiz component Copy Chapter

Example:

<Quiz
question="Can Prisma be used with Node.js?"
answerOptions={[
{
answer: 'It only works with potatoes',
isCorrect: true,
},
{
answer: 'It can be used with any Java backend!',
isCorrect: false,
},
{
answer: 'It can be used with any Node.js or TypeScript backend!',
isCorrect: false,
},
{
answer: 'It can be used with a Python backend!',
isCorrect: false,
},
]}
/>

Code:

<Quiz
  question="Can Prisma be used with Node.js?"
  answerOptions={[
    {
      answer: 'It only works with potatoes',
      isCorrect: true,
    },
    {
      answer: 'It can be used with any Java backend!',
      isCorrect: false,
    },
    {
      answer: 'It can be used with any Node.js or TypeScript backend!',
      isCorrect: false,
    },
    {
      answer: 'It can be used with a Python backend!',
      isCorrect: false,
    },
  ]}
/>

Tip component Copy Chapter

Example:

Code:

<Tip>

  To find out if Prisma is the right fit for your project, head on over to [What is Prisma](/concepts/overview/what-is-prisma) and read all about what makes Prisma, Prisma!

</Tip>

Admonition component Copy Chapter

The Admonition shows a message to the user with different levels of priority.

• info: The message is informational.
• warning: The message is a warning.
• alert: The message is an alert.

Info Example Copy Section

Warning Example Copy Section

Alert Example Copy Section

<Admonition type="info">

This is some information that might be of use to the reader

</Admonition>

<Admonition type="warning">

This is some information we want to warn the user about, maybe they should know this before they start using a feature.

</Admonition>

<Admonition type="alert">

This is some information we want to alert the user to, maybe they should be aware of some **breaking changes**

</Admonition>

File: content/600-about/200-prisma-docs/20-style-guide/02-template.mdx Copy Chapter

title: 'Writing template' metaTitle: 'Writing template (About)' metaDescription: 'A template for writing Prisma Docs.' tocDepth: 2 hidePage: false toc: true Copy Chapter

A section Copy Chapter

Break your page up into sections. Use the tocDepth frontmatter variable to determine how many levels the table of contents should have - 1 or 2.

A subsection Copy Section

If possible, avoid too many deeply nested subsections.

File: content/600-about/200-prisma-docs/20-style-guide/03-frontmatter.mdx Copy Chapter

title: Frontmatter metaDescription: 'Supported frontmatter variables.' Copy Chapter

title Copy Chapter

The <h1> title of the page.

metaTitle Copy Chapter

The <title> of the page - falls back to title (h1)

navTitle Copy Chapter

Allows you to specify a different, usually shorter title for the left-hand navigation.

metaDescription Copy Chapter

The <meta name="description" content="" /> of the page.

staticLink Copy Chapter

Turns the page into a non-linked heading in the left-hand navigation. For example: https://www.prisma.io/docs/concepts/overview

Note: The page still exists, but you can only navigate to it via the breadcrumb.

preview Copy Chapter

Adds a preview label to a page in the left-hand navigation.

toc Copy Chapter

Enable or disable table of contents navigation on the page (defaults to false). For example:

toc: true

tocDepth Copy Chapter

Controls the depth of headings to show in the ToC:

tocDepth: 2

Note: Currently limited to 2 levels - h2 and h3

hidePage Copy Chapter

Hides page from all navigation (still visible through search). For example:

hidePage: true

File: content/600-about/200-prisma-docs/20-style-guide/index.mdx Copy Chapter

title: 'Prisma Docs style guide' metaTitle: 'Prisma documentation style guide' metaDescription: 'The Prisma style guide contains a number of rules and conventions for the content in the Prisma documentation.' tocDepth: 2 Copy Chapter

Word choice Copy Chapter

Use "you" as the pronoun Copy Section

Any content should use the second person ("you") to provide a conversational tone. This way, the text and instructions seem to speak directly to the person reading it. Try to avoid using the first person ("I", "we", "let's", and "us").

Using "you" in English is also more accurate than saying "we because typically only one person is reading the tutorial or guide at a time and the person who wrote the tutorial is not actually going through it with them, so "we" would be inaccurate. You might notice that some technical documentation uses third person pronouns and nouns like "they" and "the user", which add more distance and feel colder than the conversational and warm "you" and "your".

When to use "we"

You can use "we" when specifically referring to Prisma. For example:

"We recommend that you share a single instance of PrismaClient across your application.

Avoid words like "easy" and "just" Copy Section

Avoid using words like "easy", "just" "simple" and "basic" because if users have a hard time completing the task that is supposedly "easy," they will question their abilities. Consider using more specific descriptors; for example, when you say the phrase "deployment is easy," what do you really mean? Is it easy because it takes fewer steps than another option? If so, use the most specific descriptor possible, which in that case would be "this deployment method involves fewer steps than other options."

For even more inclusive docs, avoid phrases that assume a reader’s experience or skill level, like "just deploy it and you’re done" or "for a refresher (referring to a completely different doc that someone may not have read)". Often, rephrasing results in stronger sentences that appeal to a wider range of contexts.

Use inclusive language Copy Section

When you need to refer to one or more people in third-person, be sure to use inclusive, gender-neutral language if the gender of the person is not explicitly known. Use "they/them/their" instead of "he/him/his" or "she/her/her". Avoid words like "guys"

Avoid emojis, slang, and metaphors Copy Section

Avoid using emojis or emotions in the docs and idiomatic expressions / slang, or metaphors. Prisma has a global community, and the cultural meaning of an emoji, emoticon, or slang may be different around the world. Use your best judgment! Also, emojis can render differently on different systems.

Avoid Latin terms Copy Section

For example:

• et al
• etc
• i.e.
• e.g.

Avoid contractions Copy Section

For example:

• You're (use "You are")
• It'll (use "It will")

Define jargon Copy Section

Articles should be written with short, clear sentences, and use as little jargon as necessary.

Jargon: (n.) special words or expressions that are used by a particular profession or group and are difficult for others to understand: legal jargon.

All jargon should be defined immediately in plain English. In other words, pretend like your readers have basic coding experience but not necessarily experience with PWAs and the JAMstack (see what happened there? I just used two jargon words that need to be defined); you need to define words that newcomers might have a hard time understanding.

Referring to other parts of the docs Copy Section

• Page
• Section

Technical word choice Copy Section

Record

Refer to rows in the database as records. For example:

"The following create query creates a single User record."

Do not use:

• Entry
• Row
• Object

Model property

Model property refers to the top-level PrismaClient properties that refer to models:

const result = await prisma.user.findMany(...) // user model property
const result = await prisma.post.findMany(...) // post model property

Writing style Copy Chapter

Write concisely and avoid long blocks of text Copy Section

Concise writing communicates the bare minimum without redundancy. Strive to make your writing as short as possible; this practice will often lead to more accurate and specific writing. To avoid large blocks of text:

• Use shorter paragraphs
• Use lists
• Use examples
• Use bold and emphasis
• Use tables
• Use diagrams

Use active voice Copy Section

Use active voice instead of passive voice. Generally, it’s a more concise and straightforward way to communicate a subject. For example:

• (passive) The for loop in JavaScript is used by programmers to…
• (active) Programmers use the for loop in JavaScript to…

Be assertive Copy Section

Use assertive language.

Good:

• Use the createMany method to create multiple records in a single transaction
• You can use nested writes to create a user and that user's posts at the same time

Avoid:

• This example tries to..
• You might be able to..
• You could use..

Use clear hyperlinks Copy Section

Hyperlinks should contain the clearest words to indicate where the link will lead you.

Read more in the [Prisma docs](https://www.prisma.io/docs/)



Read more in the Prisma docs [here](https://www.prisma.io/docs/)

Be specific when using version numbers Copy Section

When you are writing about a specific version, be sure to specifiy * to what product* you are referring. For example, in the following sentence it might be unclear to users whether version 3.11.1 refers to Prisma or to MongoDB:

This filter is available on MongoDB only in versions 3.11.1 and later.

So instead, insert the product name in front of the version number whenever possible.

This filter is available on MongoDB only in Prisma version 3.11.1 and later.

Indicate when something is optional Copy Section

When a paragraph or sentence offers an optional path, the beginning of the first sentence should indicate that it’s optional. For example, "if you’d like to learn more about xyz, see our reference guide" is clearer than "Go to the reference guide if you’d like to learn more about xyz."

This method allows people who would not like to learn more about xyz to stop reading the sentence as early as possible. This method also allows people who would like to learn more about xyz to recognize the opportunity to learn quicker instead of accidentally skipping over the paragraph.

Abbreviate terms Copy Section

If you want to abbreviate a term in your article, write it out fully first, then put the abbreviation in parentheses. After that, you may use the abbreviation going for the rest of the article. For example, "In computer science, an abstract syntax tree (AST) is …".

Embrace redundancy Copy Section

Meet the user where they are.

Grammar and formatting Copy Chapter

Capitalize and spell out proper nouns Copy Section

Although it can be tempting to use abbreviations like "Postgres" (instead of the official proper noun "PostgreSQL") or not worry about casing when writing "Javascript" (instead of "JavaScript"), we're committed to using the preferred notions of proper nouns. A few common examples are:

• Node.js (instead of Node or Node.JS)
• JavaScript and TypeScript (instead of JavaScript and Typescript or JS and TS)
• PostgreSQL (instead of Postgres or Postgresql)
• MongoDB (instead of Mongo)
• GitHub (instead of Github)
• ...

If you're not sure about the spelling of a certain noun, the official homepage of it typically contains the proper spelling for you to look up.

Titles and headers Copy Section

• Use sentence casing for titles and headings: only the initial word is uppercase
• Use the present participle form of verbs (add -ing - for example: "Configuring the database")
• Do not use punctuation at the end of the phrase unless a question mark is required
• Use code for code in headings - this is required by navigation elements

Use tables, bullet lists and numbered lists Copy Section

Tables and lists are often the most concise way of presenting information. Use the elements whenever they feel appropriate. Here are few guidelines to help decide when to use which:

• Use bullet lists only when the order of the lists doesn't matter (e.g. an enumeration of the features of a database which don't have an inherent order)
• Use numbered lists only when the order of the list matters (e.g. when providing step-by-step instructions where one step builds on the previous)
• Use tables when you're enumerating things that share a number of similar properties/characteristics (e.g. the parameters for an API call which all have a "name", a "type", are required or optional and need a description)

Use italics and bold font Copy Section

Italics and bold fonts can be a great way to emphasize certain parts of your sentence to the reader. Use bold font more sparsely and only when you want this part to stand out from the entire paragraph (so that it's visible when a reader only "scans" the page instead of properly reading it). Use italics for words that introduce new concepts for the first time.

Use inline code format for paths and file names Copy Section

For example:

• "The generated Prisma Client is located in the ./node_modules/.prisma folder by default."
• "The schema.prisma file is located in..."
• "To use multiple .env files..."

Use inline code format when referring to strings in text Copy Section

For example:

"The following query returns all records where the email field is equal to Sarah."

Make lists clear with the Oxford Comma Copy Section

Use the Oxford Comma except in titles. It is a comma used after the penultimate item in a list of three or more items, before "and" or "or" e.g. an Italian painter, sculptor, and architect. It makes things clearer.

Confusion can happen when you don’t use the Oxford comma.

Prefer US English Copy Section

For words that have multiple spellings, prefer the US English word over British or Canadian English. For example:

• "color" over "colour"
• "behavior" over "behaviour"

Writing code snippets Copy Chapter

Introduce all code snippets Copy Section

Write a short introductory sentence that:

• Explains what the code snippet is doing
• Links to reference documentation if applicable

For example:

The following [`createMany`](..) query creates several new `User` records:

The following [`createMany`](..) query:

- Creates several `User` records
- Creates several nested `Post` records
- Creates several nested `Category` records

Show the result of a query wherever possible Copy Section

Use the <CodeWithResult> component to show a query and the results of that query.

Use the `highlight` property to highlight Copy Section

Use the highlight property if you need to highlight your code samples. For example:

```prisma highlight=3;normal
generator client {
  provider        = "prisma-client-js"
  previewFeatures = ["namedConstraints"]
}
```

Use inline code only when referring to "code concepts" Copy Section

TBD

Format code blocks and inline code Copy Section

Use the following as reference when creating and editing docs: formatting inline code and code blocks.

Emphasize placeholders Copy Section

Placeholders are a tricky topic in technical documentation and are one of the most common sources of confusion, especially for beginners. To strive for consistency, placeholders in the Prisma docs are:

• spelled in all-uppercase letters
• prefixed and suffixed with two underscores
• using descriptive terms

As an example, consider the following code block where __DATABASE_CONNECTION_URL__ is a placeholder for the PostgreSQL connection URL:

datasource db {
  provider = "postgresql"
  url      = "__DATABASE_CONNECTION_STRING__"
}

Whenever you're using a placeholder, you should make sure that you directly explain or at least link out to another resource that explains how to obtain a value for the placeholder. You should also explicitly call out that this is a placeholder that needs to get replaced with a "real value" including an example of what that real value might look like:

datasource db {
  provider = "postgresql"
  url      = "postgresql://opnmyfngbknppm:[email protected]:5432/d50rgmkqi2ipus?schema=hello-prisma2"
}

Use prettier code formatting Copy Section

TBD

Use expressive variable names Copy Section

Good:

const getUsers = (...)
const deleteUsers = (...)

Bad:

const results = (...) // Too generic
const foo = (...) // Too vague

Strive for code snippets to be "valid" Copy Section

TBD

Avoid too many inline comments Copy Section

TBD

Lists of shell commands Copy Section

When you need to provide a series of CLI commands as instructions to the reader, don't use a list unless you're providing context for each step:

Bad

• cd path/to/server
• docker-compose up -d --build
• ./node_modules/.bin/sequelize db:migrate or npx sequelize db:migrate
• ./node_modules/.bin/sequelize db:seed:all or npx sequelize db:seed:all

Better

cd path/to/server
docker-compose up -d --build
./node_modules/.bin/sequelize db:migrate # or `npx sequelize db:migrate`
./node_modules/.bin/sequelize db:seed:all # or `npx sequelize db:seed:all`

or

1. Navigate into the project directory: cd path/to/server
2. Start Docker containers: docker-compose up -d --build
3. Migrate your database schema: ./node_modules/.bin/sequelize db:migrate or npx sequelize db:migrate
4. Seed the database: ./node_modules/.bin/sequelize db:seed:all or npx sequelize db:seed:all

Don't prepend CLI commands with `$` Copy Section

Use terminal for CLI commands - this type of code block includes a $:

```terminal
npm install prisma
```

For example:

npm install prisma

npm vs Yarn Copy Section

Always use npm commands instead of yarn.

Spelling Copy Chapter

Hyphens Copy Section

Hyphens are used according to these rules.

Sometimes there are some terms where it's not clear whether to use a hyphen or not. In order to strive for consistency, we list those terms here as a rule for using them throughout the Prisma documentation.

Spell without hyphen

• Use case
• Command line
• Auto format
• Type safety

Spell with hyphen

• Compile-time

Spell as one word

• Autocomplete

Type-safe and type safe

• "The code is type safe."
• "This is type-safe code."

Data source and `datasource`

• The datasource block
• "You must regenerate the client when you introduce a new data source"

Boilerplate Copy Chapter

The following section contains frequently used phrases or blocks of content that you can re-use:

Introducing a preview feature Copy Section

To enable this feature, add `namedConstraints` to `previewFeatures` in your schema:

```prisma highlight=3;normal
generator client {
  provider        = "prisma-client-js"
  previewFeatures = ["namedConstraints"]
}
```

Making recommendations Copy Section

If it is a Prisma recommendation, use:

"We recommend that you share a single instance of PrismaClient across your application."

If it is an industry standard, use:

"It is recommended practice to limit he number of database connections to X."

File: content/600-about/200-prisma-docs/00-whats-new-in-prisma-docs.mdx Copy Chapter

title: What's new in Prisma docs metaTitle: "What's new in Prisma docs" metaDescription: "Find out what's new on the Prisma documentation site, including content and site features." toc: false tocDepth: 2 Copy Chapter

The week of September 13th 2021 Copy Chapter

New Documentation Copy Section

• We have added a new contributing guide to the Prisma docs repo!
  • We have also added the all-contributors specification. This means that if you make a PR and it is merged, you will forever be a contributor and your picture adorned upon the README.
• Updated both unit and integration testing guides with correct package versions to help following the guide.
• Numerous community PRs with important updates to the documentation! We thank you!

The week of August 30th 2021 Copy Chapter

New Documentation Copy Section

• Improvements to the Referential actions docs, with new examples and better error messages explained in Special rules for referential actions in SQL Server
• Numerous community PRs with important updates to the documentation! We thank you!

The week of August 23rd 2021 Copy Chapter

New Documentation Copy Section

• Full text search is now in preview and available to use as a Preview feature!
• Numerous community PRs with important updates to the documentation! We thank you!

The week of August 16th 2021 Copy Chapter

New Documentation Copy Section

• Improvements to the Integration testing guide
• Simplified examples in Cyclic referential actions with Microsoft SQL Server
• Numerous community PRs with important updates to the documentation! We thank you!

The week of August 9th 2021 Copy Chapter

New Documentation Copy Section

• Cyclic referential actions with Microsoft SQL Server
• New section for Development Environment which includes:
  • Environment variables
  • Editor setup
• Enabling Named constraints Preview feature!
  • Including upgrade path guide
• Numerous community PRs with important updates to the documentation! We thank you!

The week of June 28th 2021 Copy Chapter

New Documentation Copy Section

• Referential actions guide. Referential actions introduce potentially breaking changes, be sure to read the whole docs page for a full breakdown.

The week of June 7th 2021 Copy Chapter

New Documentation Copy Section

• Getting started guide has had a refactor!
  • New, even quicker, Quickstart guide
  • Start from scratch guide now split into easy to digest steps
  • Add to existing project guide now split into easy to digest steps
• The term 'whitelist' has been removed from our documentation, and replaced with 'allowlist'
• Lots of community PRs merged this past week! We thank you 🙏

The week of May 31st 2021 Copy Chapter

New documentation Copy Section

• Json field filtering

The week of May 24th 2021 Copy Chapter

New documentation Copy Section

• Note solving @prisma/client did not initialize error on AWS Elastic Beanstalk deployment
• Community generators
• Troubleshooting running CLI commands in non-interactive environments
• Improved integration testing guide courtesy of community feedback
  • Improved section on deleting all records from all tables
• Updated upgrading to the latest version of Prisma
• Prisma will now run seed files that have a default export, or an export named seed

The week of May 10th 2021 Copy Chapter

New documentation 📝 Copy Section

• Supporting features without a Prisma Schema Language equivalent
• Include unsupported database features with Prisma Migrate
• How to enable extensions for native database functions with Prisma Migrate
• Integration testing guide

The week of May 3rd 2021 Copy Chapter

New documentation 📝 Copy Section

• More in-depth explanation of baselining
• Working with Prisma Migrate as part of a development team
• Error codes are now linkable
• Unit testing guide

May 04 2021 Copy Chapter

Release 🚀 Copy Section

• 2.22.0 documentation

  • db push no longer in preview!
  • Multiple provider support no longer supported

New documentation 📝 Copy Section

• The past month we refactored and expanded the deployment and connection management sections.
• In depth explanation about our choice to use the User and Post data models across the docs

April 04 2021 Copy Chapter

• 2.20.0 documentation

  • push for scalar lists (PostgreSQL only)
  • Relation count
  • nApi preview

March 16 2021 Copy Chapter

Prisma Migrate is now Generally Available! 🎉

• 2.19.0 documentation

  • Prisma Migrate overview
  • Developing with Prisma Migrate
  • Schema prototyping with db push
  • Production troubleshooting
  • Patching / hotfixing your database

March 05 2021 Copy Chapter

New documentation:

• Performance and query optimization guide
• Compound ID examples

March 03 2021 Copy Chapter

New documentation:

• 2.18.0 documentation

February 16 2021 Copy Chapter

New documentation:

• 2.17.0 documentation

  • Native type attributes
  • New types: Bytes, Unsupported, Decimal, BigInt
  • Developing with Prisma Migrate in the cloud

Video: What's new in Prisma 2.17.0 Copy Section

February 3 2021 Copy Chapter

New documentation:

• We now have a Prisma Client API reference section! 🎉

• 2.16.0 documentation

  • createMany
  • orderBy relations

Video: What's new in Prisma 2.16.0 Copy Section

January 20 2021 Copy Chapter

New documentation:

• 2.15.0 documentation

  • Native types with Prisma Migrate
  • Prisma Migrate seeding
  • Scalar list/array filtering
  • Improved count API
  • rejectOnNotFound for findUnique and findFirst

January 5 2021 Copy Chapter

New documentation:

• 2.14.0 documentation

  • Group by

• System requirements for Prisma

December 8 2020 Copy Chapter

New documentation:

• 2.13.0 documentation

  • Prisma Migrate

November 24 2020 Copy Chapter

New documentation:

• 2.12.0 documentation

  • Microsoft SQL Server native types preview
  • findUnique → findUnique

November 10 2020 Copy Chapter

New documentation:

• 2.11.0 documentation

  • Extended native types support (preview)

November 5 2020 Copy Chapter

• Documentation site re-design and content re-organization released! 🎉

October 27 2020 Copy Chapter

New documentation:

• 2.10.0 documentation

  • Microsoft SQL Server connector (preview)
  • db push command

October 5 2020 Copy Chapter

New documentation:

• 2.8.0 documentation

  • findFirst

• Advanced middleware examples (soft delete)

September 15 2020 Copy Chapter

New documentation:

• 2.7.0 documentation

  • Where does Prisma look for the schema file (now includes package.json)
  • Support for dotenv-expand

• null vs undefined in Prisma Client

• The prisma version command

September 14 2020 Copy Chapter

New documentation:

• Prisma Client error reference

September 3 2020 Copy Chapter

New documentation (2.6.0):

• Atomic operations on update
• Introspecting with an existing schema

August 24 2020 Copy Chapter

New documentation:

• Prisma Schema API reference section! 🎉
• Multiple data source providers (Now deprecated)

August 21 2020 Copy Chapter

New documentation:

• Case sensitivity with Prisma Client (2.5.0)

August 4 2020 Copy Chapter

New documentation:

• 2.4.0 documentation

  • Sorting by multiple fields
  • Client-level methods (like $on()) now prefixed by $ - versions without $ deprecated but not removed

• Working with scalar lists / scalar arrays

July 28 2020 Copy Chapter

New documentation:

• Aggregations
• connectOrCreate

July 22 2020 Copy Chapter

New documentation:

• Middleware (preview)
• Distinct API (preview)
• .env file locations covered by Prisma Client

July 17 2020 Copy Chapter

New documentation:

• Sorting records with orderBy
• Working with the Json field type
• Documentation changelog added

File: content/600-about/200-prisma-docs/10-about-the-docs.mdx Copy Chapter

title: 'About the docs' metaTitle: 'About the Prisma documentation' metaDescription: 'This page gives a meta-overview about different topics that are relevant to better understand and navigate the Prisma documentation.' tocDepth: 2 Copy Chapter

The `User` and `Post` data model Copy Chapter

The User and Post models have been selected for the following reasons:

• These two models do not require domain-specific knowledge.
• They are also commonly used as an example in the ORM space, making them familiar for users coming from other tools.
• Having consistent models makes it easier for the reader when learning about different concepts, since there will be less context switching.
• Less decision making and cognitive overhead for the docs authors. Using the same models reduces decision fatigue and is one less thing to worry about when trying to explain concepts.

We are actively working on adding more schema examples to the docs to provide you with starting points for common data models, such as e-commerce.

Naming conventions for tables and columns Copy Chapter

Table names are generally spelled in PascalCase. Column names in camelCase.

Embrace redundancy Copy Chapter

Meet the user where they are.

File: content/600-about/200-prisma-docs/index.mdx Copy Chapter

title: 'Prisma docs' metaTitle: 'About Prisma docs' metaDescription: 'About Prisma docs' toc: false staticLink: true Copy Chapter

In this section Copy Chapter