リレーショナルデータベース
データベースに接続し、データベースアクセス用のPrisma Clientを生成することにより、既存のNode.jsまたはTypeScriptプロジェクトにPrisma ORMを追加する方法を学びます。次のチュートリアルでは、Prisma CLI、Prisma Client、およびPrisma Introspectionを紹介します。
別のORMからPrisma ORMに移行する場合は、TypeORMからの移行またはSequelizeからの移行ガイドをご覧ください。
前提条件
このガイドを正常に完了するには、以下が必要です。
package.jsonを含む既存のNode.jsプロジェクト- Node.jsがマシンにインストールされていること（公式にサポートされているバージョンについては、システム要件を参照してください）
- CockroachDBデータベースサーバーが実行中で、少なくとも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スキーマファイルを作成して、Prisma ORMプロジェクトをセットアップします。
npx prisma init --datasource-provider cockroachdb --output ../generated/prisma
このコマンドはいくつかのことを行います。
- データベース接続変数とスキーマモデルを含むPrismaスキーマを含む
schema.prismaというファイルを含むprismaという新しいディレクトリを作成します。 datasourceを以下に設定します。CockroachDBそして、それぞれカスタムの場所にアウトプットを設定します。- プロジェクトのルートディレクトリに
.envファイルを作成します。これは、環境変数（データベース接続など）を定義するために使用されます。
gitなどのバージョン管理を使用している場合は、生成されたクライアントをアプリケーションから除外するために、.gitignoreに1行追加することをお勧めします。この例では、generated/prismaディレクトリを除外します。
generated/prisma/
prisma initによって作成されたデフォルトのスキーマは、providerとしてPostgreSQLを使用していることに注意してください。datasource-providerオプションでプロバイダーを指定しなかった場合は、datasourceブロックを編集して代わりにcockroachdbプロバイダーを使用する必要があります。
datasource db {
provider = "cockroachdb"
url = env("DATABASE_URL")
}