streams

Creates, updates, deletes, gets or lists a streams resource.

Overview

Name	streams
Type	Resource
Id	snowflake.streams.streams

Fields

Name	Datatype	Description
name	string	Name of the stream
comment	string	user comment associated to an object in the dictionary
created_on	string	Date and time when the stream was created.
database_name	string	Database in which the stream is stored
invalid_reason	string	Reason why the stream cannot be queried successfully. This column supports future functionality. Currently, the only value returned is N/A.
mode	string	Mode of the stream. Possible values include: APPEND_ONLY, INSERT_ONLY. For streams on tables, the column displays DEFAULT.
owner	string	Role that owns the stream
owner_role_type	string	The type of role that owns the stream
schema_name	string	Schema in which the stream is stored
stale	boolean	Specifies whether the stream is stale or not
stale_after	string	Timestamp when the stream became stale or may become stale if not consumed.
stream_source	object
table_name	string	Table name whose changes are tracked by the stream
type	string	Type of the stream; currently DELTA only.

Methods

Name	Accessible by	Required Params	Optional Params	Description
fetch_stream	SELECT	database_name, name, schema_name, endpoint	-	Fetch a stream
list_streams	SELECT	database_name, schema_name, endpoint	like, startsWith, showLimit, fromName	List streams
create_stream	INSERT	database_name, schema_name, data__name, data__stream_source, endpoint	createMode, copyGrants	Create a stream
delete_stream	DELETE	database_name, name, schema_name, endpoint	ifExists	Delete a stream
clone_stream	EXEC	database_name, name, schema_name, targetDatabase, targetSchema, data__name, endpoint	createMode, copyGrants	Clone a stream

Optional Parameter Details

Name	Description	Type	Default
copyGrants	Query parameter to enable copy grants when creating the object.	boolean	false
createMode	Query parameter allowing support for different modes of resource creation. Possible values include: - errorIfExists: Throws an error if you try to create a resource that already exists. - orReplace: Automatically replaces the existing resource with the current one. - ifNotExists: Creates a new resource when an alter is requested for a non-existent resource.	string	errorIfExists
fromName	Query parameter to enable fetching rows only following the first row whose object name matches the specified string. Case-sensitive and does not have to be the full name.	string	-
ifExists	Query parameter that specifies how to handle the request for a resource that does not exist: - true: The endpoint does not throw an error if the resource does not exist. It returns a 200 success response, but does not take any action on the resource. - false: The endpoint throws an error if the resource doesn't exist.	boolean	false
like	Query parameter to filter the command output by resource name. Uses case-insensitive pattern matching, with support for SQL wildcard characters.	string	-
showLimit	Query parameter to limit the maximum number of rows returned by a command.	integer	-
startsWith	Query parameter to filter the command output based on the string of characters that appear at the beginning of the object name. Uses case-sensitive pattern matching.	string	-

SELECT examples

List streams

SELECT
name,
comment,
created_on,
database_name,
invalid_reason,
mode,
owner,
owner_role_type,
schema_name,
stale,
stale_after,
stream_source,
table_name,
type
FROM snowflake.streams.streams
WHERE database_name = '{{ database_name }}'
AND schema_name = '{{ schema_name }}'
AND endpoint = '{{ endpoint }}';

INSERT example

Use the following StackQL query and manifest file to create a new streams resource.

Required Properties

/*+ create */
INSERT INTO snowflake.streams.streams (
data__name,
data__stream_source,
data__comment,
database_name,
schema_name,
endpoint
)
SELECT 
'{{ name }}',
'{{ stream_source }}',
'{{ comment }}',
'{{ database_name }}',
'{{ schema_name }}',
'{{ endpoint }}'
;

All Properties

/*+ create */
INSERT INTO snowflake.streams.streams (
data__name,
data__stream_source,
database_name,
schema_name,
endpoint
)
SELECT 
'{{ name }}',
'{{ stream_source }}',
'{{ database_name }}',
'{{ schema_name }}',
'{{ endpoint }}'
;

Manifest

- name: streams
  props:
    - name: database_name
      value: string
    - name: schema_name
      value: string
    - name: data__name
      value: string
    - name: data__stream_source
      value: string
    - name: endpoint
      value: string
    - name: name
      value: string
    - name: stream_source
      props:
        - name: src_type
          value: string
        - name: name
          value: string
        - name: database_name
          value: string
        - name: schema_name
          value: string
    - name: comment
      value: string

DELETE example

Deletes the specified streams resource.

/*+ delete */
DELETE FROM snowflake.streams.streams
WHERE database_name = '{{ database_name }}'
AND name = '{{ name }}'
AND schema_name = '{{ schema_name }}'
AND endpoint = '{{ endpoint }}';