Overview

Pick the job you want to do.

Start here

• Getting started — install Quarry, create a typed db, run a first query, and inspect toSQL().
• Schema introspection — bootstrap plain TypeScript Tables, Views, and DB types from an existing ClickHouse database with the experimental CLI.

Read queries

• Expressions and functions — parameters, casts, date handling, array helpers, string helpers, and eb.fn.* patterns.
• Joins — type-safe joins, anti joins, joined FINAL sources, and subquery joins.
• CTEs and subqueries — stage reusable subqueries with with(...) and nested selectFrom(...) calls.
• Grouping, aggregation, and ordering — aggregation helpers, PREWHERE, ordering, and settings.

Write data

• Inserts — batch inserts, typed target columns, and INSERT INTO ... SELECT.

Troubleshooting

• Debugging — inspect SQL, understand common errors, and separate scope problems from runtime problems.
• Performance — what Quarry does and does not do for query performance.