棱镜是下一代ORM,由以下工具组成:
Prisma 客户端可用于任何节点.js或 TypeScript 后端应用程序(包括无服务器应用程序和微服务)。这可以是 REST API、图形QL API、gRPC API 或需要数据库的任何其他内容。
你在寻找棱镜 1 吗?棱镜 1 存储库已重命名为
棱镜/棱镜 1
。
开始使用 Prisma 的最快方法是按照快速入门(5 分钟)操作。
本快速入门基于预配置的 SQLite 数据库。你还可以按照以下指南之一开始使用自己的数据库(后greSQL和MySQL):
本节简要概述了 Prisma 的工作原理及其最重要的技术组件。有关更全面的介绍,请访问 Prisma 文档。
每个使用 Prisma 工具包中的工具的项目都从 Prisma 架构文件开始。Prisma 架构允许开发人员使用直观的数据建模语言定义其应用程序模型。它还包含与数据库的连接并定义生成器:
// Data source
datasource db {
provider = "postgresql"
url = env("DATABASE_URL")
}
// Generator
generator client {
provider = "prisma-client-js"
}
// Data model
model Post {
id Int @id @default(autoincrement())
title String
content String?
published Boolean @default(false)
author User? @relation(fields: [authorId], references: [id])
authorId Int?
}
model User {
id Int @id @default(autoincrement())
email String @unique
name String?
posts Post[]
}
在此架构中,你配置了三项内容:
在此页面上,重点是数据模型。你可以在相应的文档页面上了解有关数据源和生成器的更多信息。
数据模型是模型的集合。模型有两个主要功能:
有两种主要工作流可用于将数据模型“获取”到 Prisma 架构中:
定义数据模型后,你可以生成 Prisma 客户端,该客户端将公开已定义模型的 CRUD 和更多查询。如果使用 TypeScript,则将获得所有查询的完全类型安全性(即使仅检索模型字段的子集)。
使用Prisma客户端时的第一步是安装其npm包:
npm install @prisma/client
请注意,此软件包的安装将调用读取 Prisma 架构并生成 Prisma 客户端代码的命令。代码将位于 中,该代码由 导出。
prisma generate
node_modules/.prisma/client
node_modules/@prisma/client/index.d.ts
更改数据模型后,需要手动重新生成 Prisma 客户端,以确保其中的代码得到更新:
node_modules/.prisma/client
npx prisma generate
有关“生成 Prisma 客户端”的更多信息,请参阅文档。
生成 Prisma 客户端后,可以将其导入代码并将查询发送到数据库。这是设置代码的外观。
你可以按如下方式导入和实例化 Prisma 客户端:
import { PrismaClient } from '@prisma/client'
const prisma = new PrismaClient()
或
const { PrismaClient } = require('@prisma/client')
const prisma = new PrismaClient()
现在,你可以通过生成的 Prisma 客户端 API 开始发送查询,下面是几个示例查询。请注意,所有 Prisma 客户端查询都返回普通的旧 JavaScript 对象。
在 Prisma 客户端文档中了解有关可用操作的更多信息,或观看此演示视频(2 分钟)。
User
// Run inside `async` function
const allUsers = await prisma.user.findMany()
posts
User
// Run inside `async` function
const allUsers = await prisma.user.findMany({
include: { posts: true },
})
Post
"prisma"
// Run inside `async` function
const filteredPosts = await prisma.post.findMany({
where: {
OR: [{ title: { contains: 'prisma' } }, { content: { contains: 'prisma' } }],
},
})
User
Post
// Run inside `async` function
const user = await prisma.user.create({
data: {
name: 'Alice',
email: 'alice@prisma.io',
posts: {
create: { title: 'Join us for Prisma Day 2021' },
},
},
})
Post
// Run inside `async` function
const post = await prisma.post.update({
where: { id: 42 },
data: { published: true },
})
请注意,使用 TypeScript 时,此查询的结果将静态类型化,以便你不会意外访问不存在的属性(并且在编译时会捕获任何拼写错误)。有关利用 Prisma Client 的生成类型的更多信息,请参阅文档中的生成类型的高级用法页面。
Prisma拥有一个由热情的应用程序开发人员组成的庞大且支持性的社区。你可以在 Slack 上加入我们,也可以在 GitHub 上加入我们。
如果你有安全问题要报告,请通过 security@prisma.io 与我们联系。
你可以在 GitHub 上的存储库中提出问题并发起有关 Prisma 相关主题的讨论。
prisma
如果你看到错误消息或遇到问题,请务必创建错误报告!你可以在文档中找到创建错误报告的最佳实践(例如包括其他调试输出)。
如果Prisma目前没有特定的功能,请务必查看路线图,看看这是否已经计划在未来使用。
如果路线图上的功能与 GitHub 问题相关联,请确保在问题上留下 +1,最好是评论你对该功能的想法!