alterStreamComment

Sets or removes the comment on an existing stream in Snowflake.

Note: This change type does not support automatic rollback or database inspection features (snapshot, diff, diff-changelog, and generate-changelog commands).

Available attributes

Attribute

Type

Description

Required

catalogName

String

Name of the catalog (database) containing the stream

No

schemaName

String

Name of the schema containing the stream

No

streamName

String

Name of the stream to alter

Yes

ifExists

Boolean

Only execute if the stream exists

No

newComment

String

New comment text to set*

No

unsetComment

Boolean

If true, removes the existing comment*

No

*Exactly one of newComment or unsetComment must be specified.

loading