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.
You define queries in TypeScript, give them names, types, and schemas, and execute them anywhere they're needed: inside backend services, background jobs, APIs, dashboards, or AI agents.
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 ships with a type-safe Query Builder and optional serve package for adding authentication, multi-tenancy and APIs.
Get started with the one that matches your immediate delivery need, you can always opt-in to more features later without rewriting your query logic.
Best for dashboards, internal tools, and replacing raw SQL with type-safe queries.
Best when you need HTTP APIs, auth, multi-tenancy, and generated OpenAPI docs.
Get Started
Get up and running with hypequery in minutes
Step-by-step installation guide for custom setups
Framework-Specific Quick Start
Setup guide for Vite applications
Setup guide for Next.js applications
Setup guide for Node.js applications
Explore More
Build and compose queries with the fluent API
Understand how to run queries standalone, inside frameworks, or in-process
Understand schemas, query definitions, and execution modes
Use the ClickHouse client directly without the framework