Quarry
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 helpersTypedView, TypedTable, ColumnType, and the built-in ClickHouse alias types.
  • 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.