データベースのクエリ
最初のクエリをPrisma Clientで記述する
Prisma Clientを生成したので、データベース内のデータを読み書きするためのクエリを記述できます。このガイドでは、Prisma Clientの基本的な機能をいくつか試すために、プレーンなTypeScriptスクリプトを使用します。
queries.ts
という名前の新しいファイルを作成し、次のコードを追加します。
// 1
import { PrismaClient } from '@prisma/client'
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)
})
コードスニペットのさまざまな部分の概要を以下に示します。
PrismaClient
コンストラクタとwithAccelerate
拡張機能をインポートします。PrismaClient
をインスタンス化し、Accelerate拡張機能を追加します。- データベースにクエリを送信する
main
という名前のasync
関数を定義します。 main
関数を呼び出します。- スクリプトが終了したら、データベース接続を閉じます。
main
関数内で、データベースからすべてのUser
レコードを読み取り、結果をログに記録する次のクエリを追加します。
async function main() {
const allUsers = await prisma.user.findMany()
console.log(allUsers)
}
次のコマンドでコードを実行します。
npx tsx queries.ts
データベースにUser
レコードがまだないため、これは空の配列を出力するはずです。
[]
データベースにデータを書き込む
前のセクションで使用したfindMany
クエリは、データベースからデータを読み取るだけです(ただし、まだ空でした)。
このセクションでは、Post
、User
、およびProfile
テーブルに一度に新しいレコードを書き込むクエリを記述する方法を学習します。
main
関数を調整して、以前のコードを削除し、次を追加します。
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 | createdAt | updatedAt | タイトル | コンテンツ | 公開済み | 作成者ID |
---|---|---|---|---|---|---|
1 | 2020-03-21T16:45:01.246Z | 2020-03-21T16:45:01.246Z | "Hello World" | null | false | 1 |
プロフィール
id | 自己紹介 | ユーザーID |
---|---|---|
1 | "カメが好きです" | 1 |
Post
のauthorId
列とProfile
のuserId
列の数値はどちらもUser
テーブルのid
列を参照しています。つまり、id
値1
列は、データベース内の最初(および唯一)のUser
レコードを参照しています。
次のセクションに進む前に、作成したばかりのPost
レコードをupdate
クエリを使用して「公開」します。main
関数を次のように調整します。
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" | null | true | 1 |
おめでとうございます!アプリケーションでPrisma Clientを使用してPrisma Postgresデータベースにクエリする方法を学習しました。途中で迷子になったり、より多くのクエリについて学習したり、Prisma Accelerateのキャッシュ機能を試したりする場合は、包括的なPrismaスターターテンプレートを確認してください。