跳到主要内容

快速入门

Prisma Postgres

在本快速入门指南中，您将学习如何在纯 TypeScript 项目中从头开始使用 Prisma ORM 和 Prisma Postgres 数据库。它涵盖以下工作流程

前提条件​

要成功完成本教程，您需要

  • 一个(PDP) 账户
  • 您的机器上安装了 Node.js （请参阅系统要求查看官方支持的版本）

1. 在 Platform 控制台中设置 Prisma Postgres 数据库​

按照以下步骤创建您的 Prisma Postgres 数据库

  1. 登录到并打开控制台。
  2. 在您选择的工作区中，点击 New project（新建项目）按钮。
  3. 在 Name（名称）字段中输入项目名称，例如 hello-ppg。
  4. 在 Prisma Postgres 部分，点击 Get started（入门）按钮。
  5. 在 Region（区域）下拉菜单中，选择离您当前位置最近的区域，例如 US East (N. Virginia)（美国东部（弗吉尼亚州北部））。
  6. 点击 Create project（创建项目）按钮。

此时，您将被重定向到 Database（数据库）页面，您需要等待几秒钟，直到数据库的状态从 PROVISIONING（正在配置）变为 CONNECTED（已连接）。

一旦出现绿色的 CONNECTED（已连接）标签，您的数据库就可以使用了！

2. 下载示例并安装依赖项​

复制控制台中显示的 try-prisma 命令，将其粘贴到终端中并执行。

作为参考，命令如下所示

npx try-prisma@latest \
  --template databases/prisma-postgres \
  --name hello-prisma \
  --install npm

try-prisma 命令执行完毕后，导航到项目目录

cd hello-prisma

3. 设置数据库连接 URL​

您的数据库连接是通过 .env 文件中的环境变量配置的。

首先，将现有的 .env.example 文件重命名为 .env

mv .env.example .env

然后，在 Platform 控制台的项目环境中，在 Set up database access（设置数据库访问）部分找到您的数据库凭据，复制 DATABASE_URL 环境变量并将其粘贴到 .env 文件中。

作为参考，文件现在应该类似于这样

DATABASE_URL="prisma+postgres://accelerate.prisma-data.net/?api_key=ey...."

4. 创建数据库表（使用模式迁移）​

接下来，您需要在数据库中创建表。您可以通过使用 Prisma CLI 的以下命令创建并执行模式迁移来完成此操作

npx prisma migrate dev --name init

这会将您的Prisma 模式中定义的 User 和 Post 模型映射到您的数据库。您还可以查看已执行并在新创建的 prisma/migrations 目录中创建表的 SQL 迁移。

5. 使用 Prisma ORM 执行查询​

src/queries.ts 脚本包含一些 CRUD 查询，用于在您的数据库中写入和读取数据。您可以通过在终端中运行以下命令来执行它

npm run queries

脚本完成后，您可以检查终端中的日志或使用 Prisma Studio 探索数据库中创建了哪些记录

npx prisma studio

6. 使用 Prisma Accelerate 探索缓存​

src/caching.ts 脚本包含一个示例查询，它使用Stale-While-Revalidate (SWR) 和Time-To-Live (TTL) 来使用 Prisma Accelerate 缓存数据库查询。您可以如下执行它

npm run caching

记下执行查询所需的时间，例如

The query took 2009.2467149999998ms.

现在，再次运行该脚本

npm run caching

您会注意到这次查询所需的时间会短得多，例如

The query took 300.5655280000001ms.

7. 后续步骤​

在本快速入门指南中，您学习了如何在纯 TypeScript 项目中开始使用 Prisma ORM。您可以自由地自行探索 Prisma Client API，例如在 findMany 查询中加入过滤、排序和分页选项，或者探索更多操作，例如 update 和 delete 查询。

在 Prisma Studio 中探索数据​

Prisma ORM 附带一个内置的 GUI，用于查看和编辑数据库中的数据。您可以使用以下命令打开它

npx prisma studio

使用 Prisma Postgres，您还可以直接在中通过选择您项目中的 Studio 选项卡来使用 Prisma Studio。

使用 Next.js 构建全栈应用​

了解如何在全栈应用中使用 Prisma Postgres

探索现成的 Prisma ORM 示例​

查看 GitHub 上的 prisma-examples 仓库，了解如何将 Prisma ORM 与您喜欢的库一起使用。该仓库包含 Express、NestJS、GraphQL 的示例，以及 Next.js 和 Vue.js 的全栈示例等等。

这些示例默认使用 SQLite，但您可以按照项目 README 中的说明，通过几个简单的步骤切换到 Prisma Postgres。


与 Prisma 保持联系

通过以下方式连接，继续您的 Prisma 之旅 我们的活跃社区。随时了解最新信息，参与其中，并与其他开发者协作

我们非常珍视您的参与，并期待您成为我们社区的一员！