Prisma

Prisma 允許以完全類型安全的方式與 MongoDBSQL 資料庫 進行互動。

使用 Prisma,您可以在 .prisma 檔案中定義您的資料庫結構描述,他們的 CLI 會自動生成資料庫遷移以及 TypeScript 類型。

Prisma 可以搭配 routeLoader$routeAction$server$ 函式在 Qwik 中使用。這些是 Qwik API,允許程式碼僅在伺服器端執行。

將 Prisma 加入 Qwik 最簡單的方法是使用 pnpm qwik add prisma 命令。這將安裝所需的依賴項,並建立一個包含 Prisma schema 和移轉的 prisma 資料夾。

npm run qwik add prisma

Prisma 可以輕鬆使用不同的資料庫,例如 Postgres、MySQL、SQLite 和 MongoDB。

列出所有使用者

我們將使用 routeLoader$ 來查詢資料庫中的所有使用者,使用 prisma.user.findMany(),並返回結果。

src/routes/users/index.tsx
import { component$ } from '@builder.io/qwik';
import { routeLoader$ } from '@builder.io/qwik-city';
import { PrismaClient } from '@prisma/client'
 
export const useGetUsers = routeLoader$(async () => {
  const prisma = new PrismaClient();
  // example read from SQLite
  const users = await prisma.user.findMany()
  return users;
});
 
export default component$(() => {
  const users = useGetUsers();
  return (
    <section>
      <h1>User's directory</h1>
      <ul>
        {users.value.map(user => (
          <li key={user.id}>
            <a href={`/users/${user.id}`}>{user.name} ({user.email})</a>
          </li>
        ))}
      </ul>
    </section>
  )
});

顯示使用者詳細資訊

我們將使用 routeLoader$ 根據 userId URL 參數查詢特定使用者,使用 prisma.user.findUnique(),並返回結果。

src/routes/users/[userId]/index.tsx
import { component$ } from '@builder.io/qwik';
import { routeLoader$ } from '@builder.io/qwik-city';
import { PrismaClient } from '@prisma/client'
 
export const useGetUser = routeLoader$(async ({params, status}) => {
  const userId = parseInt(params['userId'], 10);
  const prisma = new PrismaClient();
  const user = await prisma.user.findUnique({where: {id: userId}});
  if (!user) {
    // Set the status to 404 if the user is not found
    status(404);
  }
  return user;
});
 
export default component$(() => {
  const user = useGetUser();
  return (
    <section>
      <h1>User detail</h1>
      {user.value ? (
        <>
          <p>Name: {user.value.name}</p>
          <p>Email: {user.value.email}</p>
        </>
      ) : (
        <p>User not found</p>
      )}
    </section>
  )
});

新增使用者

我們將使用 routeAction$Form 建立一個漸進式表單,將新使用者新增到資料庫。我們將使用 prisma.user.create() 來建立使用者。

src/routes/create/index.tsx
import { component$ } from '@builder.io/qwik';
import { routeAction$, zod$, z, Form } from '@builder.io/qwik-city';
import { PrismaClient } from '@prisma/client'
 
export const useCreateUser = routeAction$(async (data) => {
  const prisma = new PrismaClient();
  const user = await prisma.user.create({
    data,
  });
  return user;
}, zod$({
  name: z.string(),
  email: z.string().email(),
}));
 
export default component$(() => {
  const createUserAction = useCreateUser();
  return (
    <section>
      <h1>Create User</h1>
      <Form action={createUserAction}>
        <label>Name
          <input name="name" value={createUserAction.formData?.get('name')} />
        </label>
        <label>Email
          <input name="email" value={createUserAction.formData?.get('email')} />
        </label>
        <button type="submit">Create</button>
      </Form>
      {createUserAction.value && (
        <div>
          <h2>User created successfully!</h2>
        </div>
      )}
    </section>
  )
});

貢獻者

感謝所有幫助改進此文件的貢獻者!

  • manucorporat
  • ulic75
  • igorbabko
  • adcar
  • ruheni
  • Benny-Nottonson
  • mrhoodz
  • enesflow
  • fabian-hiller
  • aendel