跳到主要内容

Prisma Studio

Prisma Studio 是您数据库中数据的可视化编辑器。请注意,Prisma Studio 不是开源的,但您仍然可以在 prisma/studio 仓库中创建议题。

在您的终端中运行 npx prisma studio

模型(表或集合)

当您首次打开 Prisma Studio 时,您将看到一个数据表布局,侧边栏显示了您的 Prisma schema 文件中定义的所有模型的列表。

Prisma Studio - Models view

信息

什么是模型?

术语模型指的是您添加到 Prisma schema 文件中的数据模型定义。根据您使用的数据库,模型定义(例如 model User)指的是关系数据库(PostgreSQL, MySQL, SQL Server, SQLite, CockroachDB)中的或 MongoDB 中的集合

更多信息请参阅 定义模型

您可以选择一个模型,其数据将在新标签页中打开。在此示例中,选中了 User 模型。

Prisma Studio - Models view with model open

打开和关闭模型

要打开另一个模型,请在侧边栏中找到该模型并点击它。

要关闭一个模型,请点击模型标签页中的 X 按钮。如果打开了多个模型,您也可以点击“关闭所有”来关闭所有模型。

Prisma Studio - Open and close models

模型中数据类型的图标

每个字段的数据类型在表头中通过图标表示。

下表列出了所有数据类型及其标识图标。

字段数据类型描述
文本
整数
日期时间

布尔值
预定义值列表(enum 数据类型)
来自另一个模型的关联记录列表
{} 符号可以指代以下两种字段类型之一。

• 关联字段
• JSON 字段

模型中的键盘快捷键

当您打开一个模型时,可以使用许多键盘快捷键来浏览和操作模型中的数据。

信息

注意

打开 Prisma Studio 后,您可以通过在 macOS 上按 Cmd ⌘+/ 或在 Windows 上按 Ctrl+/ 来打开键盘快捷键模态框。

Prisma Studio - Keyboard shortcuts

编辑数据

Prisma Studio 提供了两种编辑现有数据的机制:内联编辑侧面板编辑

内联编辑

要进行内联编辑,双击单元格进入编辑模式。这将把您的光标置于单元格中,允许您编辑数据。数据可以在单元格之间复制和粘贴。

所有更改(添加、编辑或删除)必须先确认后才会生效。使用保存更改按钮确认添加和编辑的记录。当您选择记录并点击删除记录时,在对话框中确认删除。

您可以累积多个添加的记录和编辑的单元格,然后使用保存更改按钮最终确定它们。

Prisma Studio - Save inline changes 完成数据编辑后,点击绿色的保存按钮。

Prisma Studio - Save inline changes

批量编辑

可以同时编辑多个记录。双击任意单元格编辑值,根据需要移动到其他单元格。完成后,点击绿色的保存按钮。

Prisma Studio - Save multiple inline changes

侧面板编辑

Prisma Studio 还提供侧面板用于编辑数据。要打开侧面板,请点击位于每个可见记录最左侧的选择复选框旁边的编辑侧面板图标。

Prisma Studio - Open side panel

点击该图标将在右侧打开侧面板,您可以在其中进行编辑。完成后,点击侧面板外部,然后点击绿色的保存按钮来保存更改。

Prisma Studio - Edit side panel

删除记录

  1. 在左侧列中,勾选您要删除的记录旁边的复选框。
  2. 点击删除 n 条记录
  3. 在确认对话框中点击删除

您可以使用删除记录按钮选择并一次性删除多个记录。当您删除多个记录时,操作会立即完成(在您确认后)。

此外,如果您有任何累积的添加或编辑记录,然后决定删除记录,删除操作也会强制保存累积的编辑。

警告

警告

删除记录是一个独立的操作,无法累积。如果您在有未保存编辑的情况下删除记录,删除操作会首先强制保存未保存的编辑,然后完成。

Prisma Studio - Delete records

您可以使用放弃更改按钮放弃任何累积的更改。

Prisma Studio - Discard changes

复制和粘贴

您可以使用以下快捷键复制任意表格单元格的值

  • Cmd ⌘ + C   (macOS)
  • Ctrl + C     (Windows)

要在另一个单元格中粘贴,首先双击单元格进入编辑模式,然后使用

  • Cmd ⌘ + V   (macOS)
  • Ctrl + V     (Windows)

添加记录

  1. 在模型视图中,点击添加记录

  2. 根据每个字段允许的数据类型,输入记录的数据。

    字段数据类型描述
    文本
    整数

    如果此类字段已预填充 autoincrement(),请勿编辑该单元格,也勿手动添加数字。
    日期时间

    日期时间字段包含一个由数字、字母等组成的很长的字符串。最佳实践是复制另一个日期时间单元格的值,根据需要修改,然后粘贴到该字段中。
    布尔值

    选择 truefalse
    预定义列表

    双击该字段中的单元格,然后选择一个预定义选项。
    来自另一个模型的关联记录列表

    它通常指代数据库中另一个模型中存在的记录列表。如果您正在添加新记录,且关联模型中的记录尚不存在,则无需在当前模型中输入任何内容。
    {} 符号可以指代以下两种字段类型之一。

    • 关联字段
    • JSON 字段

    与数据库中独立定义的模型关联

    通常,您需要选择与之前任何记录相同的值
    点击模型的名称以查看值列表,然后您可以为关联字段选择这些值。

    JSON 字段

    双击字段编辑 JSON 数据。最佳实践是在验证器中验证编辑后的 JSON 数据,然后将其粘贴回单元格中。
  3. (可选)如果您对更改不满意,请点击放弃更改并重新开始。

  4. 点击保存 1 项更改

过滤器

过滤数据

使用过滤器菜单通过添加条件来过滤模型中的数据。

过滤器菜单中,您添加的第一个条件是 where 子句。

当您添加多个条件时,Prisma Studio 会过滤结果,使所有条件组合应用。每个新条件都通过前面的 and 操作符来表示这一点。

步骤

  1. 点击过滤器打开过滤器菜单。

    信息

    注意
    如果您想隐藏菜单,再次点击过滤器

  2. 点击添加新过滤器

  3. 配置条件。

    1. 选择您要过滤的字段。
    2. 选择一个比较操作符。
      • 等于
      • 在...中
      • 不在...中
      • 小于
      • 小于等于
      • 大于
      • 大于等于
      • 不等于
    3. 输入您想用于条件的值。
      步骤结果Prisma Studio 会立即根据条件更新模型中的数据。
  4. 要添加新过滤器,点击添加新过滤器并重复上述步骤。

  5. 要移除过滤器,点击右侧的 x 按钮。 Prisma Studio - Add and remove filters

  6. 要移除所有过滤器,点击清除所有

结果

  • 模型中的数据将根据您添加的所有条件的组合进行过滤。
  • 过滤器菜单中,默认值“无”会改变,显示您添加的过滤器数量。

显示和隐藏字段

您可以使用字段菜单选择要查看或隐藏的字段。

信息

什么是字段?

字段是您在 Prisma schema 文件的数据模型定义中添加的模型属性。根据您使用的数据库,字段(例如 model User { title String } 中的 title 字段)指的是关系数据库(PostgreSQL, MySQL, SQL Server, SQLite, CockroachDB)中的或 MongoDB 中的文档字段
更多信息请参阅 定义字段

步骤

  1. 点击字段菜单。
  2. 仅选择您想看到的字段,并取消选择任何您想隐藏的字段。 Prisma Studio - Show and hide fields

结果

模型会立即过滤,隐藏您取消选择的任何字段的数据。

此外,字段菜单显示当前选中的字段数量。

显示和隐藏记录

您还可以选择在模型视图中显示或跳过特定数量的记录。

信息

什么是记录?

记录指的是关系数据库(PostgreSQL, MySQL, SQL Server, SQLite, CockroachDB)中表中的一行数据或 MongoDB 中的文档

步骤

  1. 点击显示菜单。
  2. 获取 (Take) 框中,指定您希望模型视图显示的最大记录数量。
  3. 跳过 (Skip) 框中,指定您想跳过(隐藏)前多少条记录。 Prisma Studio - Show and hide records

结果

模型会立即根据您的选择过滤显示或隐藏记录。

显示菜单指示模型中显示的记录数量占可用记录总数的比例。

排序数据

点击字段标题以根据字段数据排序。

第一次点击按升序排序数据,第二次点击按降序排序。

Prisma Studio - Sort data

故障排除

终端:执行脚本失败 / Prisma Client 请求出错

缓存问题可能导致 Prisma Studio 使用旧版本的查询引擎。您可能会看到以下错误

Error in request:  PrismaClientKnownRequestError: Failed to validate the query Error occurred during query validation & transformation

要解决此问题,请删除以下文件夹

  • macOS 和 Linux 上的 ~/.cache/prisma
  • Windows 上的 %AppData%/Prisma/Studio