STREAM

Config path: /<database>/<schema>/stream/<name>.yaml

Example:

object_type: TABLE
object_name: test_table_1
append_only: true
show_initial_rows: true

Schema

• object_type (str) - object type for stream (e.g. TABLE, EXTERNAL_TABLE)

• object_name (ident) - object name for stream

• append_only (bool) - is stream APPEND_ONLY mode

• insert_only (bool) - is stream INSERT_ONLY mode (for EXTERNAL_TABLE)

• show_initial_rows (bool) - return existing rows when stream is consumed for the first time

• comment (str)

Usage notes

1. Stream on top of TABLE, EVENT_TABLE or VIEW requires change tracking to be enabled explicitly for this object.

2. SnowDDL detects "stale" streams and suggests REPLACE command.

Links

• CREATE STREAM
• ALTER STREAM
• SHOW STREAMS
• DESC STREAM
• Parser & JSON Schema (GitHub)