リレーショナルデータベース
データベースに接続し、データベースアクセス用の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 Schemaファイルを作成して、Prisma ORMプロジェクトをセットアップします。
npx prisma init --datasource-provider cockroachdb --output ../generated/prisma
このコマンドはいくつかのことを行います。
- prisma という名前の新しいディレクトリを作成します。このディレクトリには schema.prisma というファイルが含まれており、これにはデータベース接続変数とスキーマモデルを含む Prisma Schema が含まれています。
- データソースを以下に設定します。CockroachDBそして、出力をそれぞれカスタムの場所に設定します。
- プロジェクトのルートディレクトリに .env ファイルを作成します。これは、環境変数（データベース接続など）を定義するために使用されます。
gitなどのバージョン管理を使用している場合は、生成されたクライアントをアプリケーションから除外するために、.gitignore に行を追加することをお勧めします。この例では、generated/prisma ディレクトリを除外します。
generated/prisma/
prisma init で作成されるデフォルトのスキーマは、プロバイダーとして PostgreSQL を使用していることに注意してください。datasource-provider オプションでプロバイダーを指定しなかった場合は、代わりに cockroachdb プロバイダーを使用するようにデータソースブロックを編集する必要があります。
datasource db {
provider = "cockroachdb"
url = env("DATABASE_URL")
}