@quack-protocol/sdk - v0.3.0
    Preparing search index...

    Interface QuackClientOptions

    Options used when opening a Quack connection.

    interface QuackClientOptions {
        acknowledgeResults?: boolean;
        authToken?: string;
        clientDuckdbVersion?: string;
        clientId?: string;
        clientPlatform?: string;
        fetch?: (input: RequestInfo | URL, init?: RequestInit) => Promise<Response>;
        headers?: HeadersInit;
        heartbeat?: boolean;
        heartbeatTimeoutSeconds?: number;
        maxSupportedQuackVersion?: number | bigint;
        minSupportedQuackVersion?: number | bigint;
        signal?: AbortSignal;
        ssl?: boolean;
        timeoutMs?: number;
    }

    Hierarchy (View Summary)

    Index

    Properties

    acknowledgeResults? authToken? clientDuckdbVersion? clientId? clientPlatform? fetch? headers? heartbeat? heartbeatTimeoutSeconds? maxSupportedQuackVersion? minSupportedQuackVersion? signal? ssl? timeoutMs?

    Properties

    acknowledgeResults?: boolean

    Send an acknowledgement after each fully received result, releasing the server's reconnect cache (only used when the server enables quack_enable_reconnects). Defaults to false.

    authToken?: string

    Authentication token sent in the Quack connection request.

    clientDuckdbVersion?: string

    Optional client DuckDB version string advertised to the server.

    clientId?: string

    Optional stable client identifier sent to the server; at least 4 characters when set.

    clientPlatform?: string

    Optional client platform string advertised to the server.

    fetch?: (input: RequestInfo | URL, init?: RequestInit) => Promise<Response>

    Custom fetch implementation, useful for tests or non-standard runtimes.

    Type Declaration

      • (input: RequestInfo | URL, init?: RequestInit): Promise<Response>

      • MDN Reference

        Parameters

        • input: RequestInfo | URL
        • Optionalinit: RequestInit

        Returns Promise<Response>

    headers?: HeadersInit

    Extra HTTP headers merged into every Quack request.

    heartbeat?: boolean

    Send heartbeat requests while the connection is idle so the server keeps the lease alive. Defaults to true.

    heartbeatTimeoutSeconds?: number

    Heartbeat lease timeout in seconds requested from the server. Defaults to 60.

    maxSupportedQuackVersion?: number | bigint

    Maximum Quack protocol version supported by the client.

    minSupportedQuackVersion?: number | bigint

    Minimum Quack protocol version supported by the client.

    signal?: AbortSignal

    Abort signal passed through to the underlying fetch request.

    ssl?: boolean

    Transport for quack: and bare-host connection strings: true forces HTTPS, false forces HTTP. By default, like DuckDB, the client uses HTTP for localhost, 127.0.0.1, and ::1, and HTTPS for every other host. Ignored for http:// and https:// URLs.

    timeoutMs?: number

    Request timeout in milliseconds.

    Settings

    Member Visibility

    On This Page

    Properties