Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
418 changes: 418 additions & 0 deletions docs/100-getting-started/01-quickstart.mdx

Large diffs are not rendered by default.

Large diffs are not rendered by default.

Large diffs are not rendered by default.

Original file line number Diff line number Diff line change
@@ -0,0 +1,282 @@
---
title: 'Install Prisma Client'
metaTitle: 'Install Prisma Client'
metaDescription: 'Install and generate Prisma Client in your project'
langSwitcher: ['typescript', 'node']
dbSwitcher: ['postgresql', 'mysql', 'sqlserver', 'planetscale', 'cockroachdb']
toc: false
---

## Install and generate Prisma Client

To get started with Prisma Client, you need to install the `@prisma/client` package:

```terminal copy
npm install @prisma/client
```

The install command invokes `prisma generate` for you which reads your Prisma schema and generates a version of Prisma Client that is _tailored_ to your models.

![Install and generate Prisma Client](/img/getting-started/prisma-client-install-and-generate.png)

Whenever you update your Prisma schema, you will have to update your database schema using either `prisma migrate dev` or `prisma db push`. This will keep your database schema in sync with your Prisma schema. The commands will also regenerate Prisma Client.

<SwitchTech technologies={['node', 'postgresql']}>

<NavigationLinksContainer>

<ButtonLink
color="dark"
type="primary"
href="./using-prisma-migrate-node-postgresql"
arrowLeft
>
Using Prisma Migrate
</ButtonLink>

<ButtonLink
color="dark"
type="primary"
href="./querying-the-database-node-postgresql"
arrow
>
Querying the database
</ButtonLink>

</NavigationLinksContainer>

</SwitchTech>

<SwitchTech technologies={['node', 'mysql']}>

<NavigationLinksContainer>

<ButtonLink
color="dark"
type="primary"
href="./using-prisma-migrate-node-mysql"
arrowLeft
>
Using Prisma Migrate
</ButtonLink>

<ButtonLink
color="dark"
type="primary"
href="./querying-the-database-node-mysql"
arrow
>
Querying the database
</ButtonLink>

</NavigationLinksContainer>

</SwitchTech>

<SwitchTech technologies={['node', 'sqlserver']}>

<NavigationLinksContainer>

<ButtonLink
color="dark"
type="primary"
href="./using-prisma-migrate-node-sqlserver"
arrowLeft
>
Using Prisma Migrate
</ButtonLink>

<ButtonLink
color="dark"
type="primary"
href="./querying-the-database-node-sqlserver"
arrow
>
Querying the database
</ButtonLink>

</NavigationLinksContainer>

</SwitchTech>

<SwitchTech technologies={['node', 'planetscale']}>

<NavigationLinksContainer>

<ButtonLink
color="dark"
type="primary"
href="./using-prisma-migrate-node-planetscale"
arrowLeft
>
Using Prisma Migrate
</ButtonLink>

<ButtonLink
color="dark"
type="primary"
href="./querying-the-database-node-planetscale"
arrow
>
Querying the database
</ButtonLink>

</NavigationLinksContainer>

</SwitchTech>

<SwitchTech technologies={['node', 'cockroachdb']}>

<NavigationLinksContainer>

<ButtonLink
color="dark"
type="primary"
href="./using-prisma-migrate-node-cockroachdb"
arrowLeft
>
Using Prisma Migrate
</ButtonLink>

<ButtonLink
color="dark"
type="primary"
href="./querying-the-database-node-cockroachdb"
arrow
>
Querying the database
</ButtonLink>

</NavigationLinksContainer>

</SwitchTech>

<SwitchTech technologies={['typescript', 'postgresql']}>

<NavigationLinksContainer>

<ButtonLink
color="dark"
type="primary"
href="./using-prisma-migrate-typescript-postgresql"
arrowLeft
>
Using Prisma Migrate
</ButtonLink>

<ButtonLink
color="dark"
type="primary"
href="./querying-the-database-typescript-postgresql"
arrow
>
Querying the database
</ButtonLink>

</NavigationLinksContainer>

</SwitchTech>

<SwitchTech technologies={['typescript', 'mysql']}>

<NavigationLinksContainer>

<ButtonLink
color="dark"
type="primary"
href="./using-prisma-migrate-typescript-mysql"
arrowLeft
>
Using Prisma Migrate
</ButtonLink>

<ButtonLink
color="dark"
type="primary"
href="./querying-the-database-typescript-mysql"
arrow
>
Querying the database
</ButtonLink>

</NavigationLinksContainer>

</SwitchTech>

<SwitchTech technologies={['typescript', 'planetscale']}>

<NavigationLinksContainer>

<ButtonLink
color="dark"
type="primary"
href="./using-prisma-migrate-typescript-planetscale"
arrowLeft
>
Creating the database schema
</ButtonLink>

<ButtonLink
color="dark"
type="primary"
href="./querying-the-database-typescript-planetscale"
arrow
>
Querying the database
</ButtonLink>

</NavigationLinksContainer>

</SwitchTech>

<SwitchTech technologies={['typescript', 'sqlserver']}>

<NavigationLinksContainer>

<ButtonLink
color="dark"
type="primary"
href="./using-prisma-migrate-typescript-sqlserver"
arrowLeft
>
Using Prisma Migrate
</ButtonLink>

<ButtonLink
color="dark"
type="primary"
href="./querying-the-database-typescript-sqlserver"
arrow
>
Querying the database
</ButtonLink>

</NavigationLinksContainer>

</SwitchTech>

<SwitchTech technologies={['typescript', 'cockroachdb']}>

<NavigationLinksContainer>

<ButtonLink
color="dark"
type="primary"
href="./using-prisma-migrate-typescript-cockroachdb"
arrowLeft
>
Using Prisma Migrate
</ButtonLink>

<ButtonLink
color="dark"
type="primary"
href="./querying-the-database-typescript-cockroachdb"
arrow
>
Querying the database
</ButtonLink>

</NavigationLinksContainer>

</SwitchTech>
Loading