createQueryBuilder - API reference

API reference › @evolu/common › local‑first/Schema › createQueryBuilder

function createQueryBuilder<S>(_schema: S): CreateQuery<S>;

Defined in: packages/common/src/local-first/Schema.ts:482

Creates a query builder from a EvoluSchema.

Supports Kysely relation-style query composition (nested objects/arrays via JSON subqueries), such as evoluJsonObjectFrom and evoluJsonArrayFrom. These helpers are Evolu's safer SQLite variants of the Kysely relations recipe.

Example

import {
  createQueryBuilder,
  id,
  NonEmptyTrimmedString100,
  nullOr,
  SqliteBoolean,
} from "@evolu/common";

const TodoId = id("Todo");
type TodoId = typeof TodoId.Output;
const Schema = {
  todo: {
    id: TodoId,
    title: NonEmptyTrimmedString100,
    isCompleted: nullOr(SqliteBoolean),
  },
};

// Create one typed builder per schema and reuse it for every query.
const createQuery = createQueryBuilder(Schema);
const todosQuery = createQuery((db) =>
  db.selectFrom("todo").select(["id", "title", "isCompleted"]),
);

expectTypeOf<typeof todosQuery.Row>().toEqualTypeOf<{
  id: TodoId;
  title: NonEmptyTrimmedString100 | null;
  isCompleted: SqliteBoolean | null;
}>();
expect(todosQuery).toBeTypeOf("string");