Docs Blog GitHub

Introduction
Installation
Connecting to ClickHouse
Type Generation

Query Building
Join Relationships
Cross Filtering
Time-Based Functions

Select
Where
Joins
Group By
Having
Order By
Limit
Offset
Distinct
CTEs
Execute & toSQL

Raw
Raw As

Subqueries
Helper methods
Streaming
Logging

Globals
Classes
Functions
Interfaces

JoinPathOptions

Interface: JoinPathOptions

Properties

alias?

optional alias: string

context?

optional context: Record<string, any>

type?

optional type: JoinType

On this page

> hypequery

Type-safe ClickHouse queries for TypeScript developers.

Products

TypeScript SDK

Resources

Documentation
Core Features
Advanced Features
GitHub

© 2025 hypequery. All rights reserved.