README.md

drizzle-zero

Generate Zero schemas from Drizzle ORM schemas.

Installation

npm install drizzle-zero
# or
yarn add drizzle-zero
# or
pnpm add drizzle-zero

Usage

Here's an example of how to convert a Drizzle schema to a Zero schema with bidirectional relationships:

import { relations } from "drizzle-orm";
import { integer, pgTable, serial, text } from "drizzle-orm/pg-core";

export const users = pgTable("user", {
  id: serial("id").primaryKey(),
  name: text("name"),
});

export const usersRelations = relations(users, ({ many }) => ({
  posts: many(posts),
}));

export const posts = pgTable("post", {
  id: serial("id").primaryKey(),
  content: text("content"),
  authorId: integer("author_id").references(() => users.id),
});

export const postsRelations = relations(posts, ({ one }) => ({
  author: one(users, {
    fields: [posts.authorId],
    references: [users.id],
  }),
}));

You can then convert this Drizzle schema to a Zero schema:

import { createSchema } from "@rocicorp/zero";
import { createZeroTableSchema } from "drizzle-zero";
import * as drizzleSchema from "./drizzle-schema";

// Convert to Zero schema
export const schema = createSchema(
  createZeroSchema(drizzleSchema, {
    version: 1,
    tables: {
      user: {
        id: true,
        name: true,
      },
      post: {
        id: true,
        content: true,
        author_id: true,
      },
    },
  }),
);

You can then use the generated Zero schema in a React component:

import { useQuery, useZero } from "@rocicorp/zero/react";

function PostList({ selectedAuthorId }: { selectedAuthorId?: number }) {
  const z = useZero();
  
  // Build a query for posts with their authors
  let postsQuery = z.query.post
    .related('author')
    .limit(100);

  // Filter by author if selectedAuthorId is provided
  if (selectedAuthorId) {
    postsQuery = postsQuery.where('author_id', '=', selectedAuthorId);
  }

  const [posts, postsDetail] = useQuery(postsQuery);

  return (
    <div>
      <div>{postsDetail.type === 'complete' ? 'Complete results' : 'Partial results'}</div>
      <div>
        {posts.map(post => (
          <div key={post.id} className="post">
            <h2>{post.content}</h2>
            <p>By: {post.author?.name}</p>
          </div>
        ))}
      </div>
    </div>
  );
}

Features

• Convert Drizzle ORM schemas to Zero schemas
• Handles all Drizzle column types that are supported by Zero
• Type-safe schema generation
• Supports relationships:
  • One-to-one relationships
  • One-to-many relationships
  • Many-to-many relationships
  • Self-referential relationships

License

MIT