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

    Interface ConnectionRequestMessage

    Request sent by a client to open a Quack connection.

    interface ConnectionRequestMessage {
        authString?: string;
        clientDuckdbVersion?: string;
        clientId?: string;
        clientPlatform?: string;
        clientQueryId?: bigint;
        connectionId?: string;
        heartbeatTimeoutSeconds?: number | bigint;
        maxSupportedQuackVersion?: number | bigint;
        minSupportedQuackVersion?: number | bigint;
        type: CONNECTION_REQUEST;
    }

    Hierarchy (View Summary)

    Index

    Properties

    authString? clientDuckdbVersion? clientId? clientPlatform? clientQueryId? connectionId? heartbeatTimeoutSeconds? maxSupportedQuackVersion? minSupportedQuackVersion? type

    Properties

    authString?: string

    Optional authentication token.

    clientDuckdbVersion?: string

    Optional client DuckDB version.

    clientId?: string

    Optional stable client identifier used by the server for reconnects; at least 4 characters.

    clientPlatform?: string

    Optional client platform string.

    clientQueryId?: bigint

    Client-assigned query/request id.

    connectionId?: string

    Server-assigned connection id for connection-scoped messages.

    heartbeatTimeoutSeconds?: number | bigint

    Requested heartbeat lease timeout in seconds. The server rejects 0.

    maxSupportedQuackVersion?: number | bigint

    Maximum supported Quack protocol version.

    minSupportedQuackVersion?: number | bigint

    Minimum supported Quack protocol version.

    type: CONNECTION_REQUEST

    Concrete message type id.

    Settings

    Member Visibility

    On This Page

    Properties