既存のプロジェクトにPrisma ORMを追加する (TypeScriptとSQL Server)

TypeScript

SQL Server

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

ヒント

別のORMからPrisma ORMへ移行する場合は、TypeORMからの移行またはSequelizeからの移行のガイドを参照してください。

前提条件

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

• Node.jsがマシンにインストールされていること (正式にサポートされているバージョンについてはシステム要件を参照)
• Microsoft SQL Server データベース
  • Docker用Linux上のMicrosoft SQL Server
  • Windows上のMicrosoft SQL Server (ローカル)

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

データベースの接続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スキーマが含まれます。
• datasourceを以下に設定します。SQLServerおよび、出力をそれぞれカスタムの場所に設定します。
• プロジェクトのルートディレクトリに.envファイルを作成します。このファイルは、環境変数（データベース接続など）を定義するために使用されます。

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

prisma/schema.prisma

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