Class QuackClient

ReadonlybaseUrl

ReadonlyfetchImpl

info

isConnected

• get isConnected(): boolean

  Whether this client currently has an open Quack connection.

  Returns boolean

append

• append(table: string, chunk: QuackDataChunk, schemaName?: string): Promise<void>

  Append an already encoded DuckDB DataChunk to a table.

  Parameters

  • table: string
  • chunk: QuackDataChunk
  • OptionalschemaName: string

  Returns Promise<void>

• append(
      table: string,
      chunk: QuackDataChunk,
      options?: AppendOptions,
  ): Promise<void>

  Append an already encoded DuckDB DataChunk to a table.

  Parameters

  • table: string
  • chunk: QuackDataChunk
  • Optionaloptions: AppendOptions

  Returns Promise<void>

• append(
      table: TableReference,
      chunk: QuackDataChunk,
      options?: QuackRequestOptions,
  ): Promise<void>

  Append an already encoded DuckDB DataChunk to a table.

  Parameters

  • table: TableReference
  • chunk: QuackDataChunk
  • Optionaloptions: QuackRequestOptions

  Returns Promise<void>

• append(
      table: string | TableReference,
      chunk: QuackDataChunk,
      schemaOrOptions?: string | QuackRequestOptions | AppendOptions,
  ): Promise<void>

  Append an already encoded DuckDB DataChunk to a table.

  Parameters

  • table: string | TableReference
  • chunk: QuackDataChunk
  • OptionalschemaOrOptions: string | QuackRequestOptions | AppendOptions

  Returns Promise<void>

appendRows

• appendRows<T extends Record<string, unknown>>(
      table: string | TableReference,
      rows: readonly T[],
      options?: AppendRowsOptions<T>,
  ): Promise<void>

  Encode row objects as one or more flat DataChunks and append them to a table.

  Provide explicit column types for stable production use, especially for empty row sets or columns containing only null.

  Type Parameters

  • T extends Record<string, unknown>

  Parameters

  • table: string | TableReference
  • rows: readonly T[]
  • options: AppendRowsOptions<T> = {}

  Returns Promise<void>

close

• close(options?: QuackRequestOptions): Promise<void>

  Alias for disconnect.

  Parameters

  • options: QuackRequestOptions = {}

  Returns Promise<void>

disconnect

• disconnect(options?: QuackRequestOptions): Promise<void>

  Disconnect from the Quack server. Safe to call more than once.

  Parameters

  • options: QuackRequestOptions = {}

  Returns Promise<void>

first

• first<T extends QuackRow = QuackRow>(
      sql: string,
      options?: QuackQueryOptions,
  ): Promise<T | null>

  Run SQL and return the first row, or null when the result is empty.

  Type Parameters

  • T extends QuackRow = QuackRow

  Parameters

  • sql: string
  • Optionaloptions: QuackQueryOptions

  Returns Promise<T | null>

• first<T extends QuackRow = QuackRow>(
      sql: string,
      params: SqlParameters,
      options?: QuackRequestOptions,
  ): Promise<T | null>

  Run SQL and return the first row, or null when the result is empty.

  Type Parameters

  • T extends QuackRow = QuackRow

  Parameters

  • sql: string
  • params: SqlParameters
  • Optionaloptions: QuackRequestOptions

  Returns Promise<T | null>

one

• one<T extends QuackRow = QuackRow>(
      sql: string,
      options?: QuackQueryOptions,
  ): Promise<T>

  Run SQL and return exactly one row, throwing when the row count is not one.

  Type Parameters

  • T extends QuackRow = QuackRow

  Parameters

  • sql: string
  • Optionaloptions: QuackQueryOptions

  Returns Promise<T>

• one<T extends QuackRow = QuackRow>(
      sql: string,
      params: SqlParameters,
      options?: QuackRequestOptions,
  ): Promise<T>

  Run SQL and return exactly one row, throwing when the row count is not one.

  Type Parameters

  • T extends QuackRow = QuackRow

  Parameters

  • sql: string
  • params: SqlParameters
  • Optionaloptions: QuackRequestOptions

  Returns Promise<T>

query

• query<T extends QuackRow = QuackRow>(
      sql: string,
      options?: QuackQueryOptions,
  ): Promise<QuackQueryResult<T>>

  Run SQL and collect all result chunks.

  Use the generic parameter to type the materialized rows returned by QuackQueryResult.rows.

  Type Parameters

  • T extends QuackRow = QuackRow

  Parameters

  • sql: string
  • Optionaloptions: QuackQueryOptions

  Returns Promise<QuackQueryResult<T>>

• query<T extends QuackRow = QuackRow>(
      sql: string,
      params: SqlParameters,
      options?: QuackRequestOptions,
  ): Promise<QuackQueryResult<T>>

  Run SQL and collect all result chunks.

  Use the generic parameter to type the materialized rows returned by QuackQueryResult.rows.

  Type Parameters

  • T extends QuackRow = QuackRow

  Parameters

  • sql: string
  • params: SqlParameters
  • Optionaloptions: QuackRequestOptions

  Returns Promise<QuackQueryResult<T>>

send

• send(
      message: QuackMessage,
      options?: QuackRequestOptions,
  ): Promise<QuackMessage>

  Send a raw Quack protocol message.

  This is an escape hatch for protocol tests and advanced clients; most application code should use higher-level methods.

  Parameters

  • message: QuackMessage
  • options: QuackRequestOptions = {}

  Returns Promise<QuackMessage>

stream

• stream(
      sql: string,
      options?: QuackQueryOptions,
  ): AsyncGenerator<QuackDataChunk, void, void>

  Run SQL and stream decoded DuckDB DataChunks without materializing all rows.

  Parameters

  • sql: string
  • Optionaloptions: QuackQueryOptions

  Returns AsyncGenerator<QuackDataChunk, void, void>

• stream(
      sql: string,
      params: SqlParameters,
      options?: QuackRequestOptions,
  ): AsyncGenerator<QuackDataChunk, void, void>

  Run SQL and stream decoded DuckDB DataChunks without materializing all rows.

  Parameters

  • sql: string
  • params: SqlParameters
  • Optionaloptions: QuackRequestOptions

  Returns AsyncGenerator<QuackDataChunk, void, void>

streamRows

• streamRows<T extends QuackRow = QuackRow>(
      sql: string,
      options?: QuackQueryOptions,
  ): AsyncGenerator<T, void, void>

  Run SQL and stream materialized rows.

  Type Parameters

  • T extends QuackRow = QuackRow

  Parameters

  • sql: string
  • Optionaloptions: QuackQueryOptions

  Returns AsyncGenerator<T, void, void>

• streamRows<T extends QuackRow = QuackRow>(
      sql: string,
      params: SqlParameters,
      options?: QuackRequestOptions,
  ): AsyncGenerator<T, void, void>

  Run SQL and stream materialized rows.

  Type Parameters

  • T extends QuackRow = QuackRow

  Parameters

  • sql: string
  • params: SqlParameters
  • Optionaloptions: QuackRequestOptions

  Returns AsyncGenerator<T, void, void>

transaction

• transaction<T>(
      fn: (client: this) => T | Promise<T>,
      options?: QuackRequestOptions,
  ): Promise<T>

  Run a callback inside a DuckDB transaction.

  Commits when the callback succeeds and attempts rollback when it throws.

  Type Parameters

  • T

  Parameters

  • fn: (client: this) => T | Promise<T>
  • options: QuackRequestOptions = {}

  Returns Promise<T>

values

• values<T extends QuackValue = QuackValue>(
      sql: string,
      options?: QuackQueryOptions,
  ): Promise<T[]>

  Run SQL and return the first column from every materialized row.

  Type Parameters

  • T extends QuackValue = QuackValue

  Parameters

  • sql: string
  • Optionaloptions: QuackQueryOptions

  Returns Promise<T[]>

• values<T extends QuackValue = QuackValue>(
      sql: string,
      params: SqlParameters,
      options?: QuackRequestOptions,
  ): Promise<T[]>

  Run SQL and return the first column from every materialized row.

  Type Parameters

  • T extends QuackValue = QuackValue

  Parameters

  • sql: string
  • params: SqlParameters
  • Optionaloptions: QuackRequestOptions

  Returns Promise<T[]>

Staticconnect

• connect(uri: string, options?: QuackClientOptions): Promise<QuackClient>

  Open a Quack connection.

  Accepts bare host strings such as localhost:9494, DuckDB-style quack: URIs, and direct HTTP(S) URLs.

  Parameters

  • uri: string
  • options: QuackClientOptions = {}

  Returns Promise<QuackClient>

StaticwithConnection

• withConnection<T>(
      uri: string,
      fn: (client: QuackClient) => T | Promise<T>,
  ): Promise<T>

  Open a connection, run a callback, and always disconnect afterwards.

  Type Parameters

  • T

  Parameters

  • uri: string
  • fn: (client: QuackClient) => T | Promise<T>

  Returns Promise<T>

• withConnection<T>(
      uri: string,
      options: QuackClientOptions,
      fn: (client: QuackClient) => T | Promise<T>,
  ): Promise<T>

  Open a connection, run a callback, and always disconnect afterwards.

  Type Parameters

  • T

  Parameters

  • uri: string
  • options: QuackClientOptions
  • fn: (client: QuackClient) => T | Promise<T>

  Returns Promise<T>