Skip to content

ClickhouseClient

13 exports Added in v1.0.0 Source

Compiler

makeCompiler

Added in v1.0.0 Source

Signature

declare function makeCompiler(transform?: (_: string) => string): any;

Constructors

ClickhouseClientConfig interface

Added in v1.0.0 Source

Signature

interface ClickhouseClientConfig extends unknown {
  readonly spanAttributes?: Record<string, unknown>;
  readonly transformQueryNames?: (str: string) => string;
  readonly transformResultNames?: (str: string) => string;
}

make

Added in v1.0.0 Source

Signature

declare function make(options: ClickhouseClientConfig): Effect<ClickhouseClient, SqlError, any>;

Custom Types

ClickhouseCustom type

Added in v1.0.0 Source

Signature

type ClickhouseCustom = ClickhouseParam;

Fiber Refs

Signature

declare const currentClickhouseSettings: FiberRef.FiberRef<
  NonNullable<Clickhouse.BaseQueryParams["clickhouse_settings"]>
>;

Signature

declare const currentClientMethod: FiberRef.FiberRef<"query" | "command" | "insert">;

Signature

declare const currentQueryId: FiberRef.FiberRef<string | undefined>;

Layers

layer

Added in v1.0.0 Source

Signature

declare function layer(config: ClickhouseClientConfig): Layer<any, any>;

layerConfig

Added in v1.0.0 Source

Signature

declare function layerConfig(config: Wrap<ClickhouseClientConfig>): Layer<any, any>;

Models

ClickhouseClient interface

Added in v1.0.0 Source

Signature

interface ClickhouseClient extends unknown {
  readonly [TypeId]: typeof TypeId;
  readonly asCommand: <A, E, R>(effect: Effect<A, E, R>) => Effect<A, E, R>;
  readonly config: ClickhouseClientConfig;
  readonly insertQuery: <T = unknown>(options: {
    readonly format?: any;
    readonly table: string;
    readonly values: InsertValues<Readable, T>;
  }) => Effect<InsertResult, SqlError>;
  readonly param: (dataType: string, value: unknown) => Fragment;
  readonly withClickhouseSettings: {
    (settings: any): <A, E, R>(effect: Effect<A, E, R>) => Effect<A, E, R>;
    <A, E, R>(effect: Effect<A, E, R>, settings: any): Effect<A, E, R>;
  };
  readonly withQueryId: {
    (queryId: string): <A, E, R>(effect: Effect<A, E, R>) => Effect<A, E, R>;
    <A, E, R>(effect: Effect<A, E, R>, queryId: string): Effect<A, E, R>;
  };
}

Tags

Signature

declare const ClickhouseClient: any;

Type Ids

TypeId

Added in v1.0.0 Source

Signature

declare const TypeId: unique symbol;

TypeId type

Added in v1.0.0 Source

Signature

type TypeId = typeof TypeId;