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