既存のJavaScriptプロジェクトにPrisma ORMを追加 (MySQL)

JavaScript

MySQL

データベースに接続し、データベースアクセスのためのPrisma Clientを生成することで、既存のNode.jsまたはTypeScriptプロジェクトにPrisma ORMを追加する方法を学びましょう。このチュートリアルでは、Prisma CLI、Prisma Client、およびPrisma Introspectionを紹介します。

ヒント

他のORMからPrisma ORMに移行する場合は、TypeORMからの移行またはSequelizeからの移行ガイドを参照してください。

前提条件

このガイドを正常に完了するには、以下が必要です。

• package.jsonを持つ既存のNode.jsプロジェクト
• お使いのマシンにNode.jsがインストールされていること（公式サポートバージョンについてはシステム要件を参照）
• 実行中のMySQLデータベースサーバーと、少なくとも1つのテーブルを持つデータベース

正確なバージョン要件については、システム要件を参照してください。

データベースの接続URL（認証情報を含む）を手元に用意しておいてください。データベースサーバーが実行されておらず、Prisma ORMを試してみたいだけであれば、クイックスタートをご覧ください。

Prisma ORMのセットアップ

まず、package.jsonファイルがあるプロジェクトディレクトリに移動します。

次に、Prisma CLIを開発依存としてプロジェクトに追加します。

npm install prisma --save-dev

注

プロジェクトに複数のpackage.jsonファイルを含むディレクトリ（例：frontend、backendなど）がある場合、Prisma ORMは特にAPI/バックエンド層での使用のために設計されていることに注意してください。Prismaをセットアップするには、関連するpackage.jsonファイルを含む適切なバックエンドディレクトリに移動し、そこでPrismaを設定してください。

これで、npxを接頭辞として付けてPrisma CLIを呼び出すことができます。

npx prisma

情報

別のパッケージマネージャーを使用してPrisma ORMをインストールする方法については、インストール手順を参照してください。

次に、以下のコマンドを使用してPrisma Schemaファイルを作成し、Prisma ORMプロジェクトをセットアップします。

npx prisma init --datasource-provider mysql --output ../generated/prisma

このコマンドはいくつかのことを行います。

• prismaという新しいディレクトリを作成し、その中にschema.prismaというファイルが作成され、データベース接続変数とスキーマモデルを含むPrisma Schemaが格納されます。
• datasourceを以下に設定します。MySQLおよび出力をそれぞれカスタムの場所に設定します。
• プロジェクトのルートディレクトリに.envファイルを作成します。これは環境変数（データベース接続など）を定義するために使用されます。

prisma initで作成されるデフォルトのスキーマは、providerとしてPostgreSQLを使用していることに注意してください。datasource-providerオプションでプロバイダーを指定しなかった場合は、代わりにmysqlプロバイダーを使用するようにdatasourceブロックを編集する必要があります。

prisma/schema.prisma

datasource db {
  provider = "mysql"
  url      = env("DATABASE_URL")
}