createStream
Last updated: January 27, 2026
Creates a new stream in Snowflake. Streams track data manipulation language (DML) changes made to tables, views, and other objects, enabling change data capture (CDC) workflows.
Note: Automatic rollback drops the stream.
Known limitation: This change type does not support database inspection features (snapshot, diff, diff-changelog, and generate-changelog commands).
Available attributes
Attribute | Type | Description | Required |
|---|---|---|---|
| String | Name of the catalog (database) where the stream will be created | No |
| String | Name of the schema where the stream will be created | No |
| String | Name of the stream to create | Yes |
| String | Name of the source object (table, view, stage, etc.) | Yes |
| String | Name of the catalog containing the source object | No |
| String | Name of the schema containing the source object | No |
| String | Comment describing the stream | No |
| Boolean | If true, copies grants from the source object | No |
| Boolean | If true, replaces the stream if it already exists using | No |
| Boolean | If true, only creates if the stream doesn't exist using | No |
| Nested | Key-value pairs of tags to apply | No |
*replaceIfExists and ifNotExists are mutually exclusive.
Stream type elements
Exactly one stream type must be specified:
Element | Description |
|---|---|
| For tracking changes to standard tables |
| For tracking changes to views |
| For tracking changes to external tables |
| For tracking directory table changes on stages |
| For tracking changes to dynamic tables |
| For tracking changes to event tables |
tableStream / viewStream nested attributes
Attribute | Type | Description | Required |
|---|---|---|---|
| Boolean | If true, creates append-only stream | No |
| Boolean | If true, includes initial data in stream | No |
| Nested | Time travel specification | No |
externalTableStream nested attributes
Attribute | Type | Description | Required |
|---|---|---|---|
| Boolean | If true, only tracks inserts | No |
| Nested | Time travel specification | No |
timeTravelClause nested attributes
Attribute | Type | Description | Required |
|---|---|---|---|
| String |
| Yes |
| String | Offset value (e.g., | No |
| String | Timestamp value* | No |
| String | Statement ID* | No |
| String | Stream name for reference* | No |
*Exactly one of offset, timestamp, statement, or stream must be specified.