columna API reference - v0.4.0
    Preparing search index...

    Type Alias SqlConnectionConfig

    Structured connection settings (URL or discrete fields).

    type SqlConnectionConfig = {
        clickhouseUrl?: string;
        database?: string;
        dialect?: SqlDialect;
        filename?: string;
        host?: string;
        keepAlive?: boolean;
        options?: {
            encrypt?: boolean;
            instanceName?: string;
            trustServerCertificate?: boolean;
        };
        password?: string;
        port?: number;
        server?: string;
        url?: string;
        user?: string;
    }
    Index
    clickhouseUrl? database? dialect? filename? host? keepAlive? options? password? port? server? url? user?
    clickhouseUrl?: string

    ClickHouse HTTP url override (default builds from host/port).

    database?: string
    dialect?: SqlDialect
    filename?: string

    SQLite file path (:memory: allowed). Also accepted as database or bare string path ending in .db / .sqlite.

    host?: string
    keepAlive?: boolean

    Every readSql call with a URL / config opens a dedicated connection (or pool) and closes it afterwards; with keepAlive that connection is left open but nothing returns a handle to it, so it can only leak. To reuse a connection, open it once with openSqlClient() and pass the client to readSql, which never closes a client it did not open.

    options?: {
        encrypt?: boolean;
        instanceName?: string;
        trustServerCertificate?: boolean;
    }

    MS SQL / tedious extras.

    password?: string
    port?: number
    server?: string

    Alias of host for MS SQL configs.

    url?: string

    Connection URL, e.g. postgres://user:pass@host:5432/db.

    user?: string

    Settings
    Member Visibility

    On This Page
    Properties