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

MongoDB

TypeScript
MongoDB

Prisma ORM を MongoDB データベースに接続し、データベースアクセス用の Prisma Client を生成して、Node.js または TypeScript の新しいプロジェクトを最初から作成する方法を学びます。以下のチュートリアルでは、Prisma CLI と Prisma Client を紹介します。

前提条件​

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

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

  • レプリカセット構成の MongoDB 4.2 以降のサーバーへのアクセス。 MongoDB Atlas を使用することをお勧めします。

    warning

    MongoDB データベースコネクタは、ネストされた書き込みをサポートするためにトランザクションを使用します。トランザクションは、レプリカセット デプロイメントを必須とします。レプリカセットをデプロイする最も簡単な方法は、Atlas を使用することです。無料で始められます。

データベースの 接続 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

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

npx prisma

次に、次のコマンドを使用して Prisma スキーマ ファイルを作成して、Prisma ORM プロジェクトをセットアップします。

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

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

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

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

.gitignore
generated/prisma/

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

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