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 lowest level, hypequery is a TypeScript query builder for ClickHouse, 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.
Recommended Path
hypequery has a clear progression:
- Start with the query builder for local typed queries
- Use
query({ ... })to create reusable contracts - Add
serve({ queries })when you want routes, docs, auth, or framework handlers
Get Started
Get up and running with hypequery in minutes
Install packages, configure env vars, and create the typed client without the guided flow
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
Explore More
Build and compose queries with the fluent API
Look up the detailed API docs