Getting Started

Introduction
Installation
Connecting to ClickHouse
Type Generation

Core Features

Query Building
Join Relationships
Filtering
SQL Expressions
Time-Based Functions

Advanced Features

Subqueries
Helper methods
Streaming
Logging

API Documentation

Globals
Classes
Functions
Interfaces
Type Aliases
Variables
- logger

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.