リレーショナルデータベース(TypeScriptと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
次に、TypeScriptプロジェクトを初期化し、Prisma CLIを開発依存関係として追加します。
npm init -y
npm install prisma typescript tsx @types/node --save-dev
これにより、TypeScriptアプリの初期設定を含むpackage.json
が作成されます。
次に、TypeScriptを初期化します。
npx tsc --init
別のパッケージマネージャーを使用してPrismaをインストールする方法については、インストール手順を参照してください。
これで、npx
をプレフィックスとして付けてPrisma CLIを呼び出すことができます。
npx prisma
次に、以下のコマンドを使用してPrisma Schemaファイルを作成し、Prisma ORMプロジェクトをセットアップします。
npx prisma init --datasource-provider cockroachdb --output ../generated/prisma
このコマンドはいくつかの処理を実行します
prisma
という新しいディレクトリを作成し、その中にschema.prisma
というファイルが作成されます。このファイルには、データベース接続変数とスキーマモデルを含むPrisma Schemaが含まれます。datasource
を以下に設定しますCockroachDBおよび出力をそれぞれカスタムロケーションに設定します。- プロジェクトのルートディレクトリに
.env
ファイルを作成します。これは環境変数(データベース接続など)を定義するために使用されます。
prisma init
によって作成されるデフォルトのスキーマでは、provider
としてPostgreSQLが使用されることに注意してください。datasource-provider
オプションでプロバイダーを指定しなかった場合は、datasource
ブロックを編集して代わりにcockroachdb
プロバイダーを使用する必要があります。
datasource db {
provider = "cockroachdb"
url = env("DATABASE_URL")
}