Prisma CLIについて📝

Prisma CLI チートシート📝

https://v1.prisma.io/docs/1.34/prisma-cli-and-configuration/using-the-prisma-cli-alx4/

Prisma Migration (Dev 環境)

npx prisma migrate dev --name init

Server 側の Prisma Client を生成する。

npx prisma generate

# データベースマイグレーションの作成
prisma migrate dev --name <migration-name>

# データベースリセット（開発環境のみ）
prisma migrate reset

# Prisma Studioの起動（データベースのGUI管理ツール）
prisma studio

PrismaのMigrationコマンド📝

PrismaのMigrationコマンドについて説明します。
Prismaでは、データベーススキーマの管理とマイグレーションに以下の主要なコマンドを使用します（Prisma CLI経由で実行）：

1. マイグレーションの作成
   prisma migrate dev

   • 開発環境で使用され、schema.prismaファイルに基づいてマイグレーションファイルを生成し、データベースに適用します。
   • 例: npx prisma migrate dev --name init（--nameでマイグレーション名を指定）

2. マイグレーションの適用
   prisma migrate deploy

   • 本番環境で使用され、既存のマイグレーションファイルをデータベースに適用します。
   • 例: npx prisma migrate deploy

3. マイグレーションのリセット
   prisma migrate reset

   • 開発環境でデータベースをリセットし、マイグレーションを最初から再適用します（データが削除されるので注意）。
   • 例: npx prisma migrate reset

4. マイグレーションの状態確認
   prisma migrate status

   • マイグレーションの適用状況を確認します。
   • 例: npx prisma migrate status

5. マイグレーションファイルの生成（適用せずに）
   prisma migrate diff

   • スキーマとデータベースの差分を確認したり、マイグレーションファイルを生成したりします。
   • 例: npx prisma migrate diff --from-schema-datamodel schema.prisma --to-database

注意点:

• コマンドを実行する前に、schema.prismaファイルが正しく設定されていることを確認してください。
• npxを使用する場合、Prisma CLIがプロジェクトにインストールされている必要があります（npm install prisma --save-devでインストール可能）。

具体的な状況やエラーがあれば教えてください。より詳しくサポートします！

npx prisma generateとは？

npx prisma generate は、Prisma CLI（コマンドラインインターフェース）で使用されるコマンドで、Prismaスキーマファイル（通常は schema.prisma）に基づいて、Prisma Clientを生成するものです。

具体的には、npx prisma generate を実行すると、以下のようなことが行われます：

1. schema.prisma の解析: Prismaがスキーマファイルを読んで、データベースのモデル（テーブルやリレーション）を理解します。
2. Prisma Clientの生成: スキーマに基づいて、型安全なデータベースクエリを実行できるJavaScript/TypeScript用のクライアントコードを生成します。この生成されたコードは通常、node_modules/@prisma/client に保存されます。
3. 型定義の提供: TypeScriptを使用している場合、生成されたクライアントには型定義が含まれるため、開発中に型エラーを防ぎやすくなります。

使用例

例えば、schema.prisma に以下のようなモデルが定義されているとします：

model User {
  id    Int     @id @default(autoincrement())
  name  String
  email String  @unique
}

npx prisma generate を実行すると、Prisma Clientが生成され、次のようにコードで使用できます：

import { PrismaClient } from '@prisma/client';

const prisma = new PrismaClient();

async function main() {
  const users = await prisma.user.findMany();
  console.log(users);
}

main();

注意点

• npx prisma generate はスキーマからクライアントを生成するだけで、データベース自体の構造を変更（マイグレーション）するものではありません。
• マイグレーションには npx prisma migrate 系のコマンドを使います。
• npx はNode.jsのパッケージランナーで、Prisma CLIがローカルにインストールされていなくても実行できます。ただし、プロジェクトにPrismaが設定されている必要があります。

npx prisma migrate dev をした後に npx prisma generateする📝

それぞれのコマンドの役割

1. npx prisma migrate dev --name init

   • このコマンドは、Prismaスキーマ（schema.prisma）に基づいてデータベースにマイグレーションを適用します。つまり、データベースのテーブルやリレーションを作成・更新します。
   • --name init はマイグレーションに名前をつけるもので、例えば初回のセットアップを表す「init」という名前になります。
   • このコマンドはデータベースの構造を変更しますが、Prisma Client（アプリケーション側で使うコード）は更新されません。

2. npx prisma generate

   • このコマンドは、更新された schema.prisma（またはマイグレーション後のスキーマ）に基づいて、Prisma Clientを生成します。
   • 生成されたクライアントは、データベースの最新の構造に合わせた型安全なクエリを提供します。

なぜ両方必要か？

• npx prisma migrate dev はデータベース側を更新するだけなので、アプリケーション側（Prisma Client）がその変更を反映するには npx prisma generate が必要です。
• たとえば、新しいモデルを追加したり、既存のフィールドを変更したりした場合、マイグレーション後に prisma generate をしないと、コード内で古いPrisma Clientを使ってしまい、型エラーや実行時エラーが発生する可能性があります。

実行の流れ

通常、以下のような手順になります：

1. schema.prisma を編集（モデル追加や変更など）。
2. npx prisma migrate dev --name <migration-name> を実行してデータベースに変更を適用。
3. npx prisma generate を実行してPrisma Clientを更新。
4. アプリケーションコードを書き、最新のPrisma Clientを使用。

例外

もし prisma generate を忘れても、開発中にエディタやビルド時に型エラーが出ることで気づくことが多いです。ただし、ベストプラクティスとしては、マイグレーション後に必ず prisma generate を実行することを習慣づけるのがおすすめです。

結論：npx prisma migrate dev --name init の後に npx prisma generate を実行するべきです。これでデータベースとアプリケーションが同期した状態で開発を進められます！