Skip to main content
Creates a new Snowflake Stream in the specified schema and table. This component can optionally replace an existing stream of the same name.
Depending on the chosen settings, this component is potentially destructive. Take care when running this component as it may remove existing data.

​
Properties

​
Name
string
required
A human-readable name for the component.
​
Create/Replace
drop-down
required
Select the method of creating or replacing the stream:
  • Create: The default option, creates a new stream. This will generate an error if a stream with the same name already exists.
  • Create if not exists: This will only create a new stream if a stream of the same name does not already exist.
  • Replace: This destroys any existing stream of the same name, and then creates a new stream.
​
Database
drop-down
required
The Snowflake database that the stream is in. The special value [Environment Default] uses the database defined in the environment. Read Database, Schema, and Share DDL to learn more.
​
Schema
drop-down
required
The Snowflake schema that the stream is in. The special value [Environment Default] uses the schema defined in the environment. Read Database, Schema, and Share DDL to learn more.
​
Stream Name
string
required
The name of the stream. If this is a new stream, it must be a unique name. If you are replacing an existing stream, use the exact name of the stream you are replacing.
​
Table Database
drop-down
required
The Snowflake database that will hold the source schema and source table. The special value [Environment Default] uses the database defined in the environment. Read Database, Schema, and Share DDL to learn more.
​
Table Schema
drop-down
required
The Snowflake schema that will hold the source table. The special value [Environment Default] uses the schema defined in the environment. Read Database, Schema, and Share DDL to learn more.
​
Table
drop-down
required
The table to create the stream for (the source table).
​
Append Only
drop-down
required
By default, a standard stream records all inserts, updates, and deletes. An append-only stream tracks row inserts only; updates and deletes are not recorded. Using an append-only stream will give improved performance over a standard stream, and therefore is recommended if you only need to track appends.To set the stream to be append only, select True. Otherwise, leave this property set to False (the default).