snowflake.ingest.streaming.ChannelStatus¶

class ChannelStatus(database_name: str, schema_name: str, pipe_name: str, channel_name: str, status_code: str, latest_committed_offset_token: str | None, created_on_ms: int, rows_inserted: int, rows_parsed: int, rows_error_count: int, last_error_offset_upper_bound: str | None, last_error_message: str | None, last_error_timestamp_ms: int | None, snowflake_avg_processing_latency_ms: int | None, last_refreshed_on_ms: int)¶

Channel status information returned to users.

Provides access to channel status information including the channel name, status code, and latest committed offset token from Snowflake server.

property database_name: str¶: Get the database name.

property schema_name: str¶: Get the schema name.

property pipe_name: str¶: Get the pipe name.

property channel_name: str¶

Get the channel name.

Returns:: The name of the channel
Return type:: str

property status_code: str¶

Get the status code for the channel.

Returns:: The status code from Snowflake server
Return type:: str

property latest_committed_offset_token: str | None¶

Get the latest committed offset token for the channel.

Returns:: The latest committed offset token, or None if no commits yet
Return type:: Optional[str]

property created_on_ms: int¶: Get the created on timestamp in ms for the channel.

property rows_inserted: int¶: Get the rows inserted for the channel.

property rows_parsed: int¶: Get the rows parsed for the channel.

property rows_error_count: int¶: Get the rows error count for the channel.

property last_error_offset_upper_bound: str | None¶: Get the last error offset upper bound for the channel.

property last_error_message: str | None¶: Get the last error message for the channel.

property last_error_timestamp_ms: int | None¶: Get the last error timestamp in ms for the channel.

property snowflake_avg_processing_latency_ms: int | None¶: Get the snowflake avg processing latency in the snowflake server side for the channel to ingest data.

property last_refreshed_on_ms: int¶: Get the last refreshed on timestamp in ms for the channel. Channels is periodically refreshed every second in the background.