メインコンテンツへスキップ

リレーショナルデータベース

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 をインストールする方法については、インストール手順を参照してください。

Prisma CLI を npx をプレフィックスとして付けることで呼び出すことができます

npx prisma

次に、次のコマンドで Prisma Schema ファイルを作成して、Prisma ORM プロジェクトをセットアップします

npx prisma init --datasource-provider cockroachdb --output ../generated/prisma

このコマンドはいくつかのことを行います

  • prisma という名前の新しいディレクトリを作成します。このディレクトリには schema.prisma というファイルが含まれており、データベース接続変数とスキーマモデルを含む Prisma Schema が含まれています。
  • データソースを以下に設定しますCockroachDBそして、出力をそれぞれカスタムロケーションに設定します。
  • プロジェクトのルートディレクトリに .env ファイル を作成します。これは、環境変数（データベース接続など）を定義するために使用されます。
バージョン管理を使用していますか？

git のようなバージョン管理を使用している場合は、生成されたクライアントをアプリケーションから除外するために、.gitignore に行を追加することをお勧めします。この例では、generated/prisma ディレクトリを除外します。

.gitignore
generated/prisma/

prisma init で作成されたデフォルトのスキーマは、プロバイダーとして PostgreSQL を使用していることに注意してください。datasource-provider オプションでプロバイダーを指定しなかった場合は、datasource ブロックを編集して代わりに cockroachdb プロバイダーを使用する必要があります。

prisma/schema.prisma
datasource db {
  provider = "cockroachdb"
  url      = env("DATABASE_URL")
}