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

TypeScriptとPrisma ORMで既存のSQL Serverデータベースをクエリする

TypeScript
SQL Server

Prisma Clientで初めてのクエリを記述する​

Prisma Clientを生成したので、データベースのデータの読み書きを行うクエリを記述し始めることができます。

REST APIを構築している場合、Prisma Clientをルートハンドラで使用して、受信HTTPリクエストに基づいてデータベースのデータの読み書きを行うことができます。GraphQL APIを構築している場合、Prisma Clientをリゾルバで使用して、受信クエリとミューテーションに基づいてデータベースのデータの読み書きを行うことができます。

ただし、このガイドでは、Prisma Clientを使用してデータベースにクエリを送信する方法を学ぶために、シンプルなNode.jsスクリプトを作成するだけです。APIの仕組みを理解したら、実際のアプリケーションコード（例: RESTルートハンドラやGraphQLリゾルバ）に統合し始めることができます。

`index.ts`という名前の新しいファイルを作成し、次のコードを追加します

index.ts
import { PrismaClient } from '@prisma/client'

const prisma = new PrismaClient()

async function main() {
  // ... you will write your Prisma Client queries here
}

main()
  .then(async () => {
    await prisma.$disconnect()
  })
  .catch(async (e) => {
    console.error(e)
    await prisma.$disconnect()
    process.exit(1)
  })

以下は、このコードスニペットの各部分の概要です

  1. `@prisma/client` nodeモジュールから`PrismaClient`コンストラクタをインポートします
  2. `PrismaClient`をインスタンス化します
  3. データベースにクエリを送信するための`main`という名前の`async`関数を定義します
  4. `main`関数を呼び出します
  5. スクリプトが終了したらデータベース接続を閉じます

モデルの構成に応じて、Prisma Client APIも異なります。例えば、`User`モデルがある場合、`PrismaClient`インスタンスは`user`というプロパティを公開し、そこでCRUDメソッド（`findMany`、`create`、`update`など）を呼び出すことができます。プロパティはモデルの名前から名付けられますが、最初の文字は小文字になります（`Post`モデルの場合は`post`、`Profile`モデルの場合は`profile`となります）。

以下の例はすべて、Prismaスキーマのモデルに基づいています。

`main`関数内に、データベースからすべての`User`レコードを読み込み、結果を出力する以下のクエリを追加します

index.ts
async function main() {
  const allUsers = await prisma.user.findMany()
  console.log(allUsers)
}

現在のTypeScriptセットアップでコードを実行します。`tsx`を使用している場合は、次のように実行できます

npx tsx index.ts

データベースイントロスペクションのステップでスキーマを使用してデータベースを作成した場合、データベースにはまだ`User`レコードがないため、クエリは空の配列を出力するはずです。

[]

レコードを持つ既存のデータベースをイントロスペクトした場合、クエリはJavaScriptオブジェクトの配列を返すはずです。

データベースにデータを書き込む​

前のセクションで使用した`findMany`クエリは、データベースからデータを_読み込む_だけです。このセクションでは、`Post`と`User`テーブルに新しいレコードを_書き込む_クエリの作成方法を学びます。

`main`関数を調整して、データベースに`create`クエリを送信します

index.ts
async function main() {
  await prisma.user.create({
    data: {
      name: 'Alice',
      email: 'alice@prisma.io',
      posts: {
        create: { title: 'Hello World' },
      },
      profile: {
        create: { bio: 'I like turtles' },
      },
    },
  })

  const allUsers = await prisma.user.findMany({
    include: {
      posts: true,
      profile: true,
    },
  })
  console.dir(allUsers, { depth: null })
}

このコードは、ネストされた書き込みクエリを使用して、新しい`User`レコードと新しい`Post`および`Profile`レコードを作成します。`User`レコードは、それぞれ`Post.author` ↔ `User.posts`および`Profile.user` ↔ `User.profile`のリレーションフィールドを介して他の2つのレコードに接続されます。

返される`User`オブジェクトに`posts`および`profile`リレーションを含めるようPrisma Clientに指示する`include`オプションを`findMany`に渡していることに注意してください。

現在のTypeScriptセットアップでコードを実行します。`tsx`を使用している場合は、次のように実行できます

npx tsx index.ts

次のセクションに進む前に、先ほど作成した`Post`レコードを`update`クエリを使用して「公開」します。`main`関数を次のように調整します

index.ts
async function main() {
  const post = await prisma.post.update({
    where: { id: 1 },
    data: { published: true },
  })
  console.log(post)
}

現在のTypeScriptセットアップでコードを実行します。`tsx`を使用している場合は、次のように実行できます

npx tsx index.ts
© . All rights reserved.