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

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

TypeScript
PostgreSQL

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`ノードモジュールから`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

次のセクションに進む前に、`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.