既存のプロジェクトにPrisma ORMを追加する(JavaScriptとSQL Server)
既存のNode.jsまたはTypeScriptプロジェクトにPrisma ORMを追加する方法を、データベースへの接続とデータベースアクセス用のPrisma Clientの生成を通じて学習します。このチュートリアルでは、Prisma CLI、Prisma Client、およびPrisma Introspectionについて説明します。
他のORMからPrisma ORMへ移行する場合は、「TypeORMからの移行」または「Sequelizeからの移行」の移行ガイドを参照してください。
前提条件
このガイドを正常に完了するには、以下が必要です。
正確なバージョン要件については、「システム要件」を参照してください。
データベース接続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 sqlserver --output ../generated/prisma
このコマンドはいくつかの処理を行います。
- `prisma`という新しいディレクトリを作成し、その中に`schema.prisma`というファイルを作成します。このファイルには、データベース接続変数とスキーマモデルを含むPrisma Schemaが含まれます。
- データソースを以下に設定します。SQLServerおよび、出力をそれぞれカスタムの場所に設定します。
- プロジェクトのルートディレクトリに`.env`ファイルを作成します。これは、環境変数(データベース接続など)を定義するために使用されます。
`prisma init`で作成されるデフォルトのスキーマは、`provider`としてPostgreSQLを使用することに注意してください。`datasource-provider`オプションでプロバイダーを指定しなかった場合、代わりに`sqlserver`プロバイダーを使用するように`datasource`ブロックを編集する必要があります。
datasource db {
provider = "sqlserver"
url = env("DATABASE_URL")
}