リレーショナルデータベース (JavaScriptとCockroachDB)
Prisma ORMをデータベースに接続し、データベースアクセス用のPrisma Clientを生成することで、Node.jsまたはTypeScriptプロジェクトをゼロから作成する方法を学びます。このチュートリアルでは、Prisma CLI、Prisma Client、およびPrisma Migrateを紹介します。
前提条件
このガイドを正常に完了するには、以下が必要です。
- Node.jsをマシンにインストールしていること(公式にサポートされているバージョンについてはシステム要件を参照)
- CockroachDBデータベースサーバーが稼働していること
正確なバージョン要件については、システム要件を参照してください。
データベースの接続URLを手元に用意してください。データベースサーバーが稼働しておらず、Prisma ORMを試したいだけであれば、クイックスタートを確認してください。
プロジェクトセットアップを作成する
最初のステップとして、プロジェクトディレクトリを作成し、その中に移動します。
mkdir hello-prisma
cd hello-prisma
次に、Node.jsプロジェクトを初期化し、Prisma CLIを開発依存関係として追加します。
npm init -y
npm install prisma --save-dev
これにより、Node.jsアプリケーションの初期セットアップを含むpackage.json
が作成されます。
これで、npx
を前置してPrisma CLIを呼び出すことができます。
npx prisma
次に、以下のコマンドでPrisma Schemaファイルを作成して、Prisma ORMプロジェクトを設定します。
npx prisma init --datasource-provider postgresql --output ../generated/prisma
このコマンドはいくつかのことを行います。
prisma
という新しいディレクトリを作成し、その中にschema.prisma
というファイルが作成されます。このファイルには、データベース接続変数とスキーマモデルを含むPrisma Schemaが含まれています。datasource
を以下に設定します。PostgreSQLおよび出力をカスタムの場所に、それぞれ設定します。- プロジェクトのルートディレクトリに
.env
ファイルを作成します。これは環境変数(データベース接続など)を定義するために使用されます。
prisma init
によって作成されるデフォルトのスキーマは、provider
としてPostgreSQLを使用することに注意してください。datasource-provider
オプションでプロバイダを指定しなかった場合、datasource
ブロックを編集してpostgresql
プロバイダを使用するように変更する必要があります。
prisma/schema.prisma
datasource db {
provider = "postgresql"
url = env("DATABASE_URL")
}