Introduction
Welcome to the hypequery docs. Find all the resources to get started.
What is hypequery?
hypequery is a code-first analytics backend for ClickHouse, built for TypeScript teams who want scalable, type-safe analytics.
At its core, hypequery is a ClickHouse-native TypeScript query builder, you generate types from your schema and then build ClickHouse queries with full type-safety.
Beyond this, hypequery ships with with opt-in features for query reuse, caching, multi-tenancy, authentication, and HTTP endpoint generation.
Instead of scattering SQL across applications, dashboards, and scripts, hypequery gives you a single, versioned place where analytics logic lives. In code.
hypequery is a library, not a hosted platform. It integrates directly with your existing ClickHouse setup and runs wherever your application runs.
Choose your path
hypequery has two common starting points:
- Start with the ClickHouse-native query builder for local typed queries
- Add
query({ ... })andserve({ queries })when the query needs reuse, validation, routes, docs, or framework handlers
If you are unsure, start with the query builder. The Quick Start page now shows both routes on one page.
Get Started
Start with either the builder-first route or the reusable-query runtime route
Look up connection options, client setup, and ClickHouse configuration details
Browse full working apps and framework examples in the examples repo
Framework Setup
See how the query-and-serve path fits into a Vite app
Mount the runtime inside a Next.js App Router project
Run the runtime behind a dedicated Node.js server
Use these once you are ready to mount the runtime inside an app or server.
Explore More
Build and compose queries with the fluent API
Look up the detailed API docs
Read the ClickHouse-specific behavior that matters when using the builder and runtime