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

TypeScript

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

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

JavaScript

const { PrismaClient } = require('./generated/prisma')

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

對於邊緣環境，你可以如下匯入 Prisma Client

TypeScript

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

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

JavaScript

const { PrismaClient } = require('./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