跳到主要内容

从 CLI

本页面提供 Prisma Postgres 在使用 prisma init --db 设置后的分步指南

  1. 使用 Prisma ORM 设置 TypeScript 应用程序
  2. 迁移数据库的 schema
  3. 从 TypeScript 查询您的数据库

先决条件

本指南假定您使用 prisma init --db 设置了 Prisma Postgres 实例

npx prisma@latest init --db
显示CLI结果

一旦此命令终止

  • 您已登录到 Prisma Data Platform。
  • 已创建新的 Prisma Postgres 实例。
  • 创建了 prisma/ 文件夹,其中包含一个空的 schema.prisma 文件。
  • DATABASE_URL 环境变量已在 .env 文件中设置。

1. 组织您的项目目录

注意

如果您在希望项目存在的文件夹中运行了 prisma init --db 命令,则可以跳过此步骤并继续下一节

如果您在预期项目目录之外(例如,在您的主文件夹或其他位置)运行了该命令,则需要将生成的 prisma 文件夹和 .env 文件移动到专用的项目目录中。

创建一个新文件夹(例如 hello-prisma),您希望项目存在于其中,并将必要的文件移动到其中

mkdir hello-prisma
mv .env ./hello-prisma/
mv prisma ./hello-prisma/

导航到您的项目文件夹

cd ./hello-prisma

现在您的项目位于正确的位置,请继续设置。

2. 设置您的项目

2.1. 设置 TypeScript

初始化 TypeScript 项目并将 Prisma CLI 添加为开发依赖项

npm init -y
npm install typescript tsx @types/node --save-dev

这将创建一个 package.json 文件,其中包含您的 TypeScript 应用程序的初始设置。

接下来,使用项目中的 tsconfig.json 文件初始化 TypeScript

npx tsc --init

2.2. 设置 Prisma ORM

安装使用 Prisma Postgres 所需的依赖项

npm install prisma --save-dev
npm install @prisma/extension-accelerate

2.3. 创建 TypeScript 脚本

在根目录中创建一个 index.ts 文件,这将用于使用 Prisma ORM 查询您的应用程序

touch index.ts

3. 迁移数据库 schema

更新您的 prisma/schema.prisma 文件以包含一个简单的 User 模型

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

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

添加模型后,使用 Prisma Migrate 迁移您的数据库

npx prisma migrate dev --name init

4. 使用 Prisma ORM 发送查询

将以下样板粘贴到 index.ts

index.ts
import { PrismaClient } from '@prisma/client'
import { withAccelerate } from '@prisma/extension-accelerate'

const prisma = new PrismaClient().$extends(withAccelerate())

async function main() {
// ... you will write your Prisma ORM queries here
}

main()
.then(async () => {
await prisma.$disconnect()
})
.catch(async (e) => {
console.error(e)
await prisma.$disconnect()
process.exit(1)
})

此代码包含一个在脚本末尾调用的 main 函数。它还实例化了 PrismaClient,您将使用它向数据库发送查询。

4.1. 创建新的 User 记录

让我们从一个小查询开始,以在数据库中创建一个新的 User 记录,并将结果对象记录到控制台。将以下代码添加到您的 index.ts 文件中

index.ts
import { PrismaClient } from '@prisma/client'
import { withAccelerate } from '@prisma/extension-accelerate'

const prisma = new PrismaClient().$extends(withAccelerate())

async function main() {
const user = await prisma.user.create({
data: {
name: 'Alice',
email: 'alice@prisma.io',
},
})
console.log(user)
}

main()
.then(async () => {
await prisma.$disconnect()
})
.catch(async (e) => {
console.error(e)
await prisma.$disconnect()
process.exit(1)
})

接下来,使用以下命令执行脚本

npx tsx index.ts
显示CLI结果
{ id: 1, email: 'alice@prisma.io', name: 'Alice' }

做得好,您刚刚使用 Prisma Postgres 创建了您的第一个数据库记录! 🎉

4.2. 检索所有 User 记录

Prisma ORM 提供了各种查询来从您的数据库读取数据。在本节中,您将使用 findMany 查询,该查询返回给定模型在数据库中的所有记录。

删除之前的 Prisma ORM 查询,并添加新的 findMany 查询

index.ts
import { PrismaClient } from '@prisma/client'
import { withAccelerate } from '@prisma/extension-accelerate'

const prisma = new PrismaClient().$extends(withAccelerate())

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

main()
.then(async () => {
await prisma.$disconnect()
})
.catch(async (e) => {
console.error(e)
await prisma.$disconnect()
process.exit(1)
})

再次执行脚本

npx tsx index.ts
显示CLI结果
[{ id: 1, email: 'alice@prisma.io', name: 'Alice' }]

请注意控制台中单个 User 对象现在是如何用方括号括起来的。那是因为 findMany 返回了一个数组,其中包含一个对象。

4.3. 探索关系查询

Prisma ORM 的主要功能之一是易于使用关系。在本节中,您将学习如何在嵌套写入查询中创建 UserPost 记录。之后,您将了解如何使用 include 选项从数据库中检索关系。

首先,调整您的脚本以包含嵌套查询

index.ts
import { PrismaClient } from '@prisma/client'
import { withAccelerate } from '@prisma/extension-accelerate'

const prisma = new PrismaClient().$extends(withAccelerate())

async function main() {
const user = await prisma.user.create({
data: {
name: 'Bob',
email: 'bob@prisma.io',
posts: {
create: [
{
title: 'Hello World',
published: true
},
{
title: 'My second post',
content: 'This is still a draft'
}
],
},
},
})
console.log(user)
}

main()
.then(async () => {
await prisma.$disconnect()
})
.catch(async (e) => {
console.error(e)
await prisma.$disconnect()
process.exit(1)
})

通过再次执行脚本来运行查询

npx tsx index.ts
显示CLI结果
{ id: 2, email: 'bob@prisma.io', name: 'Bob' }

为了也检索属于 UserPost 记录,您可以使用通过 posts 关系字段的 include 选项

index.ts
import { PrismaClient } from '@prisma/client'
import { withAccelerate } from '@prisma/extension-accelerate'

const prisma = new PrismaClient().$extends(withAccelerate())

async function main() {
const usersWithPosts = await prisma.user.findMany({
include: {
posts: true,
},
})
console.dir(usersWithPosts, { depth: null })
}

main()
.then(async () => {
await prisma.$disconnect()
})
.catch(async (e) => {
console.error(e)
await prisma.$disconnect()
process.exit(1)
})

再次运行脚本以查看嵌套读取查询的结果

npx tsx index.ts
显示CLI结果
[
{ id: 1, email: 'alice@prisma.io', name: 'Alice', posts: [] },
{
id: 2,
email: 'bob@prisma.io',
name: 'Bob',
posts: [
{
id: 1,
title: 'Hello World',
content: null,
published: true,
authorId: 2
},
{
id: 2,
title: 'My second post',
content: 'This is still a draft',
published: false,
authorId: 2
}
]
}
]

这一次,您看到打印了两个 User 对象。它们都具有 posts 字段(对于 "Alice" 为空,对于 "Bob" 则填充了两个 Post 对象),表示与它们关联的 Post 记录。

下一步

您刚刚对基本的 Prisma Postgres 设置有了初步了解。如果您想探索更复杂的查询,例如添加缓存功能,请查看官方快速入门

在 Prisma Studio 中查看和编辑数据

Prisma ORM 附带一个内置 GUI,用于查看和编辑数据库中的数据。您可以使用以下命令打开它

npx prisma studio

使用 Prisma Postgres,您还可以在内部直接使用 Prisma Studio通过在您的项目中选择 Studio 选项卡。

使用 Next.js 构建全栈应用程序

了解如何在全栈应用程序中使用 Prisma Postgres

探索即用型示例

查看 GitHub 上的 prisma-examples 存储库,了解 Prisma ORM 如何与您喜欢的库一起使用。该存储库包含 Express、NestJS、GraphQL 的示例,以及使用 Next.js 和 Vue.js 的全栈示例等等。

这些示例默认使用 SQLite,但您可以按照项目 README 中的说明在几个简单的步骤中切换到 Prisma Postgres。


与 Prisma 保持联系

通过与以下方面联系来继续您的 Prisma 之旅 我们活跃的社区。随时了解情况,参与其中,并与其他开发人员协作

我们真诚地重视您的参与,并期待您成为我们社区的一份子!