Skip to content

Create Stream

Creates a new Snowflake stream in the specified schema and table. This component can optionally replace an existing stream of the same name.

Warning

Depending on the chosen settings, this component can be destructive. Take care when running this component as it may remove existing data.


Properties

Name = string

A human-readable name for the component.


Create/Replace = drop-down

  • 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

The Snowflake database. The special value, [Environment Default], will use the database defined in the environment. Read Databases, Tables and Views - Overview to learn more.


Schema = drop-down

The Snowflake schema. The special value, [Environment Default], will use the schema defined in the environment. Read Database, Schema, and Share DDL to learn more.


Stream Name = string

The name of the stream.


Table Database = drop-down

The database that holds the source schema and source table.


Table Schema = drop-down

The schema that contains the source table.


Table = drop-down

The table to create the stream for (i.e. the source table).


Append Only = boolean

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).


Strategy

A stream records data manipulation language (DML) changes made to a table, including information about inserts, updates, and deletes. It stores information in the stream every time a change is made. The table where changes are recorded is called the source table. Create Stream has two table inputs: the stream name, and the source table.

To learn more, read CREATE STREAM.


Snowflake Delta Lake on Databricks Amazon Redshift Google BigQuery Azure Synapse Analytics