Snowflake v0.61.1, Nov 14 24

Snowflake v0.61.1 published on Thursday, Nov 14, 2024 by Pulumi

snowflake.StreamOnTable

Explore with Pulumi AI

Snowflake v0.61.1 published on Thursday, Nov 14, 2024 by Pulumi

Import

$ pulumi import snowflake:index/streamOnTable:StreamOnTable example '"<database_name>"."<schema_name>"."<stream_name>"'

Create StreamOnTable Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new StreamOnTable(name: string, args: StreamOnTableArgs, opts?: CustomResourceOptions);

@overload
def StreamOnTable(resource_name: str,
                  args: StreamOnTableArgs,
                  opts: Optional[ResourceOptions] = None)

@overload
def StreamOnTable(resource_name: str,
                  opts: Optional[ResourceOptions] = None,
                  database: Optional[str] = None,
                  schema: Optional[str] = None,
                  table: Optional[str] = None,
                  append_only: Optional[str] = None,
                  at: Optional[StreamOnTableAtArgs] = None,
                  before: Optional[StreamOnTableBeforeArgs] = None,
                  comment: Optional[str] = None,
                  copy_grants: Optional[bool] = None,
                  name: Optional[str] = None,
                  show_initial_rows: Optional[str] = None)

func NewStreamOnTable(ctx *Context, name string, args StreamOnTableArgs, opts ...ResourceOption) (*StreamOnTable, error)

public StreamOnTable(string name, StreamOnTableArgs args, CustomResourceOptions? opts = null)

public StreamOnTable(String name, StreamOnTableArgs args)
public StreamOnTable(String name, StreamOnTableArgs args, CustomResourceOptions options)

type: snowflake:StreamOnTable
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name string: The unique name of the resource.
args StreamOnTableArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

resource_name str: The unique name of the resource.
args StreamOnTableArgs: The arguments to resource properties.
opts ResourceOptions: Bag of options to control resource's behavior.

ctx Context: Context object for the current deployment.
name string: The unique name of the resource.
args StreamOnTableArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args StreamOnTableArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

name String: The unique name of the resource.
args StreamOnTableArgs: The arguments to resource properties.
options CustomResourceOptions: Bag of options to control resource's behavior.

Constructor example

The following reference example uses placeholder values for all input properties.

var streamOnTableResource = new Snowflake.StreamOnTable("streamOnTableResource", new()
{
    Database = "string",
    Schema = "string",
    Table = "string",
    AppendOnly = "string",
    At = new Snowflake.Inputs.StreamOnTableAtArgs
    {
        Offset = "string",
        Statement = "string",
        Stream = "string",
        Timestamp = "string",
    },
    Before = new Snowflake.Inputs.StreamOnTableBeforeArgs
    {
        Offset = "string",
        Statement = "string",
        Stream = "string",
        Timestamp = "string",
    },
    Comment = "string",
    CopyGrants = false,
    Name = "string",
    ShowInitialRows = "string",
});

example, err := snowflake.NewStreamOnTable(ctx, "streamOnTableResource", &snowflake.StreamOnTableArgs{
	Database:   pulumi.String("string"),
	Schema:     pulumi.String("string"),
	Table:      pulumi.String("string"),
	AppendOnly: pulumi.String("string"),
	At: &snowflake.StreamOnTableAtArgs{
		Offset:    pulumi.String("string"),
		Statement: pulumi.String("string"),
		Stream:    pulumi.String("string"),
		Timestamp: pulumi.String("string"),
	},
	Before: &snowflake.StreamOnTableBeforeArgs{
		Offset:    pulumi.String("string"),
		Statement: pulumi.String("string"),
		Stream:    pulumi.String("string"),
		Timestamp: pulumi.String("string"),
	},
	Comment:         pulumi.String("string"),
	CopyGrants:      pulumi.Bool(false),
	Name:            pulumi.String("string"),
	ShowInitialRows: pulumi.String("string"),
})

var streamOnTableResource = new StreamOnTable("streamOnTableResource", StreamOnTableArgs.builder()
    .database("string")
    .schema("string")
    .table("string")
    .appendOnly("string")
    .at(StreamOnTableAtArgs.builder()
        .offset("string")
        .statement("string")
        .stream("string")
        .timestamp("string")
        .build())
    .before(StreamOnTableBeforeArgs.builder()
        .offset("string")
        .statement("string")
        .stream("string")
        .timestamp("string")
        .build())
    .comment("string")
    .copyGrants(false)
    .name("string")
    .showInitialRows("string")
    .build());

stream_on_table_resource = snowflake.StreamOnTable("streamOnTableResource",
    database="string",
    schema="string",
    table="string",
    append_only="string",
    at={
        "offset": "string",
        "statement": "string",
        "stream": "string",
        "timestamp": "string",
    },
    before={
        "offset": "string",
        "statement": "string",
        "stream": "string",
        "timestamp": "string",
    },
    comment="string",
    copy_grants=False,
    name="string",
    show_initial_rows="string")

const streamOnTableResource = new snowflake.StreamOnTable("streamOnTableResource", {
    database: "string",
    schema: "string",
    table: "string",
    appendOnly: "string",
    at: {
        offset: "string",
        statement: "string",
        stream: "string",
        timestamp: "string",
    },
    before: {
        offset: "string",
        statement: "string",
        stream: "string",
        timestamp: "string",
    },
    comment: "string",
    copyGrants: false,
    name: "string",
    showInitialRows: "string",
});

type: snowflake:StreamOnTable
properties:
    appendOnly: string
    at:
        offset: string
        statement: string
        stream: string
        timestamp: string
    before:
        offset: string
        statement: string
        stream: string
        timestamp: string
    comment: string
    copyGrants: false
    database: string
    name: string
    schema: string
    showInitialRows: string
    table: string

StreamOnTable Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The StreamOnTable resource accepts the following input properties:

Database string: The database in which to create the stream. Due to technical limitations (read more here), avoid using the following characters: |, ., (, ), "
Schema string: The schema in which to create the stream. Due to technical limitations (read more here), avoid using the following characters: |, ., (, ), "
Table string: Specifies an identifier for the table the stream will monitor. Due to technical limitations (read more here), avoid using the following characters: |, ., (, ), "
AppendOnly string: Specifies whether this is an append-only stream. Available options are: "true" or "false". When the value is not set in the configuration the provider will put "default" there which means to use the Snowflake default for this value.
At StreamOnTableAt
Before StreamOnTableBefore
Comment string: Specifies a comment for the stream.
CopyGrants bool: Retains the access permissions from the original stream when a stream is recreated using the OR REPLACE clause. That is sometimes used when the provider detects changes for fields that can not be changed by ALTER. This value will not have any effect when creating a new stream.
Name string: Specifies the identifier for the stream; must be unique for the database and schema in which the stream is created. Due to technical limitations (read more here), avoid using the following characters: |, ., (, ), "
ShowInitialRows string

Database string: The database in which to create the stream. Due to technical limitations (read more here), avoid using the following characters: |, ., (, ), "
Schema string: The schema in which to create the stream. Due to technical limitations (read more here), avoid using the following characters: |, ., (, ), "
Table string: Specifies an identifier for the table the stream will monitor. Due to technical limitations (read more here), avoid using the following characters: |, ., (, ), "
AppendOnly string: Specifies whether this is an append-only stream. Available options are: "true" or "false". When the value is not set in the configuration the provider will put "default" there which means to use the Snowflake default for this value.
At StreamOnTableAtArgs
Before StreamOnTableBeforeArgs
Comment string: Specifies a comment for the stream.
CopyGrants bool: Retains the access permissions from the original stream when a stream is recreated using the OR REPLACE clause. That is sometimes used when the provider detects changes for fields that can not be changed by ALTER. This value will not have any effect when creating a new stream.
Name string: Specifies the identifier for the stream; must be unique for the database and schema in which the stream is created. Due to technical limitations (read more here), avoid using the following characters: |, ., (, ), "
ShowInitialRows string

database String: The database in which to create the stream. Due to technical limitations (read more here), avoid using the following characters: |, ., (, ), "
schema String: The schema in which to create the stream. Due to technical limitations (read more here), avoid using the following characters: |, ., (, ), "
table String: Specifies an identifier for the table the stream will monitor. Due to technical limitations (read more here), avoid using the following characters: |, ., (, ), "
appendOnly String: Specifies whether this is an append-only stream. Available options are: "true" or "false". When the value is not set in the configuration the provider will put "default" there which means to use the Snowflake default for this value.
at StreamOnTableAt
before StreamOnTableBefore
comment String: Specifies a comment for the stream.
copyGrants Boolean: Retains the access permissions from the original stream when a stream is recreated using the OR REPLACE clause. That is sometimes used when the provider detects changes for fields that can not be changed by ALTER. This value will not have any effect when creating a new stream.
name String: Specifies the identifier for the stream; must be unique for the database and schema in which the stream is created. Due to technical limitations (read more here), avoid using the following characters: |, ., (, ), "
showInitialRows String

database string: The database in which to create the stream. Due to technical limitations (read more here), avoid using the following characters: |, ., (, ), "
schema string: The schema in which to create the stream. Due to technical limitations (read more here), avoid using the following characters: |, ., (, ), "
table string: Specifies an identifier for the table the stream will monitor. Due to technical limitations (read more here), avoid using the following characters: |, ., (, ), "
appendOnly string: Specifies whether this is an append-only stream. Available options are: "true" or "false". When the value is not set in the configuration the provider will put "default" there which means to use the Snowflake default for this value.
at StreamOnTableAt
before StreamOnTableBefore
comment string: Specifies a comment for the stream.
copyGrants boolean: Retains the access permissions from the original stream when a stream is recreated using the OR REPLACE clause. That is sometimes used when the provider detects changes for fields that can not be changed by ALTER. This value will not have any effect when creating a new stream.
name string: Specifies the identifier for the stream; must be unique for the database and schema in which the stream is created. Due to technical limitations (read more here), avoid using the following characters: |, ., (, ), "
showInitialRows string

database str: The database in which to create the stream. Due to technical limitations (read more here), avoid using the following characters: |, ., (, ), "
schema str: The schema in which to create the stream. Due to technical limitations (read more here), avoid using the following characters: |, ., (, ), "
table str: Specifies an identifier for the table the stream will monitor. Due to technical limitations (read more here), avoid using the following characters: |, ., (, ), "
append_only str: Specifies whether this is an append-only stream. Available options are: "true" or "false". When the value is not set in the configuration the provider will put "default" there which means to use the Snowflake default for this value.
at StreamOnTableAtArgs
before StreamOnTableBeforeArgs
comment str: Specifies a comment for the stream.
copy_grants bool: Retains the access permissions from the original stream when a stream is recreated using the OR REPLACE clause. That is sometimes used when the provider detects changes for fields that can not be changed by ALTER. This value will not have any effect when creating a new stream.
name str: Specifies the identifier for the stream; must be unique for the database and schema in which the stream is created. Due to technical limitations (read more here), avoid using the following characters: |, ., (, ), "
show_initial_rows str

database String: The database in which to create the stream. Due to technical limitations (read more here), avoid using the following characters: |, ., (, ), "
schema String: The schema in which to create the stream. Due to technical limitations (read more here), avoid using the following characters: |, ., (, ), "
table String: Specifies an identifier for the table the stream will monitor. Due to technical limitations (read more here), avoid using the following characters: |, ., (, ), "
appendOnly String: Specifies whether this is an append-only stream. Available options are: "true" or "false". When the value is not set in the configuration the provider will put "default" there which means to use the Snowflake default for this value.
at Property Map
before Property Map
comment String: Specifies a comment for the stream.
copyGrants Boolean: Retains the access permissions from the original stream when a stream is recreated using the OR REPLACE clause. That is sometimes used when the provider detects changes for fields that can not be changed by ALTER. This value will not have any effect when creating a new stream.
name String: Specifies the identifier for the stream; must be unique for the database and schema in which the stream is created. Due to technical limitations (read more here), avoid using the following characters: |, ., (, ), "
showInitialRows String

Outputs

All input properties are implicitly available as output properties. Additionally, the StreamOnTable resource produces the following output properties:

DescribeOutputs List<StreamOnTableDescribeOutput>: Outputs the result of DESCRIBE STREAM for the given stream.
FullyQualifiedName string: Fully qualified name of the resource. For more information, see object name resolution.
Id string: The provider-assigned unique ID for this managed resource.
ShowOutputs List<StreamOnTableShowOutput>: Outputs the result of SHOW STREAMS for the given stream.
Stale bool
StreamType string: Specifies a type for the stream. This field is used for checking external changes and recreating the resources if needed.

DescribeOutputs []StreamOnTableDescribeOutput: Outputs the result of DESCRIBE STREAM for the given stream.
FullyQualifiedName string: Fully qualified name of the resource. For more information, see object name resolution.
Id string: The provider-assigned unique ID for this managed resource.
ShowOutputs []StreamOnTableShowOutput: Outputs the result of SHOW STREAMS for the given stream.
Stale bool
StreamType string: Specifies a type for the stream. This field is used for checking external changes and recreating the resources if needed.

describeOutputs List<StreamOnTableDescribeOutput>: Outputs the result of DESCRIBE STREAM for the given stream.
fullyQualifiedName String: Fully qualified name of the resource. For more information, see object name resolution.
id String: The provider-assigned unique ID for this managed resource.
showOutputs List<StreamOnTableShowOutput>: Outputs the result of SHOW STREAMS for the given stream.
stale Boolean
streamType String: Specifies a type for the stream. This field is used for checking external changes and recreating the resources if needed.

describeOutputs StreamOnTableDescribeOutput[]: Outputs the result of DESCRIBE STREAM for the given stream.
fullyQualifiedName string: Fully qualified name of the resource. For more information, see object name resolution.
id string: The provider-assigned unique ID for this managed resource.
showOutputs StreamOnTableShowOutput[]: Outputs the result of SHOW STREAMS for the given stream.
stale boolean
streamType string: Specifies a type for the stream. This field is used for checking external changes and recreating the resources if needed.

describe_outputs Sequence[StreamOnTableDescribeOutput]: Outputs the result of DESCRIBE STREAM for the given stream.
fully_qualified_name str: Fully qualified name of the resource. For more information, see object name resolution.
id str: The provider-assigned unique ID for this managed resource.
show_outputs Sequence[StreamOnTableShowOutput]: Outputs the result of SHOW STREAMS for the given stream.
stale bool
stream_type str: Specifies a type for the stream. This field is used for checking external changes and recreating the resources if needed.

describeOutputs List<Property Map>: Outputs the result of DESCRIBE STREAM for the given stream.
fullyQualifiedName String: Fully qualified name of the resource. For more information, see object name resolution.
id String: The provider-assigned unique ID for this managed resource.
showOutputs List<Property Map>: Outputs the result of SHOW STREAMS for the given stream.
stale Boolean
streamType String: Specifies a type for the stream. This field is used for checking external changes and recreating the resources if needed.

Look up Existing StreamOnTable Resource

Get an existing StreamOnTable resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: StreamOnTableState, opts?: CustomResourceOptions): StreamOnTable

@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        append_only: Optional[str] = None,
        at: Optional[StreamOnTableAtArgs] = None,
        before: Optional[StreamOnTableBeforeArgs] = None,
        comment: Optional[str] = None,
        copy_grants: Optional[bool] = None,
        database: Optional[str] = None,
        describe_outputs: Optional[Sequence[StreamOnTableDescribeOutputArgs]] = None,
        fully_qualified_name: Optional[str] = None,
        name: Optional[str] = None,
        schema: Optional[str] = None,
        show_initial_rows: Optional[str] = None,
        show_outputs: Optional[Sequence[StreamOnTableShowOutputArgs]] = None,
        stale: Optional[bool] = None,
        stream_type: Optional[str] = None,
        table: Optional[str] = None) -> StreamOnTable

func GetStreamOnTable(ctx *Context, name string, id IDInput, state *StreamOnTableState, opts ...ResourceOption) (*StreamOnTable, error)

public static StreamOnTable Get(string name, Input<string> id, StreamOnTableState? state, CustomResourceOptions? opts = null)

public static StreamOnTable get(String name, Output<String> id, StreamOnTableState state, CustomResourceOptions options)

Resource lookup is not supported in YAML

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

resource_name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

The following state arguments are supported:

AppendOnly string: Specifies whether this is an append-only stream. Available options are: "true" or "false". When the value is not set in the configuration the provider will put "default" there which means to use the Snowflake default for this value.
At StreamOnTableAt
Before StreamOnTableBefore
Comment string: Specifies a comment for the stream.
CopyGrants bool: Retains the access permissions from the original stream when a stream is recreated using the OR REPLACE clause. That is sometimes used when the provider detects changes for fields that can not be changed by ALTER. This value will not have any effect when creating a new stream.
Database string: The database in which to create the stream. Due to technical limitations (read more here), avoid using the following characters: |, ., (, ), "
DescribeOutputs List<StreamOnTableDescribeOutput>: Outputs the result of DESCRIBE STREAM for the given stream.
FullyQualifiedName string: Fully qualified name of the resource. For more information, see object name resolution.
Name string: Specifies the identifier for the stream; must be unique for the database and schema in which the stream is created. Due to technical limitations (read more here), avoid using the following characters: |, ., (, ), "
Schema string: The schema in which to create the stream. Due to technical limitations (read more here), avoid using the following characters: |, ., (, ), "
ShowInitialRows string
ShowOutputs List<StreamOnTableShowOutput>: Outputs the result of SHOW STREAMS for the given stream.
Stale bool
StreamType string: Specifies a type for the stream. This field is used for checking external changes and recreating the resources if needed.
Table string: Specifies an identifier for the table the stream will monitor. Due to technical limitations (read more here), avoid using the following characters: |, ., (, ), "

AppendOnly string: Specifies whether this is an append-only stream. Available options are: "true" or "false". When the value is not set in the configuration the provider will put "default" there which means to use the Snowflake default for this value.
At StreamOnTableAtArgs
Before StreamOnTableBeforeArgs
Comment string: Specifies a comment for the stream.
CopyGrants bool: Retains the access permissions from the original stream when a stream is recreated using the OR REPLACE clause. That is sometimes used when the provider detects changes for fields that can not be changed by ALTER. This value will not have any effect when creating a new stream.
Database string: The database in which to create the stream. Due to technical limitations (read more here), avoid using the following characters: |, ., (, ), "
DescribeOutputs []StreamOnTableDescribeOutputArgs: Outputs the result of DESCRIBE STREAM for the given stream.
FullyQualifiedName string: Fully qualified name of the resource. For more information, see object name resolution.
Name string: Specifies the identifier for the stream; must be unique for the database and schema in which the stream is created. Due to technical limitations (read more here), avoid using the following characters: |, ., (, ), "
Schema string: The schema in which to create the stream. Due to technical limitations (read more here), avoid using the following characters: |, ., (, ), "
ShowInitialRows string
ShowOutputs []StreamOnTableShowOutputArgs: Outputs the result of SHOW STREAMS for the given stream.
Stale bool
StreamType string: Specifies a type for the stream. This field is used for checking external changes and recreating the resources if needed.
Table string: Specifies an identifier for the table the stream will monitor. Due to technical limitations (read more here), avoid using the following characters: |, ., (, ), "

appendOnly String: Specifies whether this is an append-only stream. Available options are: "true" or "false". When the value is not set in the configuration the provider will put "default" there which means to use the Snowflake default for this value.
at StreamOnTableAt
before StreamOnTableBefore
comment String: Specifies a comment for the stream.
copyGrants Boolean: Retains the access permissions from the original stream when a stream is recreated using the OR REPLACE clause. That is sometimes used when the provider detects changes for fields that can not be changed by ALTER. This value will not have any effect when creating a new stream.
database String: The database in which to create the stream. Due to technical limitations (read more here), avoid using the following characters: |, ., (, ), "
describeOutputs List<StreamOnTableDescribeOutput>: Outputs the result of DESCRIBE STREAM for the given stream.
fullyQualifiedName String: Fully qualified name of the resource. For more information, see object name resolution.
name String: Specifies the identifier for the stream; must be unique for the database and schema in which the stream is created. Due to technical limitations (read more here), avoid using the following characters: |, ., (, ), "
schema String: The schema in which to create the stream. Due to technical limitations (read more here), avoid using the following characters: |, ., (, ), "
showInitialRows String
showOutputs List<StreamOnTableShowOutput>: Outputs the result of SHOW STREAMS for the given stream.
stale Boolean
streamType String: Specifies a type for the stream. This field is used for checking external changes and recreating the resources if needed.
table String: Specifies an identifier for the table the stream will monitor. Due to technical limitations (read more here), avoid using the following characters: |, ., (, ), "

appendOnly string: Specifies whether this is an append-only stream. Available options are: "true" or "false". When the value is not set in the configuration the provider will put "default" there which means to use the Snowflake default for this value.
at StreamOnTableAt
before StreamOnTableBefore
comment string: Specifies a comment for the stream.
copyGrants boolean: Retains the access permissions from the original stream when a stream is recreated using the OR REPLACE clause. That is sometimes used when the provider detects changes for fields that can not be changed by ALTER. This value will not have any effect when creating a new stream.
database string: The database in which to create the stream. Due to technical limitations (read more here), avoid using the following characters: |, ., (, ), "
describeOutputs StreamOnTableDescribeOutput[]: Outputs the result of DESCRIBE STREAM for the given stream.
fullyQualifiedName string: Fully qualified name of the resource. For more information, see object name resolution.
name string: Specifies the identifier for the stream; must be unique for the database and schema in which the stream is created. Due to technical limitations (read more here), avoid using the following characters: |, ., (, ), "
schema string: The schema in which to create the stream. Due to technical limitations (read more here), avoid using the following characters: |, ., (, ), "
showInitialRows string
showOutputs StreamOnTableShowOutput[]: Outputs the result of SHOW STREAMS for the given stream.
stale boolean
streamType string: Specifies a type for the stream. This field is used for checking external changes and recreating the resources if needed.
table string: Specifies an identifier for the table the stream will monitor. Due to technical limitations (read more here), avoid using the following characters: |, ., (, ), "

append_only str: Specifies whether this is an append-only stream. Available options are: "true" or "false". When the value is not set in the configuration the provider will put "default" there which means to use the Snowflake default for this value.
at StreamOnTableAtArgs
before StreamOnTableBeforeArgs
comment str: Specifies a comment for the stream.
copy_grants bool: Retains the access permissions from the original stream when a stream is recreated using the OR REPLACE clause. That is sometimes used when the provider detects changes for fields that can not be changed by ALTER. This value will not have any effect when creating a new stream.
database str: The database in which to create the stream. Due to technical limitations (read more here), avoid using the following characters: |, ., (, ), "
describe_outputs Sequence[StreamOnTableDescribeOutputArgs]: Outputs the result of DESCRIBE STREAM for the given stream.
fully_qualified_name str: Fully qualified name of the resource. For more information, see object name resolution.
name str: Specifies the identifier for the stream; must be unique for the database and schema in which the stream is created. Due to technical limitations (read more here), avoid using the following characters: |, ., (, ), "
schema str: The schema in which to create the stream. Due to technical limitations (read more here), avoid using the following characters: |, ., (, ), "
show_initial_rows str
show_outputs Sequence[StreamOnTableShowOutputArgs]: Outputs the result of SHOW STREAMS for the given stream.
stale bool
stream_type str: Specifies a type for the stream. This field is used for checking external changes and recreating the resources if needed.
table str: Specifies an identifier for the table the stream will monitor. Due to technical limitations (read more here), avoid using the following characters: |, ., (, ), "

appendOnly String: Specifies whether this is an append-only stream. Available options are: "true" or "false". When the value is not set in the configuration the provider will put "default" there which means to use the Snowflake default for this value.
at Property Map
before Property Map
comment String: Specifies a comment for the stream.
copyGrants Boolean: Retains the access permissions from the original stream when a stream is recreated using the OR REPLACE clause. That is sometimes used when the provider detects changes for fields that can not be changed by ALTER. This value will not have any effect when creating a new stream.
database String: The database in which to create the stream. Due to technical limitations (read more here), avoid using the following characters: |, ., (, ), "
describeOutputs List<Property Map>: Outputs the result of DESCRIBE STREAM for the given stream.
fullyQualifiedName String: Fully qualified name of the resource. For more information, see object name resolution.
name String: Specifies the identifier for the stream; must be unique for the database and schema in which the stream is created. Due to technical limitations (read more here), avoid using the following characters: |, ., (, ), "
schema String: The schema in which to create the stream. Due to technical limitations (read more here), avoid using the following characters: |, ., (, ), "
showInitialRows String
showOutputs List<Property Map>: Outputs the result of SHOW STREAMS for the given stream.
stale Boolean
streamType String: Specifies a type for the stream. This field is used for checking external changes and recreating the resources if needed.
table String: Specifies an identifier for the table the stream will monitor. Due to technical limitations (read more here), avoid using the following characters: |, ., (, ), "

Supporting Types

StreamOnTableAt, StreamOnTableAtArgs

Offset string: Specifies the difference in seconds from the current time to use for Time Travel, in the form -N where N can be an integer or arithmetic expression (e.g. -120 is 120 seconds, -30*60 is 1800 seconds or 30 minutes).
Statement string: Specifies the query ID of a statement to use as the reference point for Time Travel. This parameter supports any statement of one of the following types: DML (e.g. INSERT, UPDATE, DELETE), TCL (BEGIN, COMMIT transaction), SELECT.
Stream string: Specifies the identifier (i.e. name) for an existing stream on the queried table or view. The current offset in the stream is used as the AT point in time for returning change data for the source object.
Timestamp string: Specifies an exact date and time to use for Time Travel. The value must be explicitly cast to a TIMESTAMP, TIMESTAMPLTZ, TIMESTAMPNTZ, or TIMESTAMP_TZ data type.

Offset string: Specifies the difference in seconds from the current time to use for Time Travel, in the form -N where N can be an integer or arithmetic expression (e.g. -120 is 120 seconds, -30*60 is 1800 seconds or 30 minutes).
Statement string: Specifies the query ID of a statement to use as the reference point for Time Travel. This parameter supports any statement of one of the following types: DML (e.g. INSERT, UPDATE, DELETE), TCL (BEGIN, COMMIT transaction), SELECT.
Stream string: Specifies the identifier (i.e. name) for an existing stream on the queried table or view. The current offset in the stream is used as the AT point in time for returning change data for the source object.
Timestamp string: Specifies an exact date and time to use for Time Travel. The value must be explicitly cast to a TIMESTAMP, TIMESTAMPLTZ, TIMESTAMPNTZ, or TIMESTAMP_TZ data type.

offset String: Specifies the difference in seconds from the current time to use for Time Travel, in the form -N where N can be an integer or arithmetic expression (e.g. -120 is 120 seconds, -30*60 is 1800 seconds or 30 minutes).
statement String: Specifies the query ID of a statement to use as the reference point for Time Travel. This parameter supports any statement of one of the following types: DML (e.g. INSERT, UPDATE, DELETE), TCL (BEGIN, COMMIT transaction), SELECT.
stream String: Specifies the identifier (i.e. name) for an existing stream on the queried table or view. The current offset in the stream is used as the AT point in time for returning change data for the source object.
timestamp String: Specifies an exact date and time to use for Time Travel. The value must be explicitly cast to a TIMESTAMP, TIMESTAMPLTZ, TIMESTAMPNTZ, or TIMESTAMP_TZ data type.

offset string: Specifies the difference in seconds from the current time to use for Time Travel, in the form -N where N can be an integer or arithmetic expression (e.g. -120 is 120 seconds, -30*60 is 1800 seconds or 30 minutes).
statement string: Specifies the query ID of a statement to use as the reference point for Time Travel. This parameter supports any statement of one of the following types: DML (e.g. INSERT, UPDATE, DELETE), TCL (BEGIN, COMMIT transaction), SELECT.
stream string: Specifies the identifier (i.e. name) for an existing stream on the queried table or view. The current offset in the stream is used as the AT point in time for returning change data for the source object.
timestamp string: Specifies an exact date and time to use for Time Travel. The value must be explicitly cast to a TIMESTAMP, TIMESTAMPLTZ, TIMESTAMPNTZ, or TIMESTAMP_TZ data type.

offset str: Specifies the difference in seconds from the current time to use for Time Travel, in the form -N where N can be an integer or arithmetic expression (e.g. -120 is 120 seconds, -30*60 is 1800 seconds or 30 minutes).
statement str: Specifies the query ID of a statement to use as the reference point for Time Travel. This parameter supports any statement of one of the following types: DML (e.g. INSERT, UPDATE, DELETE), TCL (BEGIN, COMMIT transaction), SELECT.
stream str: Specifies the identifier (i.e. name) for an existing stream on the queried table or view. The current offset in the stream is used as the AT point in time for returning change data for the source object.
timestamp str: Specifies an exact date and time to use for Time Travel. The value must be explicitly cast to a TIMESTAMP, TIMESTAMPLTZ, TIMESTAMPNTZ, or TIMESTAMP_TZ data type.

offset String: Specifies the difference in seconds from the current time to use for Time Travel, in the form -N where N can be an integer or arithmetic expression (e.g. -120 is 120 seconds, -30*60 is 1800 seconds or 30 minutes).
statement String: Specifies the query ID of a statement to use as the reference point for Time Travel. This parameter supports any statement of one of the following types: DML (e.g. INSERT, UPDATE, DELETE), TCL (BEGIN, COMMIT transaction), SELECT.
stream String: Specifies the identifier (i.e. name) for an existing stream on the queried table or view. The current offset in the stream is used as the AT point in time for returning change data for the source object.
timestamp String: Specifies an exact date and time to use for Time Travel. The value must be explicitly cast to a TIMESTAMP, TIMESTAMPLTZ, TIMESTAMPNTZ, or TIMESTAMP_TZ data type.

StreamOnTableBefore, StreamOnTableBeforeArgs

Offset string: Specifies the difference in seconds from the current time to use for Time Travel, in the form -N where N can be an integer or arithmetic expression (e.g. -120 is 120 seconds, -30*60 is 1800 seconds or 30 minutes).
Statement string: Specifies the query ID of a statement to use as the reference point for Time Travel. This parameter supports any statement of one of the following types: DML (e.g. INSERT, UPDATE, DELETE), TCL (BEGIN, COMMIT transaction), SELECT.
Stream string: Specifies the identifier (i.e. name) for an existing stream on the queried table or view. The current offset in the stream is used as the AT point in time for returning change data for the source object.
Timestamp string: Specifies an exact date and time to use for Time Travel. The value must be explicitly cast to a TIMESTAMP, TIMESTAMPLTZ, TIMESTAMPNTZ, or TIMESTAMP_TZ data type.

Offset string: Specifies the difference in seconds from the current time to use for Time Travel, in the form -N where N can be an integer or arithmetic expression (e.g. -120 is 120 seconds, -30*60 is 1800 seconds or 30 minutes).
Statement string: Specifies the query ID of a statement to use as the reference point for Time Travel. This parameter supports any statement of one of the following types: DML (e.g. INSERT, UPDATE, DELETE), TCL (BEGIN, COMMIT transaction), SELECT.
Stream string: Specifies the identifier (i.e. name) for an existing stream on the queried table or view. The current offset in the stream is used as the AT point in time for returning change data for the source object.
Timestamp string: Specifies an exact date and time to use for Time Travel. The value must be explicitly cast to a TIMESTAMP, TIMESTAMPLTZ, TIMESTAMPNTZ, or TIMESTAMP_TZ data type.

offset String: Specifies the difference in seconds from the current time to use for Time Travel, in the form -N where N can be an integer or arithmetic expression (e.g. -120 is 120 seconds, -30*60 is 1800 seconds or 30 minutes).
statement String: Specifies the query ID of a statement to use as the reference point for Time Travel. This parameter supports any statement of one of the following types: DML (e.g. INSERT, UPDATE, DELETE), TCL (BEGIN, COMMIT transaction), SELECT.
stream String: Specifies the identifier (i.e. name) for an existing stream on the queried table or view. The current offset in the stream is used as the AT point in time for returning change data for the source object.
timestamp String: Specifies an exact date and time to use for Time Travel. The value must be explicitly cast to a TIMESTAMP, TIMESTAMPLTZ, TIMESTAMPNTZ, or TIMESTAMP_TZ data type.

offset string: Specifies the difference in seconds from the current time to use for Time Travel, in the form -N where N can be an integer or arithmetic expression (e.g. -120 is 120 seconds, -30*60 is 1800 seconds or 30 minutes).
statement string: Specifies the query ID of a statement to use as the reference point for Time Travel. This parameter supports any statement of one of the following types: DML (e.g. INSERT, UPDATE, DELETE), TCL (BEGIN, COMMIT transaction), SELECT.
stream string: Specifies the identifier (i.e. name) for an existing stream on the queried table or view. The current offset in the stream is used as the AT point in time for returning change data for the source object.
timestamp string: Specifies an exact date and time to use for Time Travel. The value must be explicitly cast to a TIMESTAMP, TIMESTAMPLTZ, TIMESTAMPNTZ, or TIMESTAMP_TZ data type.

offset str: Specifies the difference in seconds from the current time to use for Time Travel, in the form -N where N can be an integer or arithmetic expression (e.g. -120 is 120 seconds, -30*60 is 1800 seconds or 30 minutes).
statement str: Specifies the query ID of a statement to use as the reference point for Time Travel. This parameter supports any statement of one of the following types: DML (e.g. INSERT, UPDATE, DELETE), TCL (BEGIN, COMMIT transaction), SELECT.
stream str: Specifies the identifier (i.e. name) for an existing stream on the queried table or view. The current offset in the stream is used as the AT point in time for returning change data for the source object.
timestamp str: Specifies an exact date and time to use for Time Travel. The value must be explicitly cast to a TIMESTAMP, TIMESTAMPLTZ, TIMESTAMPNTZ, or TIMESTAMP_TZ data type.

offset String: Specifies the difference in seconds from the current time to use for Time Travel, in the form -N where N can be an integer or arithmetic expression (e.g. -120 is 120 seconds, -30*60 is 1800 seconds or 30 minutes).
statement String: Specifies the query ID of a statement to use as the reference point for Time Travel. This parameter supports any statement of one of the following types: DML (e.g. INSERT, UPDATE, DELETE), TCL (BEGIN, COMMIT transaction), SELECT.
stream String: Specifies the identifier (i.e. name) for an existing stream on the queried table or view. The current offset in the stream is used as the AT point in time for returning change data for the source object.
timestamp String: Specifies an exact date and time to use for Time Travel. The value must be explicitly cast to a TIMESTAMP, TIMESTAMPLTZ, TIMESTAMPNTZ, or TIMESTAMP_TZ data type.