Snowpipe Streaming Node.js SDK v1.4.0
    Preparing search index...

    Class ChannelStatus

    Status information for a streaming ingest channel.

    Contains metadata about the channel's current state including the latest committed offset token, row counts, error information, and processing latency. Returned by client.getChannelStatuses() and channel.getChannelStatus().

    Index

    Properties

    channelName createdOn databaseName lastErrorMessage lastErrorOffsetTokenUpperBound lastErrorTimestamp lastRefreshedOn latestCommittedOffsetToken pipeName rowsErrorCount rowsInsertedCount rowsParsedCount schemaName serverAvgProcessingLatencyMs statusCode

    Properties

    channelName: string

    The channel name.

    createdOn: Date

    When the channel was created.

    databaseName: string

    The database name.

    lastErrorMessage: string

    The message of the last error, or null if no errors.

    lastErrorOffsetTokenUpperBound: string

    Upper bound offset token for the last error, or null if no errors.

    lastErrorTimestamp: Date

    Timestamp of the last error, or null if no errors.

    lastRefreshedOn: Date

    When the status was last refreshed from the server.

    latestCommittedOffsetToken: string

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

    pipeName: string

    The pipe name.

    rowsErrorCount: number

    Total number of rows that encountered errors.

    rowsInsertedCount: number

    Total number of rows successfully inserted.

    rowsParsedCount: number

    Total number of rows parsed.

    schemaName: string

    The schema name.

    serverAvgProcessingLatencyMs: number

    Average processing latency in milliseconds, or null if not available.

    statusCode: string

    The channel status code.

    Settings

    Member Visibility

    On This Page

    Properties