Prisma

Prisma 允许以完全类型安全的方式与 MongoDBSQL 数据库 进行交互。

使用 Prisma,您可以在 .prisma 文件中定义您的数据库模式,他们的 CLI 会自动生成数据库迁移以及 Typescript 类型。

Prisma 可以与 Qwik 的 routeLoader$routeAction$server$ 函数一起使用。这些是 Qwik API,允许代码仅在服务器端执行。

将 Prisma 添加到 Qwik 的最简单方法是使用 pnpm qwik add prisma 命令。这将安装所需的依赖项并创建一个包含 Prisma 模式和迁移的 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