snowflake.StreamOnView
Explore with Pulumi AI
Import
$ pulumi import snowflake:index/streamOnView:StreamOnView example '"<database_name>"."<schema_name>"."<stream_name>"'
Create StreamOnView Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new StreamOnView(name: string, args: StreamOnViewArgs, opts?: CustomResourceOptions);
@overload
def StreamOnView(resource_name: str,
args: StreamOnViewArgs,
opts: Optional[ResourceOptions] = None)
@overload
def StreamOnView(resource_name: str,
opts: Optional[ResourceOptions] = None,
database: Optional[str] = None,
schema: Optional[str] = None,
view: Optional[str] = None,
append_only: Optional[str] = None,
at: Optional[StreamOnViewAtArgs] = None,
before: Optional[StreamOnViewBeforeArgs] = None,
comment: Optional[str] = None,
copy_grants: Optional[bool] = None,
name: Optional[str] = None,
show_initial_rows: Optional[str] = None)
func NewStreamOnView(ctx *Context, name string, args StreamOnViewArgs, opts ...ResourceOption) (*StreamOnView, error)
public StreamOnView(string name, StreamOnViewArgs args, CustomResourceOptions? opts = null)
public StreamOnView(String name, StreamOnViewArgs args)
public StreamOnView(String name, StreamOnViewArgs args, CustomResourceOptions options)
type: snowflake:StreamOnView
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 StreamOnViewArgs
- 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 StreamOnViewArgs
- 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 StreamOnViewArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args StreamOnViewArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args StreamOnViewArgs
- 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 streamOnViewResource = new Snowflake.StreamOnView("streamOnViewResource", new()
{
Database = "string",
Schema = "string",
View = "string",
AppendOnly = "string",
At = new Snowflake.Inputs.StreamOnViewAtArgs
{
Offset = "string",
Statement = "string",
Stream = "string",
Timestamp = "string",
},
Before = new Snowflake.Inputs.StreamOnViewBeforeArgs
{
Offset = "string",
Statement = "string",
Stream = "string",
Timestamp = "string",
},
Comment = "string",
CopyGrants = false,
Name = "string",
ShowInitialRows = "string",
});
example, err := snowflake.NewStreamOnView(ctx, "streamOnViewResource", &snowflake.StreamOnViewArgs{
Database: pulumi.String("string"),
Schema: pulumi.String("string"),
View: pulumi.String("string"),
AppendOnly: pulumi.String("string"),
At: &snowflake.StreamOnViewAtArgs{
Offset: pulumi.String("string"),
Statement: pulumi.String("string"),
Stream: pulumi.String("string"),
Timestamp: pulumi.String("string"),
},
Before: &snowflake.StreamOnViewBeforeArgs{
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 streamOnViewResource = new StreamOnView("streamOnViewResource", StreamOnViewArgs.builder()
.database("string")
.schema("string")
.view("string")
.appendOnly("string")
.at(StreamOnViewAtArgs.builder()
.offset("string")
.statement("string")
.stream("string")
.timestamp("string")
.build())
.before(StreamOnViewBeforeArgs.builder()
.offset("string")
.statement("string")
.stream("string")
.timestamp("string")
.build())
.comment("string")
.copyGrants(false)
.name("string")
.showInitialRows("string")
.build());
stream_on_view_resource = snowflake.StreamOnView("streamOnViewResource",
database="string",
schema="string",
view="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 streamOnViewResource = new snowflake.StreamOnView("streamOnViewResource", {
database: "string",
schema: "string",
view: "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:StreamOnView
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
view: string
StreamOnView 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 StreamOnView 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:
|
,.
,(
,)
,"
- View string
- Specifies an identifier for the view the stream will monitor. Due to technical limitations (read more here), avoid using the following characters:
|
,.
,(
,)
,"
- Append
Only 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
Stream
On View At - Before
Stream
On View Before - Comment string
- 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 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:
|
,.
,(
,)
,"
- Show
Initial stringRows
- 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:
|
,.
,(
,)
,"
- View string
- Specifies an identifier for the view the stream will monitor. Due to technical limitations (read more here), avoid using the following characters:
|
,.
,(
,)
,"
- Append
Only 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
Stream
On View At Args - Before
Stream
On View Before Args - Comment string
- 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 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:
|
,.
,(
,)
,"
- Show
Initial stringRows
- 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:
|
,.
,(
,)
,"
- view String
- Specifies an identifier for the view the stream will monitor. Due to technical limitations (read more here), avoid using the following characters:
|
,.
,(
,)
,"
- append
Only 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
Stream
On View At - before
Stream
On View Before - comment String
- Specifies a comment for the stream.
- copy
Grants 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:
|
,.
,(
,)
,"
- show
Initial StringRows
- 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:
|
,.
,(
,)
,"
- view string
- Specifies an identifier for the view the stream will monitor. Due to technical limitations (read more here), avoid using the following characters:
|
,.
,(
,)
,"
- append
Only 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
Stream
On View At - before
Stream
On View Before - comment string
- Specifies a comment for the stream.
- copy
Grants 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:
|
,.
,(
,)
,"
- show
Initial stringRows
- 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:
|
,.
,(
,)
,"
- view str
- Specifies an identifier for the view 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
Stream
On View At Args - before
Stream
On View Before Args - 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_ strrows
- 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:
|
,.
,(
,)
,"
- view String
- Specifies an identifier for the view the stream will monitor. Due to technical limitations (read more here), avoid using the following characters:
|
,.
,(
,)
,"
- append
Only 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.
- copy
Grants 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:
|
,.
,(
,)
,"
- show
Initial StringRows
Outputs
All input properties are implicitly available as output properties. Additionally, the StreamOnView resource produces the following output properties:
- Describe
Outputs List<StreamOn View Describe Output> - Outputs the result of
DESCRIBE STREAM
for the given stream. - Fully
Qualified stringName - Fully qualified name of the resource. For more information, see object name resolution.
- Id string
- The provider-assigned unique ID for this managed resource.
- Show
Outputs List<StreamOn View Show Output> - Outputs the result of
SHOW STREAMS
for the given stream. - Stale bool
- Stream
Type string - Specifies a type for the stream. This field is used for checking external changes and recreating the resources if needed.
- Describe
Outputs []StreamOn View Describe Output - Outputs the result of
DESCRIBE STREAM
for the given stream. - Fully
Qualified stringName - Fully qualified name of the resource. For more information, see object name resolution.
- Id string
- The provider-assigned unique ID for this managed resource.
- Show
Outputs []StreamOn View Show Output - Outputs the result of
SHOW STREAMS
for the given stream. - Stale bool
- Stream
Type string - Specifies a type for the stream. This field is used for checking external changes and recreating the resources if needed.
- describe
Outputs List<StreamOn View Describe Output> - Outputs the result of
DESCRIBE STREAM
for the given stream. - fully
Qualified StringName - Fully qualified name of the resource. For more information, see object name resolution.
- id String
- The provider-assigned unique ID for this managed resource.
- show
Outputs List<StreamOn View Show Output> - Outputs the result of
SHOW STREAMS
for the given stream. - stale Boolean
- stream
Type String - Specifies a type for the stream. This field is used for checking external changes and recreating the resources if needed.
- describe
Outputs StreamOn View Describe Output[] - Outputs the result of
DESCRIBE STREAM
for the given stream. - fully
Qualified stringName - Fully qualified name of the resource. For more information, see object name resolution.
- id string
- The provider-assigned unique ID for this managed resource.
- show
Outputs StreamOn View Show Output[] - Outputs the result of
SHOW STREAMS
for the given stream. - stale boolean
- stream
Type string - Specifies a type for the stream. This field is used for checking external changes and recreating the resources if needed.
- describe_
outputs Sequence[StreamOn View Describe Output] - Outputs the result of
DESCRIBE STREAM
for the given stream. - fully_
qualified_ strname - 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[StreamOn View Show Output] - 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.
- describe
Outputs List<Property Map> - Outputs the result of
DESCRIBE STREAM
for the given stream. - fully
Qualified StringName - Fully qualified name of the resource. For more information, see object name resolution.
- id String
- The provider-assigned unique ID for this managed resource.
- show
Outputs List<Property Map> - Outputs the result of
SHOW STREAMS
for the given stream. - stale Boolean
- stream
Type String - Specifies a type for the stream. This field is used for checking external changes and recreating the resources if needed.
Look up Existing StreamOnView Resource
Get an existing StreamOnView 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?: StreamOnViewState, opts?: CustomResourceOptions): StreamOnView
@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
append_only: Optional[str] = None,
at: Optional[StreamOnViewAtArgs] = None,
before: Optional[StreamOnViewBeforeArgs] = None,
comment: Optional[str] = None,
copy_grants: Optional[bool] = None,
database: Optional[str] = None,
describe_outputs: Optional[Sequence[StreamOnViewDescribeOutputArgs]] = 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[StreamOnViewShowOutputArgs]] = None,
stale: Optional[bool] = None,
stream_type: Optional[str] = None,
view: Optional[str] = None) -> StreamOnView
func GetStreamOnView(ctx *Context, name string, id IDInput, state *StreamOnViewState, opts ...ResourceOption) (*StreamOnView, error)
public static StreamOnView Get(string name, Input<string> id, StreamOnViewState? state, CustomResourceOptions? opts = null)
public static StreamOnView get(String name, Output<String> id, StreamOnViewState 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.
- Append
Only 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
Stream
On View At - Before
Stream
On View Before - Comment string
- 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 string
- The database in which to create the stream. Due to technical limitations (read more here), avoid using the following characters:
|
,.
,(
,)
,"
- Describe
Outputs List<StreamOn View Describe Output> - Outputs the result of
DESCRIBE STREAM
for the given stream. - Fully
Qualified stringName - 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:
|
,.
,(
,)
,"
- Show
Initial stringRows - Show
Outputs List<StreamOn View Show Output> - Outputs the result of
SHOW STREAMS
for the given stream. - Stale bool
- Stream
Type string - Specifies a type for the stream. This field is used for checking external changes and recreating the resources if needed.
- View string
- Specifies an identifier for the view the stream will monitor. Due to technical limitations (read more here), avoid using the following characters:
|
,.
,(
,)
,"
- Append
Only 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
Stream
On View At Args - Before
Stream
On View Before Args - Comment string
- 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 string
- The database in which to create the stream. Due to technical limitations (read more here), avoid using the following characters:
|
,.
,(
,)
,"
- Describe
Outputs []StreamOn View Describe Output Args - Outputs the result of
DESCRIBE STREAM
for the given stream. - Fully
Qualified stringName - 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:
|
,.
,(
,)
,"
- Show
Initial stringRows - Show
Outputs []StreamOn View Show Output Args - Outputs the result of
SHOW STREAMS
for the given stream. - Stale bool
- Stream
Type string - Specifies a type for the stream. This field is used for checking external changes and recreating the resources if needed.
- View string
- Specifies an identifier for the view the stream will monitor. Due to technical limitations (read more here), avoid using the following characters:
|
,.
,(
,)
,"
- append
Only 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
Stream
On View At - before
Stream
On View Before - comment String
- Specifies a comment for the stream.
- copy
Grants 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:
|
,.
,(
,)
,"
- describe
Outputs List<StreamOn View Describe Output> - Outputs the result of
DESCRIBE STREAM
for the given stream. - fully
Qualified StringName - 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:
|
,.
,(
,)
,"
- show
Initial StringRows - show
Outputs List<StreamOn View Show Output> - Outputs the result of
SHOW STREAMS
for the given stream. - stale Boolean
- stream
Type String - Specifies a type for the stream. This field is used for checking external changes and recreating the resources if needed.
- view String
- Specifies an identifier for the view the stream will monitor. Due to technical limitations (read more here), avoid using the following characters:
|
,.
,(
,)
,"
- append
Only 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
Stream
On View At - before
Stream
On View Before - comment string
- Specifies a comment for the stream.
- copy
Grants 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:
|
,.
,(
,)
,"
- describe
Outputs StreamOn View Describe Output[] - Outputs the result of
DESCRIBE STREAM
for the given stream. - fully
Qualified stringName - 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:
|
,.
,(
,)
,"
- show
Initial stringRows - show
Outputs StreamOn View Show Output[] - Outputs the result of
SHOW STREAMS
for the given stream. - stale boolean
- stream
Type string - Specifies a type for the stream. This field is used for checking external changes and recreating the resources if needed.
- view string
- Specifies an identifier for the view 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
Stream
On View At Args - before
Stream
On View Before Args - 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[StreamOn View Describe Output Args] - Outputs the result of
DESCRIBE STREAM
for the given stream. - fully_
qualified_ strname - 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_ strrows - show_
outputs Sequence[StreamOn View Show Output Args] - 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.
- view str
- Specifies an identifier for the view the stream will monitor. Due to technical limitations (read more here), avoid using the following characters:
|
,.
,(
,)
,"
- append
Only 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.
- copy
Grants 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:
|
,.
,(
,)
,"
- describe
Outputs List<Property Map> - Outputs the result of
DESCRIBE STREAM
for the given stream. - fully
Qualified StringName - 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:
|
,.
,(
,)
,"
- show
Initial StringRows - show
Outputs List<Property Map> - Outputs the result of
SHOW STREAMS
for the given stream. - stale Boolean
- stream
Type String - Specifies a type for the stream. This field is used for checking external changes and recreating the resources if needed.
- view String
- Specifies an identifier for the view the stream will monitor. Due to technical limitations (read more here), avoid using the following characters:
|
,.
,(
,)
,"
Supporting Types
StreamOnViewAt, StreamOnViewAtArgs
- 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.
StreamOnViewBefore, StreamOnViewBeforeArgs
- 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.
StreamOnViewDescribeOutput, StreamOnViewDescribeOutputArgs
- Base
Tables List<string> - Comment string
- Created
On string - Database
Name string - Invalid
Reason string - Mode string
- Name string
- Owner string
- Owner
Role stringType - Schema
Name string - Source
Type string - Stale bool
- Stale
After string - Table
Name string - Type string
- Base
Tables []string - Comment string
- Created
On string - Database
Name string - Invalid
Reason string - Mode string
- Name string
- Owner string
- Owner
Role stringType - Schema
Name string - Source
Type string - Stale bool
- Stale
After string - Table
Name string - Type string
- base
Tables List<String> - comment String
- created
On String - database
Name String - invalid
Reason String - mode String
- name String
- owner String
- owner
Role StringType - schema
Name String - source
Type String - stale Boolean
- stale
After String - table
Name String - type String
- base
Tables string[] - comment string
- created
On string - database
Name string - invalid
Reason string - mode string
- name string
- owner string
- owner
Role stringType - schema
Name string - source
Type string - stale boolean
- stale
After string - table
Name string - type string
- base_
tables Sequence[str] - comment str
- created_
on str - database_
name str - invalid_
reason str - mode str
- name str
- owner str
- owner_
role_ strtype - schema_
name str - source_
type str - stale bool
- stale_
after str - table_
name str - type str
- base
Tables List<String> - comment String
- created
On String - database
Name String - invalid
Reason String - mode String
- name String
- owner String
- owner
Role StringType - schema
Name String - source
Type String - stale Boolean
- stale
After String - table
Name String - type String
StreamOnViewShowOutput, StreamOnViewShowOutputArgs
- Base
Tables List<string> - Comment string
- Created
On string - Database
Name string - Invalid
Reason string - Mode string
- Name string
- Owner string
- Owner
Role stringType - Schema
Name string - Source
Type string - Stale bool
- Stale
After string - Table
Name string - Type string
- Base
Tables []string - Comment string
- Created
On string - Database
Name string - Invalid
Reason string - Mode string
- Name string
- Owner string
- Owner
Role stringType - Schema
Name string - Source
Type string - Stale bool
- Stale
After string - Table
Name string - Type string
- base
Tables List<String> - comment String
- created
On String - database
Name String - invalid
Reason String - mode String
- name String
- owner String
- owner
Role StringType - schema
Name String - source
Type String - stale Boolean
- stale
After String - table
Name String - type String
- base
Tables string[] - comment string
- created
On string - database
Name string - invalid
Reason string - mode string
- name string
- owner string
- owner
Role stringType - schema
Name string - source
Type string - stale boolean
- stale
After string - table
Name string - type string
- base_
tables Sequence[str] - comment str
- created_
on str - database_
name str - invalid_
reason str - mode str
- name str
- owner str
- owner_
role_ strtype - schema_
name str - source_
type str - stale bool
- stale_
after str - table_
name str - type str
- base
Tables List<String> - comment String
- created
On String - database
Name String - invalid
Reason String - mode String
- name String
- owner String
- owner
Role StringType - schema
Name String - source
Type String - stale Boolean
- stale
After String - table
Name String - type String
Package Details
- Repository
- Snowflake pulumi/pulumi-snowflake
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
snowflake
Terraform Provider.