Stream

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/Stream",
  "title": "Stream",
  "type": "object",
  "description": "A Snowflake stream",
  "properties": {
    "created_on": {
      "type": "string",
      "format": "date-time",
      "readOnly": true,
      "description": "Date and time when the stream was created.",
      "example": "2026-01-15T10:30:00Z"
    },
    "name": {
      "type": "string",
      "pattern": "^\"([^\"]|\"\")+\"|[a-zA-Z_][a-zA-Z0-9_$]*$",
      "description": "Name of the stream",
      "example": "Example Title"
    },
    "stream_source": {
      "$ref": "#/components/schemas/StreamSource",
      "description": "Source for the stream"
    },
    "comment": {
      "type": "string",
      "description": "user comment associated to an object in the dictionary",
      "example": "example_value"
    },
    "database_name": {
      "type": "string",
      "pattern": "^\"([^\"]|\"\")+\"|[a-zA-Z_][a-zA-Z0-9_$]*$",
      "readOnly": true,
      "description": "Database in which the stream is stored",
      "example": "example_value"
    },
    "schema_name": {
      "type": "string",
      "pattern": "^\"([^\"]|\"\")+\"|[a-zA-Z_][a-zA-Z0-9_$]*$",
      "readOnly": true,
      "description": "Schema in which the stream is stored",
      "example": "example_value"
    },
    "owner": {
      "type": "string",
      "pattern": "^\"([^\"]|\"\")+\"|[a-zA-Z_][a-zA-Z0-9_$]*$",
      "readOnly": true,
      "description": "Role that owns the stream",
      "example": "example_value"
    },
    "table_name": {
      "type": "string",
      "pattern": "^\"([^\"]|\"\")+\"|[a-zA-Z_][a-zA-Z0-9_$]*$",
      "readOnly": true,
      "description": "Table name whose changes are tracked by the stream",
      "example": "example_value"
    },
    "stale": {
      "type": "boolean",
      "readOnly": true,
      "description": "Specifies whether the stream is stale or not",
      "example": true
    },
    "mode": {
      "type": "string",
      "readOnly": true,
      "description": "Mode of the stream. Possible values include: APPEND_ONLY, INSERT_ONLY. For streams on tables, the column displays DEFAULT.",
      "example": "example_value"
    },
    "stale_after": {
      "type": "string",
      "format": "date-time",
      "readOnly": true,
      "description": "Timestamp when the stream became stale or may become stale if not consumed. ",
      "example": "2026-01-15T10:30:00Z"
    },
    "invalid_reason": {
      "type": "string",
      "readOnly": true,
      "description": "Reason why the stream cannot be queried successfully. This column supports future functionality. Currently, the only value returned is N/A.",
      "example": "example_value"
    },
    "owner_role_type": {
      "type": "string",
      "pattern": "^\"([^\"]|\"\")+\"|[a-zA-Z_][a-zA-Z0-9_$]*$",
      "readOnly": true,
      "description": "The type of role that owns the stream",
      "example": "example_value"
    },
    "type": {
      "type": "string",
      "readOnly": true,
      "description": "Type of the stream; currently DELTA only.",
      "example": "example_value"
    }
  },
  "required": [
    "name",
    "stream_source"
  ]
}