跳到主内容

使用 TypeScript 和 Prisma ORM 查询您现有的 CockroachDB 数据库

TypeScript
CockroachDB

使用 Prisma Client 编写您的第一个查询​

生成 Prisma Client 后，您就可以开始编写查询，以读取和写入数据库中的数据。

如果您正在构建 REST API，可以在路由处理程序中使用 Prisma Client，根据传入的 HTTP 请求读取和写入数据库中的数据。如果您正在构建 GraphQL API，可以在解析器中使用 Prisma Client，根据传入的查询和变更来读取和写入数据库中的数据。

然而，就本指南而言，您将只创建一个普通的 Node.js 脚本来学习如何使用 Prisma Client 向数据库发送查询。一旦您了解了 API 的工作原理，就可以开始将其集成到您的实际应用程序代码中（例如 REST 路由处理程序或 GraphQL 解析器）。

创建一个名为 index.ts 的新文件，并将以下代码添加到其中

index.ts
import { PrismaClient } from '@prisma/client'

const prisma = new PrismaClient()

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

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

以下是代码片段不同部分的快速概述

  1. 从 @prisma/client node 模块导入 PrismaClient 构造函数
  2. 实例化 PrismaClient
  3. 定义一个名为 main 的 async 函数，用于向数据库发送查询
  4. 调用 main 函数
  5. 脚本终止时关闭数据库连接

根据您的模型定义，Prisma Client API 也会有所不同。例如，如果您有一个 User 模型，您的 PrismaClient 实例会暴露一个名为 user 的属性，您可以在其上调用 CRUD 方法，如 findMany、create 或 update。该属性以模型命名，但首字母小写（因此对于 Post 模型，它被称为 post；对于 Profile 模型，它被称为 profile）。

以下示例均基于 Prisma schema 中的模型。

在 main 函数内部，添加以下查询以从数据库读取所有 User 记录并打印结果

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

现在使用您当前的 TypeScript 配置运行代码。如果您正在使用 tsx，可以这样运行它

npx tsx index.ts

如果您使用数据库内省步骤中的 schema 创建了数据库，则查询应打印一个空数组，因为数据库中尚无 User 记录。

[]

如果您对一个包含记录的现有数据库进行了内省，则查询应返回一个 JavaScript 对象数组。

将数据写入数据库​

您在上一节中使用的 findMany 查询仅从数据库中“读取”数据。在本节中，您将学习如何编写查询以“写入”新记录到 Post 和 User 表中。

调整 main 函数以向数据库发送 create 查询

index.ts
async function main() {
  await prisma.user.create({
    data: {
      name: 'Alice',
      email: 'alice@prisma.io',
      posts: {
        create: { title: 'Hello World' },
      },
      profile: {
        create: { bio: 'I like turtles' },
      },
    },
  })

  const allUsers = await prisma.user.findMany({
    include: {
      posts: true,
      profile: true,
    },
  })
  console.dir(allUsers, { depth: null })
}

此代码使用 嵌套写入查询，创建一个新的 User 记录以及新的 Post 和 Profile 记录。User 记录通过 Post.author ↔ User.posts 和 Profile.user ↔ User.profile 关系字段分别连接到另外两条记录。

请注意，您正在将 include 选项传递给 findMany，它告诉 Prisma Client 在返回的 User 对象中包含 posts 和 profile 关系。

现在使用您当前的 TypeScript 配置运行代码。如果您正在使用 tsx，可以这样运行它

npx tsx index.ts

在进入下一节之前，您将使用 update 查询“发布”刚刚创建的 Post 记录。调整 main 函数如下

index.ts
async function main() {
  const post = await prisma.post.update({
    where: { title: 'Hello World' },
    data: { published: true },
  })
  console.log(post)
}

现在使用您当前的 TypeScript 配置运行代码。如果您正在使用 tsx，可以这样运行它

npx tsx index.ts
© . All rights reserved.