Skip to content

Commit 21d75d5

Browse files
ankur-archaidankmcalister
authored andcommitted
feat: update prisma init related changes in other parts (#7267)
* feat: add kysley * feat: add drizzle * feat: add typeorm * fix: clean-up * fix: update prisma init command changes * feat: update prisma cli docs * fix: clarify the usage of prisma init better * fix: add type defs * feat: add pg as a dependency * fix: broken internal link
1 parent 625c9d5 commit 21d75d5

22 files changed

Lines changed: 456 additions & 180 deletions

File tree

content/100-getting-started/02-prisma-orm/100-quickstart/100-prisma-postgres.mdx

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -25,15 +25,17 @@ import NextSteps from '../../_components/_next-steps.mdx'
2525
Install the packages needed for this quickstart:
2626

2727
```terminal
28-
npm install prisma @types/node --save-dev
29-
npm install @prisma/client @prisma/adapter-pg dotenv
28+
npm install prisma @types/node @types/pg --save-dev
29+
npm install @prisma/client @prisma/adapter-pg pg dotenv
3030
```
3131

3232
Here's what each package does:
3333

3434
- **`prisma`** - The Prisma CLI for running commands like `prisma init`, `prisma migrate`, and `prisma generate`
3535
- **`@prisma/client`** - The Prisma Client library for querying your database
3636
- **`@prisma/adapter-pg`** - The [`node-postgres` driver adapter](/orm/overview/databases/postgresql#using-the-node-postgres-driver) that connects Prisma Client to your database
37+
- **`pg`** - The node-postgres database driver
38+
- **`@types/pg`** - TypeScript type definitions for node-postgres
3739
- **`dotenv`** - Loads environment variables from your `.env` file
3840

3941
## 3. Configure ESM support

content/100-getting-started/02-prisma-orm/100-quickstart/200-sqlite.mdx

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ In this guide, you will learn how to set up a new TypeScript project from scratc
2727
Install the packages needed for this quickstart:
2828

2929
```terminal
30-
npm install prisma @types/node --save-dev
30+
npm install prisma @types/node @types/better-sqlite3 --save-dev
3131
npm install @prisma/client @prisma/adapter-better-sqlite3 dotenv
3232
```
3333

@@ -36,6 +36,7 @@ Here's what each package does:
3636
- **`prisma`** - The Prisma CLI for running commands like `prisma init`, `prisma migrate`, and `prisma generate`
3737
- **`@prisma/client`** - The Prisma Client library for querying your database
3838
- **`@prisma/adapter-better-sqlite3`** - The SQLite driver adapter that connects Prisma Client to your database
39+
- **`@types/better-sqlite3`** - TypeScript type definitions for better-sqlite3
3940
- **`dotenv`** - Loads environment variables from your `.env` file
4041

4142
## 3. Configure ESM support
@@ -93,16 +94,13 @@ import { defineConfig, env } from 'prisma/config'
9394

9495
export default defineConfig({
9596
schema: 'prisma/schema.prisma',
96-
migrations: {
97-
path: 'prisma/migrations',
98-
},
9997
datasource: {
10098
url: env('DATABASE_URL'),
10199
},
102100
})
103101
```
104102

105-
Add `dotenv` to `prisma.config.ts` so that Prisma can load environment variables from your `.env` file:
103+
Add `dotenv` and migrations configuration to `prisma.config.ts`:
106104

107105
```typescript file=prisma.config.ts
108106
// add-start
@@ -112,9 +110,11 @@ import { defineConfig, env } from 'prisma/config'
112110

113111
export default defineConfig({
114112
schema: 'prisma/schema.prisma',
113+
// add-start
115114
migrations: {
116115
path: 'prisma/migrations',
117116
},
117+
// add-end
118118
datasource: {
119119
url: env('DATABASE_URL'),
120120
},

content/100-getting-started/02-prisma-orm/100-quickstart/300-postgresql.mdx

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -36,15 +36,17 @@ If you don't already have a PostgreSQL database, follow the quickstart to set up
3636
Install the packages needed for this quickstart:
3737

3838
```terminal
39-
npm install prisma @types/node --save-dev
40-
npm install @prisma/client @prisma/adapter-pg dotenv
39+
npm install prisma @types/node @types/pg --save-dev
40+
npm install @prisma/client @prisma/adapter-pg pg dotenv
4141
```
4242

4343
Here's what each package does:
4444

4545
- **`prisma`** - The Prisma CLI for running commands like `prisma init`, `prisma migrate`, and `prisma generate`
4646
- **`@prisma/client`** - The Prisma Client library for querying your database
4747
- **`@prisma/adapter-pg`** - The [`node-postgres` driver adapter](/orm/overview/databases/postgresql#using-the-node-postgres-driver) that connects Prisma Client to your database
48+
- **`pg`** - The node-postgres database driver
49+
- **`@types/pg`** - TypeScript type definitions for node-postgres
4850
- **`dotenv`** - Loads environment variables from your `.env` file
4951

5052
## 3. Configure ESM support

content/100-getting-started/02-prisma-orm/100-quickstart/500-sql-server.mdx

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ You also need:
3232
Install the packages needed for this quickstart:
3333

3434
```terminal
35-
npm install prisma @types/node --save-dev
35+
npm install prisma @types/node @types/mssql --save-dev
3636
npm install @prisma/client @prisma/adapter-mssql dotenv
3737
```
3838

@@ -41,6 +41,7 @@ Here's what each package does:
4141
- **`prisma`** - The Prisma CLI for running commands like `prisma init`, `prisma migrate`, and `prisma generate`
4242
- **`@prisma/client`** - The Prisma Client library for querying your database
4343
- **`@prisma/adapter-mssql`** - The SQL Server driver adapter that connects Prisma Client to your database
44+
- **`@types/mssql`** - TypeScript type definitions for mssql
4445
- **`dotenv`** - Loads environment variables from your `.env` file
4546

4647
## 3. Configure ESM support

content/100-getting-started/02-prisma-orm/100-quickstart/700-cockroachdb.mdx

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -30,15 +30,17 @@ You also need:
3030
Install the packages needed for this quickstart:
3131

3232
```terminal
33-
npm install prisma @types/node --save-dev
34-
npm install @prisma/client @prisma/adapter-pg dotenv
33+
npm install prisma @types/node @types/pg --save-dev
34+
npm install @prisma/client @prisma/adapter-pg pg dotenv
3535
```
3636

3737
Here's what each package does:
3838

3939
- **`prisma`** - The Prisma CLI for running commands like `prisma init`, `prisma migrate`, and `prisma generate`
4040
- **`@prisma/client`** - The Prisma Client library for querying your database
4141
- **`@prisma/adapter-pg`** - The [`node-postgres` driver adapter](/orm/overview/databases/postgresql#using-the-node-postgres-driver) that connects Prisma Client to your database (CockroachDB is PostgreSQL-compatible)
42+
- **`pg`** - The node-postgres database driver
43+
- **`@types/pg`** - TypeScript type definitions for node-postgres
4244
- **`dotenv`** - Loads environment variables from your `.env` file
4345

4446
## 3. Configure ESM support

content/100-getting-started/02-prisma-orm/200-add-to-existing-project/100-prisma-postgres.mdx

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -20,15 +20,17 @@ import NextSteps from '../../_components/_next-steps.mdx'
2020
Navigate to your existing project directory and install the required dependencies:
2121

2222
```terminal
23-
npm install prisma @types/node --save-dev
24-
npm install @prisma/client @prisma/adapter-pg dotenv
23+
npm install prisma @types/node @types/pg --save-dev
24+
npm install @prisma/client @prisma/adapter-pg pg dotenv
2525
```
2626

2727
Here's what each package does:
2828

2929
- **`prisma`** - The Prisma CLI for running commands like `prisma init`, `prisma db pull`, and `prisma generate`
3030
- **`@prisma/client`** - The Prisma Client library for querying your database
3131
- **`@prisma/adapter-pg`** - The [`node-postgres` driver adapter](/orm/overview/databases/postgresql#using-the-node-postgres-driver) that connects Prisma Client to your database
32+
- **`pg`** - The node-postgres database driver
33+
- **`@types/pg`** - TypeScript type definitions for node-postgres
3234
- **`dotenv`** - Loads environment variables from your `.env` file
3335

3436
## 2. Initialize Prisma ORM

content/100-getting-started/02-prisma-orm/200-add-to-existing-project/200-sqlite.mdx

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ import NextSteps from '../../_components/_next-steps.mdx'
2020
Navigate to your existing project directory and install the required dependencies:
2121

2222
```terminal
23-
npm install prisma @types/node --save-dev
23+
npm install prisma @types/node @types/better-sqlite3 --save-dev
2424
npm install @prisma/client @prisma/adapter-better-sqlite3 dotenv
2525
```
2626

@@ -29,6 +29,7 @@ Here's what each package does:
2929
- **`prisma`** - The Prisma CLI for running commands like `prisma init`, `prisma db pull`, and `prisma generate`
3030
- **`@prisma/client`** - The Prisma Client library for querying your database
3131
- **`@prisma/adapter-better-sqlite3`** - The SQLite driver adapter that connects Prisma Client to your database
32+
- **`@types/better-sqlite3`** - TypeScript type definitions for better-sqlite3
3233
- **`dotenv`** - Loads environment variables from your `.env` file
3334

3435
## 2. Initialize Prisma ORM

content/100-getting-started/02-prisma-orm/200-add-to-existing-project/300-postgresql.mdx

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -20,15 +20,17 @@ import NextSteps from '../../_components/_next-steps.mdx'
2020
Navigate to your existing project directory and install the required dependencies:
2121

2222
```terminal
23-
npm install prisma @types/node --save-dev
24-
npm install @prisma/client @prisma/adapter-pg dotenv
23+
npm install prisma @types/node @types/pg --save-dev
24+
npm install @prisma/client @prisma/adapter-pg pg dotenv
2525
```
2626

2727
Here's what each package does:
2828

2929
- **`prisma`** - The Prisma CLI for running commands like `prisma init`, `prisma db pull`, and `prisma generate`
3030
- **`@prisma/client`** - The Prisma Client library for querying your database
3131
- **`@prisma/adapter-pg`** - The [`node-postgres` driver adapter](/orm/overview/databases/postgresql#using-the-node-postgres-driver) that connects Prisma Client to your database
32+
- **`pg`** - The node-postgres database driver
33+
- **`@types/pg`** - TypeScript type definitions for node-postgres
3234
- **`dotenv`** - Loads environment variables from your `.env` file
3335

3436
## 2. Initialize Prisma ORM

content/100-getting-started/02-prisma-orm/200-add-to-existing-project/500-sql-server.mdx

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ import NextSteps from '../../_components/_next-steps.mdx'
2020
Navigate to your existing project directory and install the required dependencies:
2121

2222
```terminal
23-
npm install prisma @types/node --save-dev
23+
npm install prisma @types/node @types/mssql --save-dev
2424
npm install @prisma/client @prisma/adapter-mssql dotenv
2525
```
2626

@@ -30,6 +30,7 @@ Here's what each package does:
3030
- **`@prisma/client`** - The Prisma Client library for querying your database
3131
- **`@prisma/adapter-mssql`** - The SQL Server driver adapter that connects Prisma Client to your database
3232
- **`dotenv`** - Loads environment variables from your `.env` file
33+
- **`@types/mssql`** - TypeScript type definitions for mssql
3334

3435
## 2. Initialize Prisma ORM
3536

content/100-getting-started/02-prisma-orm/200-add-to-existing-project/700-cockroachdb.mdx

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -20,15 +20,17 @@ import NextSteps from '../../_components/_next-steps.mdx'
2020
Navigate to your existing project directory and install the required dependencies:
2121

2222
```terminal
23-
npm install prisma @types/node --save-dev
24-
npm install @prisma/client @prisma/adapter-pg dotenv
23+
npm install prisma @types/node @types/pg --save-dev
24+
npm install @prisma/client @prisma/adapter-pg pg dotenv
2525
```
2626

2727
Here's what each package does:
2828

2929
- **`prisma`** - The Prisma CLI for running commands like `prisma init`, `prisma db pull`, and `prisma generate`
3030
- **`@prisma/client`** - The Prisma Client library for querying your database
3131
- **`@prisma/adapter-pg`** - The [`node-postgres` driver adapter](/orm/overview/databases/postgresql#using-the-node-postgres-driver) that connects Prisma Client to your database (CockroachDB is PostgreSQL-compatible)
32+
- **`pg`** - The node-postgres database driver
33+
- **`@types/pg`** - TypeScript type definitions for node-postgres
3234
- **`dotenv`** - Loads environment variables from your `.env` file
3335

3436
## 2. Initialize Prisma ORM

0 commit comments

Comments
 (0)