@hypequery/clickhouse 0.0.0-canary-20260306132943

package/dist/core/formatters/sql-formatter.js

@@ -0,0 +1,131 @@
+export class SQLFormatter {
+    formatSelect(config) {
+        const distinctClause = config.distinct ? 'DISTINCT ' : '';
+        if (!config.select?.length)
+            return distinctClause + '*';
+        return distinctClause + config.select.join(', ');
+    }
+    formatGroupBy(config) {
+        const groupBy = config.groupBy;
+        if (!groupBy?.length)
+            return '';
+        if (Array.isArray(groupBy)) {
+            return groupBy.join(', ');
+        }
+        return String(groupBy);
+    }
+    formatWhere(config) {
+        if (!config.where?.length)
+            return '';
+        let afterGroupStart = false; // Track whether we're immediately after a group-start
+        // First pass - generate the SQL fragments for each condition
+        const fragments = config.where.map((condition, index) => {
+            // Handle expression predicates
+            if (condition.type === 'expression') {
+                const prefix = index === 0 || afterGroupStart ? '' : ` ${condition.conjunction} `;
+                afterGroupStart = false;
+                return `${prefix}${condition.expression}`.trim();
+            }
+            // Handle special group markers
+            if (condition.type === 'group-start') {
+                const prefix = index === 0 ? '' : ` ${condition.conjunction} `;
+                afterGroupStart = true; // Mark that the next condition follows a group-start
+                return `${prefix}(`.trim();
+            }
+            if (condition.type === 'group-end') {
+                afterGroupStart = false; // Reset the flag after group-end
+                return ')';
+            }
+            // Normal conditions
+            const { column, operator, value, conjunction } = condition;
+            // Don't add conjunction if it's the first condition or right after a group-start
+            const prefix = index === 0 || afterGroupStart ? '' : ` ${conjunction} `;
+            // Reset the afterGroupStart flag
+            afterGroupStart = false;
+            // Handle IN operators
+            if (operator === 'in' || operator === 'notIn') {
+                if (!Array.isArray(value)) {
+                    throw new Error(`Expected an array for ${operator} operator, but got ${typeof value}`);
+                }
+                if (value.length === 0) {
+                    return `${prefix}1 = 0`;
+                }
+                const placeholders = value.map(() => '?').join(', ');
+                return `${prefix}${column} ${operator === 'in' ? 'IN' : 'NOT IN'} (${placeholders})`.trim();
+            }
+            // Handle GLOBAL IN operators
+            else if (operator === 'globalIn' || operator === 'globalNotIn') {
+                if (!Array.isArray(value)) {
+                    throw new Error(`Expected an array for ${operator} operator, but got ${typeof value}`);
+                }
+                if (value.length === 0) {
+                    return `${prefix}1 = 0`;
+                }
+                const placeholders = value.map(() => '?').join(', ');
+                return `${prefix}${column} ${operator === 'globalIn' ? 'GLOBAL IN' : 'GLOBAL NOT IN'} (${placeholders})`.trim();
+            }
+            // Handle subquery IN operators
+            else if (operator === 'inSubquery' || operator === 'globalInSubquery') {
+                if (typeof value !== 'string') {
+                    throw new Error(`Expected a string (subquery) for ${operator} operator, but got ${typeof value}`);
+                }
+                return `${prefix}${column} ${operator === 'inSubquery' ? 'IN' : 'GLOBAL IN'} (${value})`.trim();
+            }
+            // Handle table reference IN operators
+            else if (operator === 'inTable' || operator === 'globalInTable') {
+                if (typeof value !== 'string') {
+                    throw new Error(`Expected a string (table name) for ${operator} operator, but got ${typeof value}`);
+                }
+                return `${prefix}${column} ${operator === 'inTable' ? 'IN' : 'GLOBAL IN'} ${value}`.trim();
+            }
+            // Handle tuple IN operators
+            else if (operator === 'inTuple' || operator === 'globalInTuple') {
+                if (!Array.isArray(value)) {
+                    throw new Error(`Expected an array of tuples for ${operator} operator, but got ${typeof value}`);
+                }
+                if (value.length === 0) {
+                    return `${prefix}1 = 0`;
+                }
+                const placeholders = value.map(() => '(?, ?)').join(', ');
+                return `${prefix}${column} ${operator === 'inTuple' ? 'IN' : 'GLOBAL IN'} (${placeholders})`.trim();
+            }
+            else if (operator === 'between') {
+                return `${prefix}${column} BETWEEN ? AND ?`.trim();
+            }
+            else if (operator === 'like') {
+                return `${prefix}${column} LIKE ?`.trim();
+            }
+            else {
+                return `${prefix}${column} ${this.getSqlOperator(operator)} ?`.trim();
+            }
+        });
+        // Join fragments and then remove extra spaces around parentheses
+        let result = fragments.join(' ');
+        // Replace "( " with "(" and " )" with ")"
+        result = result.replace(/\(\s+/g, '(').replace(/\s+\)/g, ')');
+        return result;
+    }
+    getSqlOperator(operator) {
+        switch (operator) {
+            case 'eq': return '=';
+            case 'neq': return '!=';
+            case 'gt': return '>';
+            case 'gte': return '>=';
+            case 'lt': return '<';
+            case 'lte': return '<=';
+            case 'like': return 'LIKE';
+            default:
+                throw new Error(`Unsupported operator: ${operator}`);
+        }
+    }
+    formatJoins(config) {
+        if (!config.joins?.length)
+            return '';
+        return config.joins.map(join => {
+            const tableClause = join.alias
+                ? `${join.table} AS ${join.alias}`
+                : join.table;
+            return `${join.type} JOIN ${tableClause} ON ${join.leftColumn} = ${join.rightColumn}`;
+        }).join(' ');
+    }
+}

package/dist/core/join-relationships.d.ts

@@ -0,0 +1,51 @@
+import { JoinType } from '../types/index.js';
+import { ColumnType } from '../types/schema.js';
+export interface JoinPath<Schema> {
+    from: keyof Schema;
+    to: keyof Schema;
+    leftColumn: string;
+    rightColumn: string;
+    type?: JoinType;
+    alias?: string;
+}
+export interface JoinPathOptions {
+    type?: JoinType;
+    alias?: string;
+    context?: Record<string, any>;
+}
+export declare class JoinRelationships<Schema extends {
+    [K in keyof Schema]: {
+        [columnName: string]: ColumnType;
+    };
+}> {
+    private paths;
+    /**
+     * Define a single join relationship
+     */
+    define(name: string, path: JoinPath<Schema>): void;
+    /**
+     * Define a chain of join relationships
+     */
+    defineChain(name: string, paths: JoinPath<Schema>[]): void;
+    /**
+     * Get a join relationship by name
+     */
+    get(name: string): JoinPath<Schema> | JoinPath<Schema>[] | undefined;
+    /**
+     * Check if a join relationship exists
+     */
+    has(name: string): boolean;
+    /**
+     * Remove a join relationship
+     */
+    remove(name: string): boolean;
+    /**
+     * Clear all join relationships
+     */
+    clear(): void;
+    /**
+     * Get all defined relationship names
+     */
+    getDefinedRelationships(): string[];
+}
+//# sourceMappingURL=join-relationships.d.ts.map

package/dist/core/join-relationships.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"join-relationships.d.ts","sourceRoot":"","sources":["../../src/core/join-relationships.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,mBAAmB,CAAC;AAC7C,OAAO,EAAE,UAAU,EAAE,MAAM,oBAAoB,CAAC;AAEhD,MAAM,WAAW,QAAQ,CAAC,MAAM;IAC9B,IAAI,EAAE,MAAM,MAAM,CAAC;IACnB,EAAE,EAAE,MAAM,MAAM,CAAC;IACjB,UAAU,EAAE,MAAM,CAAC;IACnB,WAAW,EAAE,MAAM,CAAC;IACpB,IAAI,CAAC,EAAE,QAAQ,CAAC;IAChB,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAED,MAAM,WAAW,eAAe;IAC9B,IAAI,CAAC,EAAE,QAAQ,CAAC;IAChB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;CAC/B;AAED,qBAAa,iBAAiB,CAAC,MAAM,SAAS;KAAG,CAAC,IAAI,MAAM,MAAM,GAAG;QAAE,CAAC,UAAU,EAAE,MAAM,GAAG,UAAU,CAAA;KAAE;CAAE;IACzG,OAAO,CAAC,KAAK,CAA4D;IAEzE;;OAEG;IACH,MAAM,CAAC,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,QAAQ,CAAC,MAAM,CAAC,GAAG,IAAI;IAOlD;;OAEG;IACH,WAAW,CAAC,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,QAAQ,CAAC,MAAM,CAAC,EAAE,GAAG,IAAI;IAU1D;;OAEG;IACH,GAAG,CAAC,IAAI,EAAE,MAAM,GAAG,QAAQ,CAAC,MAAM,CAAC,GAAG,QAAQ,CAAC,MAAM,CAAC,EAAE,GAAG,SAAS;IAIpE;;OAEG;IACH,GAAG,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO;IAI1B;;OAEG;IACH,MAAM,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO;IAI7B;;OAEG;IACH,KAAK,IAAI,IAAI;IAIb;;OAEG;IACH,uBAAuB,IAAI,MAAM,EAAE;CAGpC"}

package/dist/core/join-relationships.js

@@ -0,0 +1,54 @@
+export class JoinRelationships {
+    paths = new Map();
+    /**
+     * Define a single join relationship
+     */
+    define(name, path) {
+        if (this.paths.has(name)) {
+            throw new Error(`Join relationship '${name}' is already defined`);
+        }
+        this.paths.set(name, path);
+    }
+    /**
+     * Define a chain of join relationships
+     */
+    defineChain(name, paths) {
+        if (this.paths.has(name)) {
+            throw new Error(`Join chain '${name}' is already defined`);
+        }
+        if (paths.length === 0) {
+            throw new Error('Join chain must contain at least one path');
+        }
+        this.paths.set(name, paths);
+    }
+    /**
+     * Get a join relationship by name
+     */
+    get(name) {
+        return this.paths.get(name);
+    }
+    /**
+     * Check if a join relationship exists
+     */
+    has(name) {
+        return this.paths.has(name);
+    }
+    /**
+     * Remove a join relationship
+     */
+    remove(name) {
+        return this.paths.delete(name);
+    }
+    /**
+     * Clear all join relationships
+     */
+    clear() {
+        this.paths.clear();
+    }
+    /**
+     * Get all defined relationship names
+     */
+    getDefinedRelationships() {
+        return Array.from(this.paths.keys());
+    }
+}

package/dist/core/query-builder.d.ts

@@ -0,0 +1,236 @@
+import { CrossFilter } from './cross-filter.js';
+import { FilterOperator, OperatorValueMap, OrderDirection, QueryConfig } from '../types/index.js';
+import { AnySchema } from '../types/schema.js';
+import { SQLFormatter } from './formatters/sql-formatter.js';
+import { ExecutorFeature } from './features/executor.js';
+import { JoinRelationships, JoinPathOptions } from './join-relationships.js';
+import { PredicateBuilder, PredicateExpression } from './utils/predicate-builder.js';
+import type { ClickHouseSettings, BaseClickHouseClientConfigOptions } from '@clickhouse/client-common';
+import type { ClickHouseClient as NodeClickHouseClient } from '@clickhouse/client';
+import type { ClickHouseClient as WebClickHouseClient } from '@clickhouse/client-web';
+import type { CacheOptions, CacheConfig } from './cache/types.js';
+import type { QueryRuntimeContext } from './cache/runtime-context.js';
+import type { BuilderState, AnyBuilderState, SchemaDefinition, InitialState, UpdateOutput, WidenTables, AppendToOutput, BaseRow, AddAlias, AddScalar } from './types/builder-state.js';
+import { SelectableItem, SelectableColumn, SelectionResult, ColumnSelectionValue } from './types/select-types.js';
+type WhereColumn<State extends AnyBuilderState> = SelectableColumn<State>;
+type ColumnOperatorValue<Schema extends SchemaDefinition<Schema>, State extends BuilderState<Schema, string, any, keyof Schema, Partial<Record<string, keyof Schema>>>, Column extends WhereColumn<State>, Op extends keyof OperatorValueMap<any, Schema>> = OperatorValueMap<ColumnSelectionValue<State, Column>, Schema>[Op];
+type ClickHouseClient = NodeClickHouseClient | WebClickHouseClient;
+type ScalarAlias<Alias extends string> = Alias extends `${string} ${string}` ? never : Alias;
+export interface ExecuteOptions {
+    queryId?: string;
+    cache?: CacheOptions | false;
+}
+/**
+ * Configuration for client-based connections.
+ */
+export interface ClickHouseClientConfig extends BaseClickHouseClientConfigOptions {
+    /** Pre-configured ClickHouse client instance. */
+    client: ClickHouseClient;
+}
+/**
+ * Configuration options for ClickHouse connections.
+ * Either provide a client instance OR connection details, but not both.
+ */
+export type ClickHouseConfig = BaseClickHouseClientConfigOptions | ClickHouseClientConfig;
+/**
+ * Type guard to check if a config is a client-based configuration.
+ */
+export declare function isClientConfig(config: ClickHouseConfig): config is ClickHouseClientConfig;
+/**
+ * A type-safe query builder for ClickHouse databases.
+ * The builder carries a single state object that encodes scope, output, and schema metadata.
+ */
+export declare class QueryBuilder<Schema extends SchemaDefinition<Schema>, State extends BuilderState<Schema, string, any, keyof Schema, Partial<Record<string, keyof Schema>>>> {
+    private static relationships;
+    private config;
+    private tableName;
+    private state;
+    private formatter;
+    private aggregations;
+    private joins;
+    private filtering;
+    private analytics;
+    private executor;
+    private modifiers;
+    private crossFiltering;
+    private runtime;
+    private cacheOptions?;
+    constructor(tableName: string, state: State, runtime: QueryRuntimeContext);
+    private fork;
+    debug(): this;
+    cache(options: CacheOptions | false): this;
+    withCTE(alias: string, subquery: QueryBuilder<any, AnyBuilderState> | string): this;
+    withScalar<Alias extends string, TValue>(alias: ScalarAlias<Alias>, expressionBuilder: (expr: PredicateBuilder<State>) => PredicateExpression<TValue>): QueryBuilder<Schema, AddScalar<State, Alias, TValue>>;
+    /**
+   * Groups results by a time interval using a specified ClickHouse function.
+   *
+   * @param column - The column containing the date or timestamp.
+   * @param interval - The interval value. For example, "1 day" or "15 minute".
+   *                   This is only used when the method is 'toStartOfInterval'.
+   * @param method - The time bucketing function to use.
+   *                 Defaults to 'toStartOfInterval'.
+   *                 Other valid values include 'toStartOfMinute', 'toStartOfHour',
+   *                 'toStartOfDay', 'toStartOfWeek', 'toStartOfMonth', 'toStartOfQuarter', and 'toStartOfYear'.
+   * @returns The current QueryBuilder instance.
+   */
+    groupByTimeInterval(column: SelectableColumn<State>, interval: string, method?: 'toStartOfInterval' | 'toStartOfMinute' | 'toStartOfHour' | 'toStartOfDay' | 'toStartOfWeek' | 'toStartOfMonth' | 'toStartOfQuarter' | 'toStartOfYear'): this;
+    raw(sql: string): this;
+    settings(opts: ClickHouseSettings): this;
+    /**
+     * Applies a set of cross filters to the current query.
+     * All filter conditions from the provided CrossFilter are added to the query.
+     * @param crossFilter - An instance of CrossFilter containing shared filter conditions.
+     * @returns The current QueryBuilder instance.
+     */
+    applyCrossFilters<TableName extends Extract<keyof Schema, string>>(crossFilter: CrossFilter<Schema, TableName>): this;
+    applyCrossFilters(crossFilter: CrossFilter<AnySchema, string>): this;
+    /**
+     * Selects specific columns from the table.
+     * @template K - The keys/columns to select
+     * @param {K[] | '*'} columnsOrAsterisk - Array of column names to select or '*' for all columns
+     * @returns {QueryBuilder} A new QueryBuilder instance with updated types
+     * @example
+     * ```ts
+     * builder.select(['id', 'name'])
+     * builder.select('*')
+     * ```
+     */
+    select(columnsOrAsterisk: '*'): QueryBuilder<Schema, UpdateOutput<State, BaseRow<State>>>;
+    select<Selections extends ReadonlyArray<SelectableItem<State>>>(columnsOrAsterisk: Selections): QueryBuilder<Schema, UpdateOutput<State, SelectionResult<State, Selections[number]>>>;
+    selectConst<Selections extends ReadonlyArray<SelectableItem<State>>>(...columns: Selections): QueryBuilder<Schema, UpdateOutput<State, SelectionResult<State, Selections[number]>>>;
+    sum<Column extends keyof BaseRow<State>, Alias extends string = `${Column & string}_sum`>(column: Column, alias?: Alias): QueryBuilder<Schema, AppendToOutput<State, Record<Alias, string>>>;
+    count<Column extends keyof BaseRow<State>, Alias extends string = `${Column & string}_count`>(column: Column, alias?: Alias): QueryBuilder<Schema, AppendToOutput<State, Record<Alias, string>>>;
+    avg<Column extends keyof BaseRow<State>, Alias extends string = `${Column & string}_avg`>(column: Column, alias?: Alias): QueryBuilder<Schema, AppendToOutput<State, Record<Alias, string>>>;
+    min<Column extends keyof BaseRow<State>, Alias extends string = `${Column & string}_min`>(column: Column, alias?: Alias): QueryBuilder<Schema, AppendToOutput<State, Record<Alias, string>>>;
+    max<Column extends keyof BaseRow<State>, Alias extends string = `${Column & string}_max`>(column: Column, alias?: Alias): QueryBuilder<Schema, AppendToOutput<State, Record<Alias, string>>>;
+    private applyAggregation;
+    getTableName(): string;
+    getFormatter(): SQLFormatter;
+    getRuntimeContext(): QueryRuntimeContext;
+    getCacheOptions(): CacheOptions | undefined;
+    getExecutor(): ExecutorFeature<Schema, State>;
+    toSQL(): string;
+    toSQLWithParams(): {
+        sql: string;
+        parameters: any[];
+    };
+    execute(options?: ExecuteOptions): Promise<State['output'][]>;
+    stream(): Promise<ReadableStream<State['output'][]>>;
+    /**
+     * Processes each row in a stream with the provided callback function
+     * @param callback Function to call for each row in the stream
+     */
+    streamForEach<R = void>(callback: (row: State['output']) => R | Promise<R>): Promise<void>;
+    private validateFilterValue;
+    /**
+     * Adds a WHERE clause to filter results.
+     * @template K - The column key type
+     * @param {K} column - The column to filter on
+     * @param {FilterOperator} operator - The comparison operator
+     * @param {any} value - The value to compare against
+     * @returns {this} The current QueryBuilder instance
+     * @example
+     * ```ts
+     * builder.where('age', 'gt', 18)
+     * ```
+     */
+    where(expressionBuilder: (expr: PredicateBuilder<State>) => PredicateExpression): this;
+    where<Column extends WhereColumn<State>, Op extends keyof OperatorValueMap<any, Schema>>(columnOrColumns: Column | Column[], operator: Op, value: ColumnOperatorValue<Schema, State, Column, Op>): this;
+    /**
+     * Adds a WHERE clause for tuple IN operations.
+     * @template K - The column keys type
+     * @param {K[]} columns - The columns to filter on (for tuple operations)
+     * @param {'inTuple' | 'globalInTuple'} operator - The tuple IN operator
+     * @param {any} value - The array of tuples to compare against
+     * @returns {this} The current QueryBuilder instance
+     * @example
+     * ```ts
+     * builder.where(['counter_id', 'user_id'], 'inTuple', [[34, 123], [101500, 456]])
+     * ```
+     */
+    where<Column extends WhereColumn<State>>(columns: Column[], operator: 'inTuple' | 'globalInTuple', value: any): this;
+    orWhere(expressionBuilder: (expr: PredicateBuilder<State>) => PredicateExpression): this;
+    orWhere<Column extends WhereColumn<State>>(column: Column, operator: FilterOperator, value: any): this;
+    orWhere<Column extends WhereColumn<State>>(columns: Column[], operator: 'inTuple' | 'globalInTuple', value: any): this;
+    /**
+     * Creates a parenthesized group of WHERE conditions joined with AND/OR operators.
+     * @param {Function} callback - Function that builds the conditions within the group
+     * @returns {this} The current QueryBuilder instance
+     * @example
+     * ```ts
+     * builder.whereGroup(qb => {
+     *   qb.where('status', 'eq', 'active').orWhere('status', 'eq', 'pending');
+     * })
+     * ```
+     */
+    whereGroup(callback: (builder: this) => void): this;
+    /**
+     * Creates a parenthesized group of WHERE conditions joined with OR operator.
+     * @param {Function} callback - Function that builds the conditions within the group
+     * @returns {this} The current QueryBuilder instance
+     * @example
+     * ```ts
+     * builder.orWhereGroup(qb => {
+     *   qb.where('status', 'eq', 'active').orWhere('status', 'eq', 'pending');
+     * })
+     * ```
+     */
+    orWhereGroup(callback: (builder: this) => void): this;
+    /**
+     * Adds a GROUP BY clause.
+     * @param {keyof T | Array<keyof T>} columns - Column(s) to group by
+     * @returns {this} The current QueryBuilder instance
+     * @example
+     * ```ts
+     * builder.groupBy(['category', 'status'])
+     * ```
+     */
+    groupBy(columns: SelectableColumn<State> | Array<SelectableColumn<State>>): this;
+    limit(count: number): this;
+    offset(count: number): this;
+    /**
+     * Adds an ORDER BY clause.
+     * @param {keyof T} column - The column to order by
+     * @param {OrderDirection} [direction='ASC'] - The sort direction
+     * @returns {this} The current QueryBuilder instance
+     * @example
+     * ```ts
+     * builder.orderBy('created_at', 'DESC')
+     * ```
+     */
+    orderBy(column: SelectableColumn<State>, direction?: OrderDirection): this;
+    /**
+     * Adds a HAVING clause for filtering grouped results.
+     * @param {string} condition - The HAVING condition
+     * @returns {this} The current QueryBuilder instance
+     * @example
+     * ```ts
+     * builder.having('COUNT(*) > 5')
+     * ```
+     */
+    having(condition: string, parameters?: any[]): this;
+    distinct(): this;
+    whereBetween<Column extends keyof BaseRow<State>>(column: Column, [min, max]: [BaseRow<State>[Column], BaseRow<State>[Column]]): this;
+    innerJoin<TableName extends Extract<keyof Schema, string>, Alias extends string | undefined = undefined>(table: TableName, leftColumn: keyof BaseRow<State>, rightColumn: `${TableName & string}.${keyof Schema[TableName] & string}`, alias?: Alias): QueryBuilder<Schema, Alias extends string ? AddAlias<WidenTables<State, TableName>, Alias, TableName> : WidenTables<State, TableName>>;
+    leftJoin<TableName extends Extract<keyof Schema, string>, Alias extends string | undefined = undefined>(table: TableName, leftColumn: keyof BaseRow<State>, rightColumn: `${TableName & string}.${keyof Schema[TableName] & string}`, alias?: Alias): QueryBuilder<Schema, Alias extends string ? AddAlias<WidenTables<State, TableName>, Alias, TableName> : WidenTables<State, TableName>>;
+    rightJoin<TableName extends Extract<keyof Schema, string>, Alias extends string | undefined = undefined>(table: TableName, leftColumn: keyof BaseRow<State>, rightColumn: `${TableName & string}.${keyof Schema[TableName] & string}`, alias?: Alias): QueryBuilder<Schema, Alias extends string ? AddAlias<WidenTables<State, TableName>, Alias, TableName> : WidenTables<State, TableName>>;
+    fullJoin<TableName extends Extract<keyof Schema, string>, Alias extends string | undefined = undefined>(table: TableName, leftColumn: keyof BaseRow<State>, rightColumn: `${TableName & string}.${keyof Schema[TableName] & string}`, alias?: Alias): QueryBuilder<Schema, Alias extends string ? AddAlias<WidenTables<State, TableName>, Alias, TableName> : WidenTables<State, TableName>>;
+    private applyJoin;
+    getConfig(): QueryConfig<State["output"], Schema>;
+    static setJoinRelationships<S extends SchemaDefinition<S>>(relationships: JoinRelationships<S>): void;
+    /**
+     * Apply a predefined join relationship
+     */
+    withRelation(name: string, options?: JoinPathOptions): this;
+}
+export type SelectQB<Schema extends SchemaDefinition<Schema>, Tables extends string, Output, BaseTable extends keyof Schema> = QueryBuilder<Schema, BuilderState<Schema, Tables, Output, BaseTable, {}>>;
+export type CreateQueryBuilderConfig = ClickHouseConfig & {
+    cache?: CacheConfig;
+};
+export declare function createQueryBuilder<Schema extends SchemaDefinition<Schema>>(config: CreateQueryBuilderConfig): {
+    cache: import("./cache/controller.js").CacheController;
+    rawQuery<TResult = any>(sql: string, params?: unknown[]): Promise<TResult[][]>;
+    table<TableName extends Extract<keyof Schema, string>>(tableName: TableName): SelectQB<Schema, TableName, InitialState<Schema, TableName>["output"], TableName>;
+};
+export {};
+//# sourceMappingURL=query-builder.d.ts.map

package/dist/core/query-builder.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"query-builder.d.ts","sourceRoot":"","sources":["../../src/core/query-builder.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,WAAW,EAAE,MAAM,mBAAmB,CAAC;AAChD,OAAO,EACL,cAAc,EACd,gBAAgB,EAChB,cAAc,EACd,WAAW,EAEZ,MAAM,mBAAmB,CAAC;AAC3B,OAAO,EAAE,SAAS,EAAc,MAAM,oBAAoB,CAAC;AAC3D,OAAO,EAAE,YAAY,EAAE,MAAM,+BAA+B,CAAC;AAK7D,OAAO,EAAE,eAAe,EAAE,MAAM,wBAAwB,CAAC;AAGzD,OAAO,EAAE,iBAAiB,EAAE,eAAe,EAAiB,MAAM,yBAAyB,CAAC;AAE5F,OAAO,EACL,gBAAgB,EAChB,mBAAmB,EAEpB,MAAM,8BAA8B,CAAC;AAEtC,OAAO,KAAK,EAAE,kBAAkB,EAAE,iCAAiC,EAAE,MAAM,2BAA2B,CAAC;AACvG,OAAO,KAAK,EAAE,gBAAgB,IAAI,oBAAoB,EAAE,MAAM,oBAAoB,CAAC;AACnF,OAAO,KAAK,EAAE,gBAAgB,IAAI,mBAAmB,EAAE,MAAM,wBAAwB,CAAC;AACtF,OAAO,KAAK,EAAE,YAAY,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAC;AAClE,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,4BAA4B,CAAC;AAItE,OAAO,KAAK,EACV,YAAY,EACZ,eAAe,EACf,gBAAgB,EAChB,YAAY,EACZ,YAAY,EACZ,WAAW,EACX,cAAc,EACd,OAAO,EACP,QAAQ,EACR,SAAS,EACV,MAAM,0BAA0B,CAAC;AAClC,OAAO,EACL,cAAc,EACd,gBAAgB,EAChB,eAAe,EACf,oBAAoB,EACrB,MAAM,yBAAyB,CAAC;AAEjC,KAAK,WAAW,CAAC,KAAK,SAAS,eAAe,IAAI,gBAAgB,CAAC,KAAK,CAAC,CAAC;AAE1E,KAAK,mBAAmB,CACtB,MAAM,SAAS,gBAAgB,CAAC,MAAM,CAAC,EACvC,KAAK,SAAS,YAAY,CAAC,MAAM,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,MAAM,EAAE,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,MAAM,CAAC,CAAC,CAAC,EACpG,MAAM,SAAS,WAAW,CAAC,KAAK,CAAC,EACjC,EAAE,SAAS,MAAM,gBAAgB,CAAC,GAAG,EAAE,MAAM,CAAC,IAC5C,gBAAgB,CAAC,oBAAoB,CAAC,KAAK,EAAE,MAAM,CAAC,EAAE,MAAM,CAAC,CAAC,EAAE,CAAC,CAAC;AAGtE,KAAK,gBAAgB,GAAG,oBAAoB,GAAG,mBAAmB,CAAC;AACnE,KAAK,WAAW,CAAC,KAAK,SAAS,MAAM,IAAI,KAAK,SAAS,GAAG,MAAM,IAAI,MAAM,EAAE,GAAG,KAAK,GAAG,KAAK,CAAC;AAE7F,MAAM,WAAW,cAAc;IAC7B,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,KAAK,CAAC,EAAE,YAAY,GAAG,KAAK,CAAC;CAC9B;AAED;;GAEG;AACH,MAAM,WAAW,sBAAuB,SAAQ,iCAAiC;IAC/E,iDAAiD;IACjD,MAAM,EAAE,gBAAgB,CAAC;CAC1B;AAED;;;GAGG;AACH,MAAM,MAAM,gBAAgB,GAAG,iCAAiC,GAAG,sBAAsB,CAAC;AAE1F;;GAEG;AACH,wBAAgB,cAAc,CAAC,MAAM,EAAE,gBAAgB,GAAG,MAAM,IAAI,sBAAsB,CAEzF;AAED;;;GAGG;AACH,qBAAa,YAAY,CACvB,MAAM,SAAS,gBAAgB,CAAC,MAAM,CAAC,EACvC,KAAK,SAAS,YAAY,CAAC,MAAM,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,MAAM,EAAE,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,MAAM,CAAC,CAAC,CAAC;IAEpG,OAAO,CAAC,MAAM,CAAC,aAAa,CAAyB;IAErD,OAAO,CAAC,MAAM,CAA4C;IAC1D,OAAO,CAAC,SAAS,CAAS;IAC1B,OAAO,CAAC,KAAK,CAAQ;IACrB,OAAO,CAAC,SAAS,CAAsB;IACvC,OAAO,CAAC,YAAY,CAAoC;IACxD,OAAO,CAAC,KAAK,CAA6B;IAC1C,OAAO,CAAC,SAAS,CAAkC;IACnD,OAAO,CAAC,SAAS,CAAkC;IACnD,OAAO,CAAC,QAAQ,CAAiC;IACjD,OAAO,CAAC,SAAS,CAAuC;IACxD,OAAO,CAAC,cAAc,CAAuC;IAC7D,OAAO,CAAC,OAAO,CAAsB;IACrC,OAAO,CAAC,YAAY,CAAC,CAAe;gBAGlC,SAAS,EAAE,MAAM,EACjB,KAAK,EAAE,KAAK,EACZ,OAAO,EAAE,mBAAmB;IAc9B,OAAO,CAAC,IAAI;IAkBZ,KAAK;IAQL,KAAK,CAAC,OAAO,EAAE,YAAY,GAAG,KAAK,GAAG,IAAI;IAU1C,OAAO,CACL,KAAK,EAAE,MAAM,EACb,QAAQ,EAAE,YAAY,CAAC,GAAG,EAAE,eAAe,CAAC,GAAG,MAAM,GACpD,IAAI;IAMP,UAAU,CAAC,KAAK,SAAS,MAAM,EAAE,MAAM,EACrC,KAAK,EAAE,WAAW,CAAC,KAAK,CAAC,EACzB,iBAAiB,EAAE,CAAC,IAAI,EAAE,gBAAgB,CAAC,KAAK,CAAC,KAAK,mBAAmB,CAAC,MAAM,CAAC,GAChF,YAAY,CAAC,MAAM,EAAE,SAAS,CAAC,KAAK,EAAE,KAAK,EAAE,MAAM,CAAC,CAAC;IA6BxD;;;;;;;;;;;KAWC;IACD,mBAAmB,CACjB,MAAM,EAAE,gBAAgB,CAAC,KAAK,CAAC,EAC/B,QAAQ,EAAE,MAAM,EAChB,MAAM,GAAE,mBAAmB,GAAG,iBAAiB,GAAG,eAAe,GAAG,cAAc,GAAG,eAAe,GAAG,gBAAgB,GAAG,kBAAkB,GAAG,eAAqC,GACnL,IAAI;IAMP,GAAG,CAAC,GAAG,EAAE,MAAM,GAAG,IAAI;IAStB,QAAQ,CAAC,IAAI,EAAE,kBAAkB,GAAG,IAAI;IAKxC;;;;;OAKG;IACH,iBAAiB,CAAC,SAAS,SAAS,OAAO,CAAC,MAAM,MAAM,EAAE,MAAM,CAAC,EAAE,WAAW,EAAE,WAAW,CAAC,MAAM,EAAE,SAAS,CAAC,GAAG,IAAI;IACrH,iBAAiB,CAAC,WAAW,EAAE,WAAW,CAAC,SAAS,EAAE,MAAM,CAAC,GAAG,IAAI;IAUpE;;;;;;;;;;OAUG;IACH,MAAM,CAAC,iBAAiB,EAAE,GAAG,GAAG,YAAY,CAAC,MAAM,EAAE,YAAY,CAAC,KAAK,EAAE,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC;IACzF,MAAM,CAAC,UAAU,SAAS,aAAa,CAAC,cAAc,CAAC,KAAK,CAAC,CAAC,EAC5D,iBAAiB,EAAE,UAAU,GAC5B,YAAY,CAAC,MAAM,EAAE,YAAY,CAAC,KAAK,EAAE,eAAe,CAAC,KAAK,EAAE,UAAU,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC;IAgDxF,WAAW,CAAC,UAAU,SAAS,aAAa,CAAC,cAAc,CAAC,KAAK,CAAC,CAAC,EACjE,GAAG,OAAO,EAAE,UAAU,GACrB,YAAY,CAAC,MAAM,EAAE,YAAY,CAAC,KAAK,EAAE,eAAe,CAAC,KAAK,EAAE,UAAU,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC;IAIxF,GAAG,CAAC,MAAM,SAAS,MAAM,OAAO,CAAC,KAAK,CAAC,EAAE,KAAK,SAAS,MAAM,GAAG,GAAG,MAAM,GAAG,MAAM,MAAM,EACtF,MAAM,EAAE,MAAM,EACd,KAAK,CAAC,EAAE,KAAK,GACZ,YAAY,CAAC,MAAM,EAAE,cAAc,CAAC,KAAK,EAAE,MAAM,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC,CAAC;IAMrE,KAAK,CAAC,MAAM,SAAS,MAAM,OAAO,CAAC,KAAK,CAAC,EAAE,KAAK,SAAS,MAAM,GAAG,GAAG,MAAM,GAAG,MAAM,QAAQ,EAC1F,MAAM,EAAE,MAAM,EACd,KAAK,CAAC,EAAE,KAAK,GACZ,YAAY,CAAC,MAAM,EAAE,cAAc,CAAC,KAAK,EAAE,MAAM,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC,CAAC;IAMrE,GAAG,CAAC,MAAM,SAAS,MAAM,OAAO,CAAC,KAAK,CAAC,EAAE,KAAK,SAAS,MAAM,GAAG,GAAG,MAAM,GAAG,MAAM,MAAM,EACtF,MAAM,EAAE,MAAM,EACd,KAAK,CAAC,EAAE,KAAK,GACZ,YAAY,CAAC,MAAM,EAAE,cAAc,CAAC,KAAK,EAAE,MAAM,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC,CAAC;IAMrE,GAAG,CAAC,MAAM,SAAS,MAAM,OAAO,CAAC,KAAK,CAAC,EAAE,KAAK,SAAS,MAAM,GAAG,GAAG,MAAM,GAAG,MAAM,MAAM,EACtF,MAAM,EAAE,MAAM,EACd,KAAK,CAAC,EAAE,KAAK,GACZ,YAAY,CAAC,MAAM,EAAE,cAAc,CAAC,KAAK,EAAE,MAAM,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC,CAAC;IAMrE,GAAG,CAAC,MAAM,SAAS,MAAM,OAAO,CAAC,KAAK,CAAC,EAAE,KAAK,SAAS,MAAM,GAAG,GAAG,MAAM,GAAG,MAAM,MAAM,EACtF,MAAM,EAAE,MAAM,EACd,KAAK,CAAC,EAAE,KAAK,GACZ,YAAY,CAAC,MAAM,EAAE,cAAc,CAAC,KAAK,EAAE,MAAM,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC,CAAC;IAMrE,OAAO,CAAC,gBAAgB;IAoBxB,YAAY;IAIZ,YAAY;IAIZ,iBAAiB;IAIjB,eAAe;IAIf,WAAW;IAKX,KAAK,IAAI,MAAM;IAIf,eAAe,IAAI;QAAE,GAAG,EAAE,MAAM,CAAC;QAAC,UAAU,EAAE,GAAG,EAAE,CAAA;KAAE;IAIrD,OAAO,CAAC,OAAO,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,KAAK,CAAC,QAAQ,CAAC,EAAE,CAAC;IAIvD,MAAM,IAAI,OAAO,CAAC,cAAc,CAAC,KAAK,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC;IAI1D;;;OAGG;IACG,aAAa,CAAC,CAAC,GAAG,IAAI,EAAE,QAAQ,EAAE,CAAC,GAAG,EAAE,KAAK,CAAC,QAAQ,CAAC,KAAK,CAAC,GAAG,OAAO,CAAC,CAAC,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC;IAkBhG,OAAO,CAAC,mBAAmB;IAgC3B;;;;;;;;;;;OAWG;IACH,KAAK,CACH,iBAAiB,EAAE,CAAC,IAAI,EAAE,gBAAgB,CAAC,KAAK,CAAC,KAAK,mBAAmB,GACxE,IAAI;IACP,KAAK,CAAC,MAAM,SAAS,WAAW,CAAC,KAAK,CAAC,EAAE,EAAE,SAAS,MAAM,gBAAgB,CAAC,GAAG,EAAE,MAAM,CAAC,EACrF,eAAe,EAAE,MAAM,GAAG,MAAM,EAAE,EAClC,QAAQ,EAAE,EAAE,EACZ,KAAK,EAAE,mBAAmB,CAAC,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,EAAE,CAAC,GACpD,IAAI;IACP;;;;;;;;;;;OAWG;IACH,KAAK,CAAC,MAAM,SAAS,WAAW,CAAC,KAAK,CAAC,EACrC,OAAO,EAAE,MAAM,EAAE,EACjB,QAAQ,EAAE,SAAS,GAAG,eAAe,EACrC,KAAK,EAAE,GAAG,GACT,IAAI;IA8BP,OAAO,CACL,iBAAiB,EAAE,CAAC,IAAI,EAAE,gBAAgB,CAAC,KAAK,CAAC,KAAK,mBAAmB,GACxE,IAAI;IACP,OAAO,CAAC,MAAM,SAAS,WAAW,CAAC,KAAK,CAAC,EACvC,MAAM,EAAE,MAAM,EACd,QAAQ,EAAE,cAAc,EACxB,KAAK,EAAE,GAAG,GACT,IAAI;IACP,OAAO,CAAC,MAAM,SAAS,WAAW,CAAC,KAAK,CAAC,EACvC,OAAO,EAAE,MAAM,EAAE,EACjB,QAAQ,EAAE,SAAS,GAAG,eAAe,EACrC,KAAK,EAAE,GAAG,GACT,IAAI;IA6BP;;;;;;;;;;OAUG;IACH,UAAU,CAAC,QAAQ,EAAE,CAAC,OAAO,EAAE,IAAI,KAAK,IAAI,GAAG,IAAI;IAOnD;;;;;;;;;;OAUG;IACH,YAAY,CAAC,QAAQ,EAAE,CAAC,OAAO,EAAE,IAAI,KAAK,IAAI,GAAG,IAAI;IAOrD;;;;;;;;OAQG;IACH,OAAO,CAAC,OAAO,EAAE,gBAAgB,CAAC,KAAK,CAAC,GAAG,KAAK,CAAC,gBAAgB,CAAC,KAAK,CAAC,CAAC,GAAG,IAAI;IAMhF,KAAK,CAAC,KAAK,EAAE,MAAM,GAAG,IAAI;IAK1B,MAAM,CAAC,KAAK,EAAE,MAAM,GAAG,IAAI;IAK3B;;;;;;;;;OASG;IACH,OAAO,CACL,MAAM,EAAE,gBAAgB,CAAC,KAAK,CAAC,EAC/B,SAAS,GAAE,cAAsB,GAChC,IAAI;IAKP;;;;;;;;OAQG;IACH,MAAM,CAAC,SAAS,EAAE,MAAM,EAAE,UAAU,CAAC,EAAE,GAAG,EAAE,GAAG,IAAI;IAKnD,QAAQ,IAAI,IAAI;IAKhB,YAAY,CAAC,MAAM,SAAS,MAAM,OAAO,CAAC,KAAK,CAAC,EAC9C,MAAM,EAAE,MAAM,EACd,CAAC,GAAG,EAAE,GAAG,CAAC,EAAE,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,MAAM,CAAC,EAAE,OAAO,CAAC,KAAK,CAAC,CAAC,MAAM,CAAC,CAAC,GAC3D,IAAI;IAOP,SAAS,CAAC,SAAS,SAAS,OAAO,CAAC,MAAM,MAAM,EAAE,MAAM,CAAC,EAAE,KAAK,SAAS,MAAM,GAAG,SAAS,GAAG,SAAS,EACrG,KAAK,EAAE,SAAS,EAChB,UAAU,EAAE,MAAM,OAAO,CAAC,KAAK,CAAC,EAChC,WAAW,EAAE,GAAG,SAAS,GAAG,MAAM,IAAI,MAAM,MAAM,CAAC,SAAS,CAAC,GAAG,MAAM,EAAE,EACxE,KAAK,CAAC,EAAE,KAAK,GACZ,YAAY,CACb,MAAM,EACN,KAAK,SAAS,MAAM,GAClB,QAAQ,CAAC,WAAW,CAAC,KAAK,EAAE,SAAS,CAAC,EAAE,KAAK,EAAE,SAAS,CAAC,GACzD,WAAW,CAAC,KAAK,EAAE,SAAS,CAAC,CAChC;IAID,QAAQ,CAAC,SAAS,SAAS,OAAO,CAAC,MAAM,MAAM,EAAE,MAAM,CAAC,EAAE,KAAK,SAAS,MAAM,GAAG,SAAS,GAAG,SAAS,EACpG,KAAK,EAAE,SAAS,EAChB,UAAU,EAAE,MAAM,OAAO,CAAC,KAAK,CAAC,EAChC,WAAW,EAAE,GAAG,SAAS,GAAG,MAAM,IAAI,MAAM,MAAM,CAAC,SAAS,CAAC,GAAG,MAAM,EAAE,EACxE,KAAK,CAAC,EAAE,KAAK,GACZ,YAAY,CACb,MAAM,EACN,KAAK,SAAS,MAAM,GAClB,QAAQ,CAAC,WAAW,CAAC,KAAK,EAAE,SAAS,CAAC,EAAE,KAAK,EAAE,SAAS,CAAC,GACzD,WAAW,CAAC,KAAK,EAAE,SAAS,CAAC,CAChC;IAID,SAAS,CAAC,SAAS,SAAS,OAAO,CAAC,MAAM,MAAM,EAAE,MAAM,CAAC,EAAE,KAAK,SAAS,MAAM,GAAG,SAAS,GAAG,SAAS,EACrG,KAAK,EAAE,SAAS,EAChB,UAAU,EAAE,MAAM,OAAO,CAAC,KAAK,CAAC,EAChC,WAAW,EAAE,GAAG,SAAS,GAAG,MAAM,IAAI,MAAM,MAAM,CAAC,SAAS,CAAC,GAAG,MAAM,EAAE,EACxE,KAAK,CAAC,EAAE,KAAK,GACZ,YAAY,CACb,MAAM,EACN,KAAK,SAAS,MAAM,GAClB,QAAQ,CAAC,WAAW,CAAC,KAAK,EAAE,SAAS,CAAC,EAAE,KAAK,EAAE,SAAS,CAAC,GACzD,WAAW,CAAC,KAAK,EAAE,SAAS,CAAC,CAChC;IAID,QAAQ,CAAC,SAAS,SAAS,OAAO,CAAC,MAAM,MAAM,EAAE,MAAM,CAAC,EAAE,KAAK,SAAS,MAAM,GAAG,SAAS,GAAG,SAAS,EACpG,KAAK,EAAE,SAAS,EAChB,UAAU,EAAE,MAAM,OAAO,CAAC,KAAK,CAAC,EAChC,WAAW,EAAE,GAAG,SAAS,GAAG,MAAM,IAAI,MAAM,MAAM,CAAC,SAAS,CAAC,GAAG,MAAM,EAAE,EACxE,KAAK,CAAC,EAAE,KAAK,GACZ,YAAY,CACb,MAAM,EACN,KAAK,SAAS,MAAM,GAClB,QAAQ,CAAC,WAAW,CAAC,KAAK,EAAE,SAAS,CAAC,EAAE,KAAK,EAAE,SAAS,CAAC,GACzD,WAAW,CAAC,KAAK,EAAE,SAAS,CAAC,CAChC;IAID,OAAO,CAAC,SAAS;IAyBjB,SAAS;IAIT,MAAM,CAAC,oBAAoB,CAAC,CAAC,SAAS,gBAAgB,CAAC,CAAC,CAAC,EACvD,aAAa,EAAE,iBAAiB,CAAC,CAAC,CAAC,GAClC,IAAI;IAIP;;OAEG;IACH,YAAY,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,eAAe,GAAG,IAAI;CA2B5D;AAED,MAAM,MAAM,QAAQ,CAClB,MAAM,SAAS,gBAAgB,CAAC,MAAM,CAAC,EACvC,MAAM,SAAS,MAAM,EACrB,MAAM,EACN,SAAS,SAAS,MAAM,MAAM,IAC5B,YAAY,CAAC,MAAM,EAAE,YAAY,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,SAAS,EAAE,EAAE,CAAC,CAAC,CAAC;AAE9E,MAAM,MAAM,wBAAwB,GAAG,gBAAgB,GAAG;IACxD,KAAK,CAAC,EAAE,WAAW,CAAC;CACrB,CAAC;AAYF,wBAAgB,kBAAkB,CAAC,MAAM,SAAS,gBAAgB,CAAC,MAAM,CAAC,EACxE,MAAM,EAAE,wBAAwB;;aAUf,OAAO,aAAa,MAAM,WAAU,OAAO,EAAE;UAStD,SAAS,SAAS,OAAO,CAAC,MAAM,MAAM,EAAE,MAAM,CAAC,aAAa,SAAS,GAAG,QAAQ,CACpF,MAAM,EACN,SAAS,EACT,YAAY,CAAC,MAAM,EAAE,SAAS,CAAC,CAAC,QAAQ,CAAC,EACzC,SAAS,CACV;EAcJ"}