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

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

TypeScript
CockroachDB

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` テーブルに新しいレコードを*書き込む*クエリの書き方を学びます。

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

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`](https://prisma.dokyumento.jp/docs/orm/prisma-client/queries/select-fields#return-nested-objects-by-selecting-relation-fields) オプションを渡していることに注意してください。これは、Prisma Clientが返された `User` オブジェクトに `posts` および `profile` リレーションを含めるように指示します。

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

npx tsx index.ts

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

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

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

npx tsx index.ts
© . All rights reserved.