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

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

TypeScript
PlanetScale

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

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

REST APIを構築している場合、受信HTTPリクエストに基づいてデータベースのデータを読み書きするために、ルートハンドラでPrisma Clientを使用できます。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ノードモジュールからPrismaClientコンストラクタをインポートします
  2. PrismaClientをインスタンス化します
  3. データベースにクエリを送信するためのmainという名前のasync関数を定義します
  4. main関数を呼び出します
  5. スクリプトが終了するときにデータベース接続を閉じます

モデルの見た目に応じて、Prisma Client APIも異なります。たとえば、Userモデルがある場合、PrismaClientインスタンスはuserというプロパティを公開し、そこでfindMany、create、updateのようなCRUDメソッドを呼び出すことができます。プロパティはモデルの名前にちなんで名付けられていますが、最初の文字は小文字になっています（したがって、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つのレコードに接続されています。

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

現在のTypeScript設定でコードを実行します。tsxを使用している場合、次のように実行できます

npx tsx index.ts

次のセクションに進む前に、updateクエリを使用して作成したばかりのPostレコードを「公開」します。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.