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

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

JavaScript
SQL Server

データベースに接続し、データベースアクセス用のPrisma Clientを生成することで、既存のNode.jsまたはTypeScriptプロジェクトにPrisma ORMを追加する方法を学びます。以下のチュートリアルでは、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 を含む schema.prisma というファイルを含む prisma という新しいディレクトリを作成します。
  • データソースを以下に設定しますSQLServerそして、それぞれ出力先をカスタムの場所に設定します。
  • プロジェクトのルートディレクトリに .env ファイルを作成します。これは、環境変数（データベース接続など）を定義するために使用されます
バージョン管理を使用していますか？

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

.gitignore
generated/prisma/

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

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