Recipes

These recipes run on the quickstart database. Start that database and generate its types first. Each example uses demo tenant 1, whose four events span August 1–4, 2026.

Shared setup

The functions live in examples/analytics-api/src/recipes.ts, next to the generated schema. This is their shared setup:

import { createClickHouseDB, type ClickHouseClient } from "quarry";
import type { DB } from "./generated-schema";

export function createAnalyticsDB(client: ClickHouseClient) {
  return createClickHouseDB<DB>({ client });
}

export type AnalyticsDB = ReturnType<typeof createAnalyticsDB>;

In a script under examples/analytics-api/src/, create a client and pass the typed DB to a recipe. For example, save this as run-recipe.ts:

import { createClient } from "@clickhouse/client";
import { createAnalyticsDB, dailyActivity } from "./recipes";

const client = createClient({
  url: "http://localhost:8123",
  username: "quarry",
  password: "quarry",
  database: "analytics",
});

try {
  const db = createAnalyticsDB(client);
  const query = dailyActivity(db, 1);
  console.log(query.toSQL());
  console.log(await query.execute());
} finally {
  await client.close();
}

Run it from the repository root:

pnpm --filter @quarry/example-analytics exec tsx src/run-recipe.ts

Replace dailyActivity with another recipe to explore it. The AnalyticsDB type used by each function comes from the shared setup above. When copying a function into your own project, import that type or substitute your own typed DB.

What is checked

The docs render the query functions directly from the example source. The example's TypeScript check validates those functions, and its tests compare each recipe's displayed SQL and JSON with ClickHouse execution. The daily activity recipe also checks tenant isolation, and the filter recipe checks both branches.

These recipes target Quarry 0.10.0. Release guidance explains the differences from 0.9.1.