Zenn
👓

Prisma Studio - 概要

2025/02/14に公開

はじめに

Prisma Studio は、Prisma ORM で使用するデータベースのデータを視覚的に表示・編集するための GUI ツールです。開発中やデバッグ時に、データベースの中身を直接確認したり、手動でデータを変更したりする際に非常に役立ちます。

Prisma Studio でできること

Prisma Studio を使うと、主に以下のことが可能になります。

  • データの閲覧: データベースのテーブル構造と、格納されているデータをテーブル形式で閲覧できます。
  • データの追加: 新しいレコードをGUIから追加できます。
  • データの編集: 既存のレコードの値をGUIから変更できます。
  • データの削除: レコードをGUIから削除できます。
  • リレーションの確認: テーブル間のリレーション(関連)を持つレコードを簡単に辿れます。
  • データのフィルタリング・ソート: 特定のカラムの値でのフィルタリングや、特定のカラムでのソート、表示するカラムの選択など、簡単なデータ操作ができます。

Prisma Studio の起動方法

Prisma Studio は、CLIを通じて起動します。ターミナルやコマンドプロンプトで、プロジェクトのディレクトリ内で以下のコマンドを実行します。

npx prisma studio

このコマンドを実行すると、デフォルトでは http://localhost:5555 で Prisma Studio が起動し、Webブラウザでアクセスできるようになります。

Prisma Studio の基本的な使い方

Prisma Studio の画面は、主に以下の3つの部分から構成されています。

  1. モデルリスト: 左側のサイドバーには、schema.prisma で定義されたモデル(テーブル)の一覧が表示されます。
  2. データビュー: 中央のメインエリアには、選択したモデルのデータが表形式で表示されます。
  3. レコードエディタ: データビューでレコードを選択すると、右側にレコードエディタが表示され、個々のレコードの値を編集できます。

基本的な操作

  • モデルの選択: サイドバーでモデルをクリックすると、そのモデルのデータがデータビューに表示されます。
  • レコードの追加: データビューの上部にある「+ Add record」ボタンをクリックすると、新しいレコードを追加できます。
  • レコードの編集: データビューでレコードをクリックすると、右側のレコードエディタで値を編集できます。編集後、「Save changes」ボタンをクリックして変更を保存します。
  • レコードの削除: データビューでレコードを選択し、レコードエディタの下部にある「Delete」ボタンをクリックすると、レコードを削除できます。
  • データの検索・フィルタリング: データビューの上部にある検索バーやフィルター機能を使って、特定の条件に合致するデータを絞り込むことができます。

注意点

  • Prisma Studioは、schema.prismaで定義された型情報を元に、GUIでの表示や入力を支援します。入力された値がschema.prismaで定義された型に合致しているかをある程度チェックしてくれますが、複雑なバリデーションルール(例えば、特定の文字列パターンに合致するか、など)まではチェックできません。入力値のバリデーションは、アプリケーション側でしっかりと行う必要があります。

まとめ

Prisma Studio は、Prisma を使った開発を効率化するための便利なツールです。データベースのデータを視覚的に確認・編集できるため、開発中やデバッグ時に大いに役立ちます。開発ツールとして活用するようにしましょう。

参照

https://www.prisma.io/studio

Discussion

ログインするとコメントできます