Snowflake · Schema

Stream

A Snowflake stream

Data LakesData SharingData WarehousingDatabaseSQL

Properties

Name Type Description
created_on string Date and time when the stream was created.
name string Name of the stream
comment string user comment associated to an object in the dictionary
database_name string Database in which the stream is stored
schema_name string Schema in which the stream is stored
owner string Role that owns the stream
table_name string Table name whose changes are tracked by the stream
stale boolean Specifies whether the stream is stale or not
mode string Mode of the stream. Possible values include: APPEND_ONLY, INSERT_ONLY. For streams on tables, the column displays DEFAULT.
stale_after string Timestamp when the stream became stale or may become stale if not consumed.
invalid_reason string Reason why the stream cannot be queried successfully. This column supports future functionality. Currently, the only value returned is N/A.
owner_role_type string The type of role that owns the stream
type string Type of the stream; currently DELTA only.
View JSON Schema on GitHub

JSON Schema

stream-stream-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "Stream",
  "type": "object",
  "description": "A Snowflake stream",
  "properties": {
    "created_on": {
      "type": "string",
      "description": "Date and time when the stream was created."
    },
    "name": {
      "type": "string",
      "description": "Name of the stream"
    },
    "comment": {
      "type": "string",
      "description": "user comment associated to an object in the dictionary"
    },
    "database_name": {
      "type": "string",
      "description": "Database in which the stream is stored"
    },
    "schema_name": {
      "type": "string",
      "description": "Schema in which the stream is stored"
    },
    "owner": {
      "type": "string",
      "description": "Role that owns the stream"
    },
    "table_name": {
      "type": "string",
      "description": "Table name whose changes are tracked by the stream"
    },
    "stale": {
      "type": "boolean",
      "description": "Specifies whether the stream is stale or not"
    },
    "mode": {
      "type": "string",
      "description": "Mode of the stream. Possible values include: APPEND_ONLY, INSERT_ONLY. For streams on tables, the column displays DEFAULT."
    },
    "stale_after": {
      "type": "string",
      "description": "Timestamp when the stream became stale or may become stale if not consumed. "
    },
    "invalid_reason": {
      "type": "string",
      "description": "Reason why the stream cannot be queried successfully. This column supports future functionality. Currently, the only value returned is N/A."
    },
    "owner_role_type": {
      "type": "string",
      "description": "The type of role that owns the stream"
    },
    "type": {
      "type": "string",
      "description": "Type of the stream; currently DELTA only."
    }
  }
}