主要コンテンツへスキップ

リレーショナルデータベース(TypeScriptとCockroachDB)

Prisma ORMをデータベースに接続し、データベースアクセス用のPrisma Clientを生成することで、Node.jsまたはTypeScriptプロジェクトをゼロから作成する方法を学びます。以下のチュートリアルでは、Prisma CLIPrisma 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プロバイダーを使用する必要があります。

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