主要コンテンツにスキップ

TypeScriptとPrisma Postgresを使用してデータベースをクエリする

TypeScript
Prisma Postgres

Prisma Clientで最初のクエリを作成する​

Prisma Clientを生成したら、データベースのデータの読み書きを行うクエリの記述を開始できます。このガイドでは、プレーンなTypeScriptスクリプトを使用してPrisma Clientの基本的な機能をいくつか探ります。

queries.tsという新しいファイルを作成し、以下のコードを追加します

queries.ts
// 1
import { PrismaClient } from './generated/prisma'
import { withAccelerate } from '@prisma/extension-accelerate'

// 2
const prisma = new PrismaClient()
  .$extends(withAccelerate())

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

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

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

  1. PrismaClientコンストラクターとwithAccelerate拡張機能をインポートします。
  2. PrismaClientをインスタンス化し、Accelerate拡張機能を追加します。
  3. データベースにクエリを送信するためのmainという名前のasync関数を定義します。
  4. main関数を呼び出します。
  5. スクリプトが終了したら、データベース接続を閉じます。

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

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

次に、このコマンドでコードを実行します

npx tsx queries.ts

データベースにまだUserレコードがないため、空の配列が出力されるはずです

[]

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

前のセクションで使用したfindManyクエリは、データベースからデータを読み取るだけでした（まだ空でしたが）。

このセクションでは、Post、User、およびProfileテーブルに新しいレコードを一度に書き込むクエリを作成する方法を学びます。

main関数を、以前のコードを削除して以下を追加するように調整します

queries.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レコードと共に作成します。

レコードは、Prismaスキーマで定義したリレーションフィールドを介して接続されています。

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

このコマンドでコードを実行します

npx tsx queries.ts

出力は次のようになります

[
  {
    email: 'alice@prisma.io',
    id: 1,
    name: 'Alice',
    posts: [
      {
        content: null,
        createdAt: 2020-03-21T16:45:01.246Z,
        updatedAt: 2020-03-21T16:45:01.246Z,
        id: 1,
        published: false,
        title: 'Hello World',
        authorId: 1,
      }
    ],
    profile: {
      bio: 'I like turtles',
      id: 1,
      userId: 1,
    }
  }
]

また、allUsers変数はPrisma Clientが生成する型のおかげで静的に型付けされています。エディタでallUsers変数にカーソルを合わせると、その型を確認できます。次のように型付けされているはずです

const allUsers: ({
  posts: {
    id: number;
    createdAt: Date;
    updatedAt: Date;
    title: string;
    content: string | null;
    published: boolean;
    authorId: number;
  }[];
  profile: {
    id: number;
    bio: string | null;
    userId: number;
  } | null;
} & {
  ...;
})[]
作成されたレコードを視覚的に表示するには展開してください

クエリにより、User、Post、およびProfileテーブルに新しいレコードが追加されました

ユーザー

IDメール名前
1"alice@prisma.io""Alice"

投稿

ID作成日時更新日時タイトルコンテンツ公開済み作成者ID
12020-03-21T16:45:01.246Z2020-03-21T16:45:01.246Z"Hello World"nullfalse1

プロフィール

ID自己紹介ユーザーID
1"I like turtles"1

PostテーブルのauthorId列とProfileテーブルのuserId列の数値は両方ともUserテーブルのid列を参照しており、id値1の列はデータベース内の最初の（かつ唯一の）Userレコードを指します。

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

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

次に、以前と同じコマンドを使用してコードを実行します

npx tsx queries.ts

以下の出力が表示されます

{
  id: 1,
  title: 'Hello World',
  content: null,
  published: true,
  authorId: 1
}

idが1のPostレコードがデータベースで更新されました

投稿

IDタイトルコンテンツ公開済み作成者ID
1"Hello World"nulltrue1

おめでとうございます！これで、アプリケーションでPrisma Clientを使用してPrisma Postgresデータベースをクエリする方法を学びました。途中で迷ったり、より多くのクエリについて学んだり、Prisma Accelerateのキャッシング機能を探索したい場合は、包括的なPrismaスターターテンプレートを確認してください。

© . All rights reserved.