API Reference
Overview
Exact signatures, return types, and helper surfaces for the public Quarry API.
Use this section when you already know roughly what you want and need the exact
surface area. It is a hand-curated reference for the public Quarry API, 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.
If you are still learning how the pieces fit together, start with Guides or Deep Dive first.
DB typing helpers—TypedView,TypedTable,ColumnType, and the built-in ClickHouse alias types.createClickHouseDB— the entry point that turns a@clickhouse/clientinstance into a typed database handle.SelectQueryBuilder— the immutable builder returned bydb.selectFrom(...). Every method, every overload.InsertQueryBuilder— the builder returned bydb.insertInto(...). Deliberately narrow surface.ExpressionBuilder— the callback-form API forwhere,having,selectExpr, and joins, including everyeb.fn.*helper.