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

    Module index

    TypeScript client and codecs for DuckDB's experimental Quack protocol.

    The root package exports the developer-friendly client API, row/chunk builders, logical type helpers, value helpers, and error classes.

    Enumerations

    ExtraTypeInfoType
    LogicalTypeId
    MessageType
    PhysicalType
    VectorType

    Classes

    ArrowTable
    BinaryReader
    BinaryWriter
    QuackClient
    QuackError
    QuackProtocolError
    QuackServerError
    QuackUnsupportedTypeError

    Interfaces

    AcknowledgementMessage
    AggregateStateTypeInfo
    AnyTypeInfo
    AppendArrowOptions
    AppendOptions
    AppendRowsOptions
    ArrayTypeInfo
    BaseMessage
    CancelRequestMessage
    ChildType
    ColumnDefinition
    ColumnInput
    ConnectionRequestMessage
    ConnectionResponseMessage
    CoordinateReferenceSystem
    DataChunkFromRowsOptions
    DateValue
    DecimalTypeInfo
    DecimalValue
    DecodedVector
    DisconnectMessage
    EnumTypeInfo
    ErrorResponseMessage
    FetchRequestMessage
    FetchResponseMessage
    GenericTypeInfo
    GeoTypeInfo
    HeartbeatRequestMessage
    HugeIntParts
    IntegerLiteralTypeInfo
    IntervalValue
    ListTypeInfo
    LogicalType
    MessageHeader
    ParsedQuackUri
    PrepareRequestMessage
    PrepareResponseMessage
    QuackArrowAppendOptions
    QuackArrowIPCOptions
    QuackArrowOptions
    QuackArrowQueryIPCOptions
    QuackArrowQueryOptions
    QuackArrowTableOptions
    QuackClientOptions
    QuackConnectionInfo
    QuackDataChunk
    QuackJsonOptions
    QuackQueryOptions
    QuackQueryResult
    QuackRequestOptions
    QuackServerErrorDetails
    SendDataRequestMessage
    SendDataResponseMessage
    StringTypeInfo
    StructTypeInfo
    SuccessResponseMessage
    TableReference
    TemplateTypeInfo
    TimestampValue
    TimeTzValue
    TimeValue
    UnboundTypeInfo

    Type Aliases

    ColumnSchema
    ExtraTypeInfo
    HugeIntLike
    NamedSqlParameters
    PositionalSqlParameters
    QuackArrowDuckTypeSchema
    QuackArrowInput
    QuackArrowIPCInput
    QuackJsonRow
    QuackJsonValue
    QuackMessage
    QuackRow
    QuackScalarValue
    QuackValue
    SqlParameter
    SqlParameters
    SqlParameterValue

    Variables

    CompressionType
    DEFAULT_HEARTBEAT_TIMEOUT_SECONDS
    DEFAULT_QUACK_PORT
    DUCKDB_MIME_TYPE
    FIELD_END
    LogicalTypes
    MAX_HEARTBEAT_TIMEOUT_SECONDS
    OPTIONAL_INDEX_INVALID
    QUACK_ENDPOINT
    QUACK_VERSION
    STANDARD_VECTOR_SIZE

    Functions

    arrowIPCFromChunks
    arrowIPCFromTable
    arrowTableFromChunks
    arrowTableFromDataChunk
    bigIntToSafeNumber
    chunksToRows
    column
    combineSignedHugeInt
    combineUnsignedHugeInt
    concatBytes
    dataChunk
    dataChunkFromRows
    dataChunksFromArrow
    dataChunksFromArrowIPC
    dataChunksFromArrowTable
    dateFromISODate
    dateFromJSDate
    dateValue
    dateValueToJSDate
    decimalToString
    decimalValue
    decodeDataChunk
    decodeDataChunkWrapper
    decodeExtraTypeInfo
    decodeHeader
    decodeLogicalType
    decodeMessage
    decodeVector
    encodeDataChunk
    encodeDataChunkWrapper
    encodeExtraTypeInfo
    encodeHeader
    encodeLogicalType
    encodeMessage
    encodeVector
    formatSql
    getArraySize
    getChildType
    getEnumValues
    getPhysicalType
    getStructChildren
    intervalValue
    isConstantSizePhysicalType
    logicalType
    logicalTypeToSql
    parseQuackUri
    physicalTypeSize
    quoteIdentifier
    rowsFromChunk
    splitSignedHugeInt
    sqlLiteral
    timestampFromJSDate
    timestampValue
    timestampValueToJSDate
    timeTzValue
    timeValue
    toJsonRow
    toJsonRows
    toJsonValue

    Settings

    Member Visibility

    On This Page

    Enumerations
    Classes
    Interfaces
    AcknowledgementMessageAggregateStateTypeInfoAnyTypeInfoAppendArrowOptionsAppendOptionsAppendRowsOptionsArrayTypeInfoBaseMessageCancelRequestMessageChildTypeColumnDefinitionColumnInputConnectionRequestMessageConnectionResponseMessageCoordinateReferenceSystemDataChunkFromRowsOptionsDateValueDecimalTypeInfoDecimalValueDecodedVectorDisconnectMessageEnumTypeInfoErrorResponseMessageFetchRequestMessageFetchResponseMessageGenericTypeInfoGeoTypeInfoHeartbeatRequestMessageHugeIntPartsIntegerLiteralTypeInfoIntervalValueListTypeInfoLogicalTypeMessageHeaderParsedQuackUriPrepareRequestMessagePrepareResponseMessageQuackArrowAppendOptionsQuackArrowIPCOptionsQuackArrowOptionsQuackArrowQueryIPCOptionsQuackArrowQueryOptionsQuackArrowTableOptionsQuackClientOptionsQuackConnectionInfoQuackDataChunkQuackJsonOptionsQuackQueryOptionsQuackQueryResultQuackRequestOptionsQuackServerErrorDetailsSendDataRequestMessageSendDataResponseMessageStringTypeInfoStructTypeInfoSuccessResponseMessageTableReferenceTemplateTypeInfoTimestampValueTimeTzValueTimeValueUnboundTypeInfo
    Type Aliases
    Variables
    Functions
    arrowIPCFromChunksarrowIPCFromTablearrowTableFromChunksarrowTableFromDataChunkbigIntToSafeNumberchunksToRowscolumncombineSignedHugeIntcombineUnsignedHugeIntconcatBytesdataChunkdataChunkFromRowsdataChunksFromArrowdataChunksFromArrowIPCdataChunksFromArrowTabledateFromISODatedateFromJSDatedateValuedateValueToJSDatedecimalToStringdecimalValuedecodeDataChunkdecodeDataChunkWrapperdecodeExtraTypeInfodecodeHeaderdecodeLogicalTypedecodeMessagedecodeVectorencodeDataChunkencodeDataChunkWrapperencodeExtraTypeInfoencodeHeaderencodeLogicalTypeencodeMessageencodeVectorformatSqlgetArraySizegetChildTypegetEnumValuesgetPhysicalTypegetStructChildrenintervalValueisConstantSizePhysicalTypelogicalTypelogicalTypeToSqlparseQuackUriphysicalTypeSizequoteIdentifierrowsFromChunksplitSignedHugeIntsqlLiteraltimestampFromJSDatetimestampValuetimestampValueToJSDatetimeTzValuetimeValuetoJsonRowtoJsonRowstoJsonValue