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

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

Prisma ORMをデータベースに接続し、データベースアクセス用のPrisma Clientを生成することにより、Node.jsまたはTypeScriptの新しいプロジェクトをスクラッチから作成する方法を学びます。次のチュートリアルでは、Prisma CLIPrisma Client、およびPrisma Migrateを紹介します。

前提条件

このガイドを正常に完了するには、以下が必要です。

  • Node.js がマシンにインストールされていること(公式にサポートされているバージョンについては、システム要件を参照してください)
  • PostgreSQL データベースサーバーが実行されていること

正確なバージョンの要件については、システム要件を参照してください。

データベースの接続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スキーマファイルを作成して、Prisma ORMプロジェクトをセットアップします。

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

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

  • データベース接続変数とスキーマモデルを含むPrismaスキーマを含むschema.prismaというファイルを含むprismaという新しいディレクトリを作成します。
  • datasourceを以下に設定します。PostgreSQLおよび出力先をそれぞれカスタムロケーションに設定します。
  • 環境変数(データベース接続など)を定義するために使用されるプロジェクトのルートディレクトリに.envファイルを作成します。
バージョン管理を使用していますか?

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

.gitignore
generated/prisma/

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

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