既存のMongoDBプロジェクトにPrisma ORMをJavaScriptで追加する

JavaScript

MongoDB

既存のNode.jsまたはTypeScriptプロジェクトにPrisma ORMを、データベースへの接続とデータベースアクセス用のPrisma Clientの生成によって追加する方法を学びます。このチュートリアルでは、Prisma CLI、Prisma Client、Prisma Introspectionを紹介します。

ヒント

MongooseからPrisma ORMへ移行する場合は、弊社の「Mongooseからの移行ガイド」を参照してください。

前提条件

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

• Node.js (正式にサポートされているバージョンについてはシステム要件を参照) お使いのコンピューターにインストールされていること

• レプリカセットデプロイメントを備えたMongoDB 4.2以降のサーバーへのアクセス。MongoDB Atlasの使用を推奨します。

  警告

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

データベース接続URL（認証情報を含む）を手元に用意してください！データベースサーバーが実行されておらず、Prisma ORMを試してみたいだけであれば、「クイックスタート」を参照してください。

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

Prisma ORMをセットアップする

最初のステップとして、`package.json`ファイルが含まれているプロジェクトディレクトリに移動してください。

次に、Prisma CLIを開発依存関係としてプロジェクトに追加します。

npm install prisma --save-dev

注

プロジェクトに`package.json`ファイルを含む複数のディレクトリ（例: `frontend`、`backend`など）がある場合、Prisma ORMは特にAPI/バックエンド層での使用を目的としていることに注意してください。Prismaをセットアップするには、関連する`package.json`ファイルを含む適切なバックエンドディレクトリに移動し、そこでPrismaを設定してください。

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

npx prisma

情報

別のパッケージマネージャーを使用してPrisma ORMをインストールする方法については、インストール手順を参照してください。

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

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

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

• `prisma`という新しいディレクトリを作成し、その中に`schema.prisma`というファイルを作成します。このファイルには、データベース接続変数とスキーマモデルを含むPrisma Schemaが含まれます。
• `datasource`を以下に設定します。MongoDBそして出力先をそれぞれカスタムの場所に設定します。
• プロジェクトのルートディレクトリに`.env`ファイルを作成します。これは環境変数（データベース接続など）を定義するために使用されます。

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

prisma/schema.prisma

datasource db {
  provider = "mongodb"
  url      = env("DATABASE_URL")
}