snowflake.ingest.streaming.StreamingIngestChannel¶

class StreamingIngestChannel(channel: snowflake.ingest.streaming._python_ffi.PyChannel, *, _internal: bool = False)¶

A channel for streaming data ingestion into Snowflake using the Snowflake Ingest SDK.

The channel is used to ingest data into Snowflake tables in a streaming fashion. Each channel is associated with a specific account/database/schema/pipe combination and is created by calling open_channel() and closed by calling close().

The channel provides methods for appending single rows or batches of rows into Snowflake, with support for offset tokens to track ingestion progress and enable replay capabilities in case of failures.

Note

This class should not be instantiated directly. Use open_channel() to create channel instances.

append_row(row: Dict[str, Any], offset_token: str | None = None) → None¶

Append a single row into the channel.

Parameters:

• row –

  Dictionary representing the row data to append with keys as column names and values as column values. Values can be of the following types:

  • None: null values

  • bool: boolean values (True, False)

  • int: integer values

  • float: floating-point values

  • str: string values

  • bytes: byte strings

  • bytearray: mutable byte arrays

  • tuple: tuples of values

  • list: lists of values

  • dict: nested dictionaries

  • set: sets of values

  • frozenset: immutable sets of values

  • datetime.datetime: datetime objects

  • datetime.date: date objects

  • datetime.time: time objects

  • decimal.Decimal: decimal values for precise numeric operations

• offset_token – Optional offset token, used to track the ingestion progress and replay ingestion in case of failures. It could be null if user don’t plan on replaying or can’t replay.

Raises:

• ValueError, TypeError – If the row cannot be serialized to JSON

• StreamingIngestError – If the row appending fails

append_rows(rows: List[Dict[str, Any]], start_offset_token: str | None = None, end_offset_token: str | None = None) → None¶

Append multiple rows into the channel.

Parameters:

• rows –

  List of dictionaries representing the row data to append. Each dictionary’s values can be of the following types:

  • None: null values

  • bool: boolean values (True, False)

  • int: integer values

  • float: floating-point values

  • str: string values

  • bytes: byte strings

  • bytearray: mutable byte arrays

  • tuple: tuples of values

  • list: lists of values

  • dict: nested dictionaries

  • set: sets of values

  • frozenset: immutable sets of values

  • datetime.datetime: datetime objects

  • datetime.date: date objects

  • datetime.time: time objects

  • decimal.Decimal: decimal values for precise numeric operations

• start_offset_token – Optional start offset token of the batch/row-set.

• end_offset_token – Optional end offset token of the batch/row-set.

Raises:

• ValueError, TypeError – If the rows cannot be serialized to JSON

• StreamingIngestError – If the rows appending fails

get_latest_committed_offset_token() → str | None¶

Get the latest committed offset token for the channel.

Returns:

The latest committed offset token for the channel, or None if the channel is brand new.

Return type:

Optional[str]

Raises:

StreamingIngestError – If getting the latest committed offset token fails

get_channel_status() → ChannelStatus¶

Get the status of the channel.

Returns:

The status of the channel.

Return type:

ChannelStatus

Raises:

StreamingIngestError – If getting the channel status fails

close(drop: bool = False, wait_for_flush: bool = True, timeout_seconds: int | None = None) → None¶

Close the channel.

Parameters:

• drop – Whether to drop the channel, defaults to False

• wait_for_flush – Whether to wait for the flush to complete. Default is True.

• timeout_seconds – The timeout in seconds for the flush, None means no timeout. Default is None.

Raises:

StreamingIngestError – If closing the channel fails

is_closed() → bool¶

Check if the channel is closed.

Returns:

True if the channel is closed, False otherwise

Return type:

bool

property db_name: str¶

Get the database name.

Raises:

ValueError – If channel is already closed

property channel_name: str¶

Get the channel name.

Raises:

ValueError – If channel is already closed

property schema_name: str¶

Get the schema name.

Raises:

ValueError – If channel is already closed

property pipe_name: str¶

Get the pipe name.

Raises:

ValueError – If channel is already closed