Class StreamingIngestClient

ReadonlybinaryInputFormat

ReadonlyclientName

ReadonlydbName

ReadonlyisClosed

ReadonlypipeName

ReadonlyschemaName

close

• close(options?: { timeoutMs?: number; waitForFlush?: boolean }): Promise<void>

  Close the client. If waitForFlush is true, the client waits for all data in every channel to be flushed to Snowflake before shutting down.

  Parameters

  • Optionaloptions: { timeoutMs?: number; waitForFlush?: boolean }

    Close options

    • OptionaltimeoutMs?: number

      Optional timeout in milliseconds for the flush operation.

    • OptionalwaitForFlush?: boolean

      Whether to wait for the flush to complete, defaults to true.

  Returns Promise<void>

  Throws

  StreamingIngestError If closing the client fails or the timeout is reached

dropChannel

• dropChannel(channelName: string): Promise<void>

  Drop a channel by name (server-side removal).

  Parameters

  • channelName: string

    Name of the channel to drop

  Returns Promise<void>

  Throws

  StreamingIngestError If dropping the channel fails

getChannelStatuses

• getChannelStatuses(
      channelNames: string[],
  ): Promise<Record<string, ChannelStatus>>

  Get the status of multiple channels. Can fetch status for channels not opened by this client.

  Parameters

  • channelNames: string[]

    Names of channels to query

  Returns Promise<Record<string, ChannelStatus>>

  Throws

  StreamingIngestError If retrieving statuses fails

getLatestCommittedOffsetTokens

• getLatestCommittedOffsetTokens(
      channelNames: string[],
  ): Promise<Record<string, string>>

  Get the latest committed offset tokens for multiple channels.

  Parameters

  • channelNames: string[]

    Names of channels to query

  Returns Promise<Record<string, string>>

  Throws

  StreamingIngestError If retrieving offset tokens fails

initiateFlush

• initiateFlush(): void

  Initiate a flush of the client. Causes all outstanding buffered data to be flushed to Snowflake. Data can still be accepted by the client after calling this method — this is an asynchronous call that returns after the flush is initiated for all channels.

  Returns void

  Throws

  StreamingIngestError If initiating the flush fails

openChannel

• openChannel(
      options: { name: string; offsetToken?: string },
  ): Promise<{ channel: StreamingIngestChannel; status: ChannelStatus }>

  Open a channel with the given name. The channel is opened on the database/schema/pipe defined by this client. If the channel already exists, Snowflake reuses the latest persisted offset token unless a new one is provided.

  Parameters

  • options: { name: string; offsetToken?: string }

    Channel options

    • name: string

      The name of the channel to open.

    • OptionaloffsetToken?: string

      Optional offset token to set on the channel. If not provided and this reopens an existing channel, the latest persisted offset token is reused.

  Returns Promise<{ channel: StreamingIngestChannel; status: ChannelStatus }>

  Throws

  StreamingIngestError If opening the channel fails

waitForFlush

• waitForFlush(options?: { timeoutMs?: number }): Promise<void>

  Wait for all buffered data in all channels managed by this client to be flushed to Snowflake. This method triggers a flush of all pending data across all channels and waits for the flush operations to complete.

  Parameters

  • Optionaloptions: { timeoutMs?: number }

    Wait options

    • OptionaltimeoutMs?: number

      Optional timeout in milliseconds.

  Returns Promise<void>

  Throws

  StreamingIngestError If waiting for the flush fails

  Throws

  Error If the timeout is reached