Drizzle

Drizzle ORM 是一个带有头部的无头 TypeScript ORM 🐲

使用 Drizzle，您可以用 TypeScript 定义和管理数据库模式，以类似 SQL 或关系的方式访问您的数据，并利用可选工具来提升您的开发体验 🤯

同时，它也可以在无服务器环境中使用

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

将 Drizzle 添加到 Qwik 的最简单方法是使用 npm qwik add drizzle 命令。这将安装所需的依赖项并在 db 文件夹中创建一个 drizzle 模式。

npm run qwik add drizzle

Drizzle 是一个拥抱 SQL 的 ORM。与其他 ORM 不同，它不会偏离 SQL，消除了学习 SQL 和框架 API 的双重学习曲线。如果您了解 SQL，您可以轻松地将 Drizzle 的全部潜力发挥出来。

列出所有用户

我们将使用 routeLoader$ 来查询数据库中的所有用户，使用 db.query.users.findMany()，并返回结果。

src/routes/users/index.tsx

import { component$ } from "@builder.io/qwik";
import { routeLoader$ } from "@builder.io/qwik-city";
import { drizzle } from "drizzle-orm/better-sqlite3";
import Database from "better-sqlite3";
import { schema } from "../../../drizzle/schema";
 
export const useGetUsers = routeLoader$(async () => {
  const sqlite = new Database("./drizzle/db/db.sqlite");
  const db = drizzle(sqlite, { schema });
  const users = await db.query.users.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 参数查询特定用户，使用 db.query.users.findFirst({ where: (users, { eq }) => eq(users.id, userId), })，并返回结果。

src/routes/users/[userId]/index.tsx

import { component$ } from "@builder.io/qwik";
import { routeLoader$ } from "@builder.io/qwik-city";
import { drizzle } from "drizzle-orm/better-sqlite3";
import Database from "better-sqlite3";
import { schema } from "../../../../drizzle/schema";
 
export const useGetUser = routeLoader$(async (requestEvent) => {
  const userId = parseInt(requestEvent.params["userId"], 10);
  const sqlite = new Database("./drizzle/db/db.sqlite");
  const db = drizzle(sqlite, { schema });
  const user = await db.query.users.findFirst({
    where: (users, { eq }) => eq(users.id, userId),
  });
  if (!user) {
    // Set the status to 404 if the user is not found
    requestEvent.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 来创建一个渐进式表单，将新用户添加到数据库中。我们将使用 db.insert(schema.users).values(data) 来创建用户。

src/routes/create/index.tsx

import { component$ } from "@builder.io/qwik";
import { routeAction$, zod$, z, Form } from "@builder.io/qwik-city";
import { drizzle } from "drizzle-orm/better-sqlite3";
import Database from "better-sqlite3";
import { schema } from "../../../drizzle/schema";
export const useCreateUser = routeAction$(
  async (data) => {
    const sqlite = new Database("./drizzle/db/db.sqlite");
    const db = drizzle(sqlite, { schema });
    const user = await db.insert(schema.users).values(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>
  );
});

贡献者

感谢所有帮助改进这份文档的贡献者！