面向Node.js和TypeScript的下一代 ORM工具Prisma

准备

数据库准备

• Supabase

• Heroku

• Railway

初始化项目

• Prisma Client: 为Node.js和TypeScript自动生成和类型安全的查询生成器

• Prisma Migrate: 迁移工具，可以轻松地将数据库模式从原型设计应用到生产

• Prisma Studio: 用于查看和编辑数据库中数据的GUI

 

npx create-next-app@latest

npm install prisma

npx prisma init

generator client {
  provider = "prisma-client-js"
}

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

• User: 数据库用户名

• Password: 数据库用户密码

• Host: 数据库服务器的 ip 或者域名

• Port: 数据库服务器的端口

• Database name: 数据库名称

DATABASE_URL="postgresql://johndoe:randompassword@localhost:5432/mydb?schema=public"

Prisma Schema

• 构成了应用领域的 实体

• 映射到数据库的 表（关系型数据库，例如 PostgreSQL）或 集合 （MongoDB）

• 构成 Prisma Client API 中 查询 的基础

model User {
  id      Int      @id @default(autoincrement())
  email   String   @unique
  name    String?
  role    Role     @default(USER)
  posts   Post[]
  profile Profile?
}

model Profile {
  id     Int    @id @default(autoincrement())
  bio    String
  user   User   @relation(fields: [userId], references: [id])
  userId Int
}

model Post {
  id         Int        @id @default(autoincrement())
  createdAt  DateTime   @default(now())
  title      String
  published  Boolean    @default(false)
  author     User       @relation(fields: [authorId], references: [id])
  authorId   Int
  categories Category[] @relation(references: [id])
}

model Category {
  id    Int    @id @default(autoincrement())
  name  String
  posts Post[] @relation(references: [id])
}

enum Role {
  USER
  ADMIN
} 

• 在 PostgreSQL 和 MySQL 等关系型数据库中，model 映射至 表

• MongoDB 中，model 映射至 集合

npx prisma format

Prisma Migrate

• 保持数据库架构与Prisma 架构的同步

• 维护数据库中的现有数据

model User {
  id    Int    @id @default(autoincrement())
  name  String
  Post Post[]
}

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

npx prisma migrate dev --name init

migrations/
  └─ 20230420131352_init/
    └─ migration.sql

-- CreateTable
CREATE TABLE "User" (
    "id" SERIAL NOT NULL,
    "name" TEXT NOT NULL,

    CONSTRAINT "User_pkey" PRIMARY KEY ("id")
);

-- CreateTable
CREATE TABLE "Post" (
    "id" SERIAL NOT NULL,
    "title" TEXT NOT NULL,
    "published" BOOLEAN NOT NULL DEFAULT true,
    "authorId" INTEGER NOT NULL,

    CONSTRAINT "Post_pkey" PRIMARY KEY ("id")
);

-- AddForeignKey
ALTER TABLE "Post" ADD CONSTRAINT "Post_authorId_fkey" FOREIGN KEY ("authorId") REFERENCES "User"("id") ON DELETE RESTRICT ON UPDATE CASCADE;

model User {
  id       Int      @id @default(autoincrement())
  gender   Int
  name     String
  posts    Post[]
}

npx prisma migrate dev --name add_gender

migrations/
  └─ 20230420131352_init/
    └─ migration.sql
  └─ 20230420132624_add_gender/
    └─ migration.sql

-- AlterTable
ALTER TABLE "User" ADD COLUMN  "gender" INTEGER NOT NULL;

db push

1. 检查数据库，以推断和执行所需的更改，使数据库架构反映 Prisma 架构的状态。

2. 默认情况下，将更改应用到数据库架构后会触发生成器 (例如，Prisma Client)。您不需要手动调用Prisma生成。

3. 如果 db push 预测到更改可能导致数据丢失，它会:
• 抛出一个错误
• 如果仍要进行更改，则需要加上-accept-data-loss选项

npx prisma db push

npx prisma migrate dev --name added-avatar

Prisma Studio

npx prisma studio

Prisma Client

生成 PrismaClient 实例

1. 安装 @prisma/clientnpm 包:

npm install @prisma/client

2. 使用以下命令生成 Prisma Client:

prisma generate

model User {
  id     Int    @id @default(autoincrement())
  Post   Post[]
}

model User {
  id     Int    @id @default(autoincrement())
  posts   Post[]
}

创建 PrismaClient 实例

import { PrismaClient } from '@prisma/client'
const prisma = new PrismaClient()

• ✔ 创建一个的PrismaClient实例，并在整个应用程序中重复使用它
默认情况下适用默认的池大小（num_physical_cpus * 2 + 1）- 你不需要设置connection_limit参数

• ✔ 将 PrismaClient 分配给一个全局变量仅在开发环境中以防止因创建新实例而产生热重载

import { PrismaClient } from '@prisma/client'
let prisma = new PrismaClient()
export default prisma

import { PrismaClient } from '@prisma/client'

// add prisma to the NodeJS global type
interface CustomNodeJsGlobal extends NodeJS.Global {
  prisma: PrismaClient
}

// Prevent multiple instances of Prisma Client in development
declare const global: CustomNodeJsGlobal

const prisma = global.prisma || new PrismaClient()

if (process.env.NODE_ENV === 'development') global.prisma = prisma

export default prisma

连接和断开

• $connect()

• $disconnect()

CRUD 增删改查

model ExtendedProfile {
  id        Int    @id @default(autoincrement())
  biography String
  user      User   @relation(fields: [userId], references: [id])
  userId    Int
}

model User {
  id           Int              @id @default(autoincrement())
  name         String?
  email        String           @unique
  profileViews Int              @default(0)
  role         Role             @default(USER)
  coinflips    Boolean[]
  posts        Post[]
  profile      ExtendedProfile?
}

model Post {
  id         Int        @id @default(autoincrement())
  title      String
  published  Boolean    @default(true)
  author     User       @relation(fields: [authorId], references: [id])
  authorId   Int
  comments   Json?
  views      Int        @default(0)
  likes      Int        @default(0)
  categories Category[]
}

model Category {
  id    Int    @id @default(autoincrement())
  name  String @unique
  posts Post[]
}

enum Role {
  USER
  ADMIN
}

创建

const user = await prisma.user.create({
  data: {
    email: 'elsa@prisma.io',
    name: 'Elsa Prisma',
  },
})

创建多个记录

const createMany = await prisma.user.createMany({
  data: [
    { name: 'Bob', email: 'bob@prisma.io' },
    { name: 'Bobo', email: 'bob@prisma.io' }, // 唯一键重复!
    { name: 'Yewande', email: 'yewande@prisma.io' },
    { name: 'Angelique', email: 'angelique@prisma.io' },
  ],
  skipDuplicates: true, // 跳过 'Bobo'
})

读取

// 按唯一标识符
const user = await prisma.user.findUnique({
  where: {
    email: 'elsa@prisma.io',
  },
})

// 按 ID
const user = await prisma.user.findUnique({
  where: {
    id: 99,
  },
})

const users = await prisma.user.findMany()

1. 按升序 ID 排序用户（最大的优先）- 最大的 ID 是最近的 ID

2. 以升序返回第一个用户，其中至少有一个帖子有 100 个以上的赞

  const findUser = await prisma.user.findFirst({
    where: {
      posts: {
        some: {
          likes: {
            gt: 100
          }
        }
      }
    },
    orderBy: {
      id: "asc"
    }
  })
}

  const users = await prisma.user.findMany({
    where: {
      email: {
        endsWith: "prisma.io"
      }
    },
  }

const users = await prisma.user.findMany({
  where: {
    OR: [
      {
        name: {
          startsWith: 'E',
        },
      },
      {
        AND: {
          profileViews: {
            gt: 0,
          },
          role: {
            equals: 'ADMIN',
          },
        },
      },
    ],
  },
})

  const users = await prisma.user.findMany({
    where: {
      email: {
        endsWith: "prisma.io"
      },
      posts: {
        some: {
          published: false
        }
      }
    },
  }

选择字段

• Prisma schema 中定义的 所有 标量字段（包括枚举）

• 无 关系

• 使用 select  来返回特定字段 - 你还可以使用嵌套的 select 来包含关系字段

• 使用 include  来明确 包括关系

选择特定字段

// 返回一个对象或 null
const getUser: object | null = await prisma.user.findUnique({
  where: {
    id: 22,
  },
  select: {
    email: true,
    name: true,
  },
})

包括关系并选择关系字段

• 使用嵌套的 select -在 include 中使用 select

要返回 all 关系字段，请仅使用 include - 例如 { include: { posts: true } }。

const users = await prisma.user.findMany({
  select: {
    name: true,
    posts: {
      select: {
        title: true,
      },
    },
  },
})

const users = await prisma.user.findMany({
  // 返回所有用户字段
  include: {
    posts: {
      select: {
        title: true,
      },
    },
  },
})

• 包含关系 (包含所有字段)

• 选择特定关系字段

分页

偏移分页

const results = await prisma.post.findMany({
  skip: 3,
  take: 4,
})

基于游标的分页

注意：由于这是第一个查询，因此没有要传递游标。

const firstQueryResults = prisma.post.findMany({
  take: 4,
  where: {
    title: {
      contains: 'Prisma'/* 可选过滤器 */,
    },
  },
  orderBy: {
    id: 'asc',
  },
})
// 在结果集中为你的位置添加书签 - 在此
// 案例，列表 4 中最后一篇文章的 ID。
const lastPostInResults = firstQueryResults[3]// 记住：从零开始的索引！:)
const myCursor = lastPostInResults.id// 示例: 29

const secondQueryResults = prisma.post.findMany({
  take: 4,
  skip: 1,// 跳过游标
  cursor: {
    id: myCursor,
  },
  where: {
    title: {
      contains: 'Prisma'/* 可选过滤器 */,
    },
  },
  orderBy: {
    id: 'asc',
  },
})
const lastPostInResults = secondQueryResults[3]// 记住：从零开始的索引！:)
const myCursor = lastPostInResults.id// 示例: 52

嵌套写入

// 在一个事务中创建一个具有两个帖子的新用户
const newUser: User = await prisma.user.create({
  data: {
    email: 'alice@prisma.io',
    posts: {
      create: [
        { title: 'Join the Prisma Slack on https://slack.prisma.io' },
        { title: 'Follow @prisma on Twitter' },
      ],
    },
  },
})

// 在单个事务中更改帖子的作者
const updatedPost: Post = await prisma.post.update({
  where: { id: 42 },
  data: {
    author: {
      connect: { email: 'alice@prisma.io' },
    },
  },
})

内省

内省能做什么？

• 将数据库中的 表 映射到Prisma models

• 将数据库中的 列 映射到 Prisma 模型的字段

• 将数据库中的 indexes 映射到 Prisma 架构中的indexes

• 将 database constraints 映射到 Prisma 架构中的attributes或type modifiers

prisma db pull 命令

内省的工作流

1. 更改数据库架构 (例如使用纯 SQL)

2. 运行 prisma db pull 更新 Prisma 架构

3. 运行 prisma generate Prisma Client

4. 在应用程序中使用更新的 Prisma Client

npx prisma db pull

model category {
  id     Int           @id @default(autoincrement())
  name   String
  post_categories_category post_categories_category[]
}
model profile {
  id     Int     @id @default(autoincrement())
  bio    String?
  userId Int?    @unique
  user   user?   @relation(fields: [userId], references: [id])
}

model user {
  id      Int      @id @default(autoincrement())
  name    String?
  email   String   @unique
  post    post[]
  profile profile?
}

调整 Prisma schema（可选）

• 模型(Prisma model)命名遵守 PascalCase

• 字段(field)命名遵守 camelCase

model Category {
  id                Int                @id @default(autoincrement())
  name              String
  postsToCategories PostToCategories[]

  @@map("category")
}
model Profile {
  id     Int     @id @default(autoincrement())
  bio    String?
  userId Int?    @unique
  user   User?   @relation(fields: [userId], references: [id])

  @@map("profile")
}

model User {
  id      Int      @id @default(autoincrement())
  name    String?
  email   String   @unique
  posts   Post[]
  profile Profile?

  @@map("user")
}

总结

model Post {
  id    Int     @id @default(autoincrement())
  title String
  body  String
  comments Comment[]
}

model Comment {
  id     Int    @id @default(autoincrement())
  body   String
  postId Int
  post   Post   @relation(fields: [postId], references: [id])
}

const postRepository = getManager().getRepository(Post)
const publishedPosts: Post[] = await postRepository.find({
	where: { published: true },
	select: ['id', 'title'],
})

const post = publishedPosts[0]
// TypeScript编译器没有问题
if (post.content.length > 0) {
	console.log(`This post has some content.`)
}

TypeError: Cannot read property 'length' of undefined

[ERROR] 14:03:39 ⨯ Unable to compile TypeScript:
src/index.ts:36:12 - error TS2339: Property 'content' does not exist on type '{ id: number; title: string; }'.

42   if (post.content.length > 0) {

const publishedPosts: {
  id: number
  title: string
}[]