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

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

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

ヒント

別のORMからPrisma ORMに移行する場合は、TypeORMからの移行またはSequelizeからの移行ガイドをご覧ください。

前提条件

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

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

データベースの接続URL(認証クレデンシャルを含む)を手元に用意してください!データベースサーバーが実行されておらず、Prisma ORMを試したい場合は、クイックスタートを確認してください。

Prisma ORMの設定

まず最初に、package.jsonファイルが含まれているプロジェクトディレクトリに移動します。

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

npm install prisma --save-dev
注意

プロジェクトに複数のpackage.jsonファイルを持つディレクトリ(例:frontendbackendなど)が含まれている場合、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ファイルを作成します。
バージョン管理を使用していますか?

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

.gitignore
generated/prisma/

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

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