HypeQuery ClickHouse API Reference

This comprehensive API reference documents all public classes, methods, and types available in the HypeQuery ClickHouse library.

API Documentation Sections

The API reference is organized into the following sections:

Classes

These are the main classes you’ll interact with:

• ClickHouseConnection - Main connection class for ClickHouse
• CrossFilter - Cross-filtering functionality
• JoinRelationships - Define and manage join relationships

Functions

Utility functions for working with ClickHouse:

• createQueryBuilder - Create a query builder
• datePart - Extract parts from date values
• formatDateTime - Format date and time values
• raw - Create raw SQL expressions

Interfaces

Type definitions for objects used throughout the library:

• QueryConfig - Query configuration options
• PaginationOptions - Pagination configuration
• JoinPath - Join path configuration

Type Aliases

Common type definitions:

• ColumnType - Column type definition
• DatabaseSchema - Database schema definition

How to Use This Reference

This reference is automatically generated from the source code and is intended to be a comprehensive resource for developers using the HypeQuery ClickHouse library.

For each component, you’ll find:

• Method signatures with parameter and return types
• Type definitions
• JSDoc comments explaining functionality
• Example code where available

If you’re new to the library, we recommend starting with the Introduction and Quick Start guides before diving into the API reference.