Quarry
Reference

Reference

Hand-curated API reference for the public Quarry surface.

This section is a hand-curated reference for the public Quarry surface, with selected types rendered live from the source via fumadocs-typescript.

If you find an exported symbol that is not yet documented here, that is a docs gap, not an intentional omission — please open an issue.

  • createClickHouseDB — the entry point that turns a @clickhouse/client instance into a typed database handle.
  • SelectQueryBuilder — the immutable builder returned by db.selectFrom(...). Every method, every overload.
  • InsertQueryBuilder — the builder returned by db.insertInto(...). Deliberately narrow surface.
  • ExpressionBuilder — the callback-form API for where, having, selectExpr, and joins, including every eb.fn.* helper.

Inserts

Insert one or many rows, or materialize a select query into a table.

createClickHouseDB

The entry point that turns a @clickhouse/client instance into a typed database handle.