跳到主要内容

Prisma Client 简介

Prisma Client 是一个自动生成且类型安全的查询构建器，它专为你的数据量身定制。开始使用 Prisma Client 最简单的方法是遵循快速入门。

快速入门（5 分钟）

下面的设置说明提供了设置 Prisma Client 所需步骤的高级概述。如果你想开始使用 Prisma Client 与自己的数据库，请遵循以下指南之一

从头开始设置新项目



将 Prisma 添加到现有项目

设置​

1. 前提条件​

为了设置 Prisma Client，你需要一个包含数据库连接、Prisma Client 生成器和至少一个模型的Prisma schema 文件

schema.prisma
datasource db {
  url      = env("DATABASE_URL")
  provider = "postgresql"
}

generator client {
  provider = "prisma-client-js"
  output   = "../src/generated/prisma"
}

model User {
  id        Int      @id @default(autoincrement())
  createdAt DateTime @default(now())
  email     String   @unique
  name      String?
}

另外，请确保安装 Prisma CLI

npm install prisma --save-dev
npx prisma

2. 安装​

使用以下命令在你的项目中安装 Prisma Client

npm install @prisma/client

3. 导入 Prisma Client​

根据你的使用场景，有多种方法可以在项目中导入 Prisma Client

import { PrismaClient } from './generated/prisma'

const prisma = new PrismaClient()
// use `prisma` in your application to read and write data in your DB

对于边缘环境，你可以如下导入 Prisma Client

import { PrismaClient } from './generated/prisma/edge'

const prisma = new PrismaClient()
// use `prisma` in your application to read and write data in your DB

注意：如果你正在使用驱动适配器，你可以直接从生成器中指定的 output 路径导入，例如 ./src/generated/prisma。无需从 ./src/generated/prisma/edge 导入。

4. 使用 Prisma Client 向数据库发送查询​

实例化 PrismaClient 后，你就可以在代码中开始发送查询了

// run inside `async` function
const newUser = await prisma.user.create({
  data: {
    name: 'Alice',
    email: 'alice@prisma.io',
  },
})

const users = await prisma.user.findMany()
信息

所有 Prisma Client 方法都返回一个 PrismaPromise 实例，该实例只在你调用 await 或 .then() 或 .catch() 时执行。

5. 演进你的应用​

每当你对数据库进行更改并在 Prisma schema 中反映这些更改时，你需要手动重新生成 Prisma Client，以更新 node_modules/.prisma/client 目录中的生成代码。

prisma generate
© . All rights reserved.