snowflake.getStreams
Explore with Pulumi AI
!> V1 release candidate This data source was reworked and is a release candidate for the V1. We do not expect significant changes in it before the V1. We will welcome any feedback and adjust the data source if needed. Any errors reported will be resolved with a higher priority. We encourage checking this data source out before the V1 release. Please follow the migration guide to use it.
Datasource used to get details of filtered streams. Filtering is aligned with the current possibilities for SHOW STREAMS query. The results of SHOW and DESCRIBE are encapsulated in one output collection streams
.
Example Usage
Coming soon!
Coming soon!
Coming soon!
Coming soon!
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.snowflake.SnowflakeFunctions;
import com.pulumi.snowflake.inputs.GetStreamsArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
final var current = SnowflakeFunctions.getStreams(GetStreamsArgs.builder()
.database("MYDB")
.schema("MYSCHEMA")
.build());
}
}
variables:
current:
fn::invoke:
Function: snowflake:getStreams
Arguments:
database: MYDB
schema: MYSCHEMA
Using getStreams
Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.
function getStreams(args: GetStreamsArgs, opts?: InvokeOptions): Promise<GetStreamsResult>
function getStreamsOutput(args: GetStreamsOutputArgs, opts?: InvokeOptions): Output<GetStreamsResult>
def get_streams(in_: Optional[GetStreamsIn] = None,
like: Optional[str] = None,
limit: Optional[GetStreamsLimit] = None,
starts_with: Optional[str] = None,
with_describe: Optional[bool] = None,
opts: Optional[InvokeOptions] = None) -> GetStreamsResult
def get_streams_output(in_: Optional[pulumi.Input[GetStreamsInArgs]] = None,
like: Optional[pulumi.Input[str]] = None,
limit: Optional[pulumi.Input[GetStreamsLimitArgs]] = None,
starts_with: Optional[pulumi.Input[str]] = None,
with_describe: Optional[pulumi.Input[bool]] = None,
opts: Optional[InvokeOptions] = None) -> Output[GetStreamsResult]
func GetStreams(ctx *Context, args *GetStreamsArgs, opts ...InvokeOption) (*GetStreamsResult, error)
func GetStreamsOutput(ctx *Context, args *GetStreamsOutputArgs, opts ...InvokeOption) GetStreamsResultOutput
> Note: This function is named GetStreams
in the Go SDK.
public static class GetStreams
{
public static Task<GetStreamsResult> InvokeAsync(GetStreamsArgs args, InvokeOptions? opts = null)
public static Output<GetStreamsResult> Invoke(GetStreamsInvokeArgs args, InvokeOptions? opts = null)
}
public static CompletableFuture<GetStreamsResult> getStreams(GetStreamsArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet
fn::invoke:
function: snowflake:index/getStreams:getStreams
arguments:
# arguments dictionary
The following arguments are supported:
- In
Get
Streams In - IN clause to filter the list of objects
- Like string
- Filters the output with case-insensitive pattern, with support for SQL wildcard characters (
%
and_
). - Limit
Get
Streams Limit - Limits the number of rows returned. If the
limit.from
is set, then the limit wll start from the first element matched by the expression. The expression is only used to match with the first element, later on the elements are not matched by the prefix, but you can enforce a certain pattern withstarts_with
orlike
. - Starts
With string - Filters the output with case-sensitive characters indicating the beginning of the object name.
- With
Describe bool - Runs DESC STREAM for each user returned by SHOW STREAMS. The output of describe is saved to the description field. By default this value is set to true.
- In
Get
Streams In - IN clause to filter the list of objects
- Like string
- Filters the output with case-insensitive pattern, with support for SQL wildcard characters (
%
and_
). - Limit
Get
Streams Limit - Limits the number of rows returned. If the
limit.from
is set, then the limit wll start from the first element matched by the expression. The expression is only used to match with the first element, later on the elements are not matched by the prefix, but you can enforce a certain pattern withstarts_with
orlike
. - Starts
With string - Filters the output with case-sensitive characters indicating the beginning of the object name.
- With
Describe bool - Runs DESC STREAM for each user returned by SHOW STREAMS. The output of describe is saved to the description field. By default this value is set to true.
- in
Get
Streams In - IN clause to filter the list of objects
- like String
- Filters the output with case-insensitive pattern, with support for SQL wildcard characters (
%
and_
). - limit
Get
Streams Limit - Limits the number of rows returned. If the
limit.from
is set, then the limit wll start from the first element matched by the expression. The expression is only used to match with the first element, later on the elements are not matched by the prefix, but you can enforce a certain pattern withstarts_with
orlike
. - starts
With String - Filters the output with case-sensitive characters indicating the beginning of the object name.
- with
Describe Boolean - Runs DESC STREAM for each user returned by SHOW STREAMS. The output of describe is saved to the description field. By default this value is set to true.
- in
Get
Streams In - IN clause to filter the list of objects
- like string
- Filters the output with case-insensitive pattern, with support for SQL wildcard characters (
%
and_
). - limit
Get
Streams Limit - Limits the number of rows returned. If the
limit.from
is set, then the limit wll start from the first element matched by the expression. The expression is only used to match with the first element, later on the elements are not matched by the prefix, but you can enforce a certain pattern withstarts_with
orlike
. - starts
With string - Filters the output with case-sensitive characters indicating the beginning of the object name.
- with
Describe boolean - Runs DESC STREAM for each user returned by SHOW STREAMS. The output of describe is saved to the description field. By default this value is set to true.
- in_
Get
Streams In - IN clause to filter the list of objects
- like str
- Filters the output with case-insensitive pattern, with support for SQL wildcard characters (
%
and_
). - limit
Get
Streams Limit - Limits the number of rows returned. If the
limit.from
is set, then the limit wll start from the first element matched by the expression. The expression is only used to match with the first element, later on the elements are not matched by the prefix, but you can enforce a certain pattern withstarts_with
orlike
. - starts_
with str - Filters the output with case-sensitive characters indicating the beginning of the object name.
- with_
describe bool - Runs DESC STREAM for each user returned by SHOW STREAMS. The output of describe is saved to the description field. By default this value is set to true.
- in Property Map
- IN clause to filter the list of objects
- like String
- Filters the output with case-insensitive pattern, with support for SQL wildcard characters (
%
and_
). - limit Property Map
- Limits the number of rows returned. If the
limit.from
is set, then the limit wll start from the first element matched by the expression. The expression is only used to match with the first element, later on the elements are not matched by the prefix, but you can enforce a certain pattern withstarts_with
orlike
. - starts
With String - Filters the output with case-sensitive characters indicating the beginning of the object name.
- with
Describe Boolean - Runs DESC STREAM for each user returned by SHOW STREAMS. The output of describe is saved to the description field. By default this value is set to true.
getStreams Result
The following output properties are available:
- Id string
- The provider-assigned unique ID for this managed resource.
- Streams
List<Get
Streams Stream> - Holds the aggregated output of all streams details queries.
- In
Get
Streams In - IN clause to filter the list of objects
- Like string
- Filters the output with case-insensitive pattern, with support for SQL wildcard characters (
%
and_
). - Limit
Get
Streams Limit - Limits the number of rows returned. If the
limit.from
is set, then the limit wll start from the first element matched by the expression. The expression is only used to match with the first element, later on the elements are not matched by the prefix, but you can enforce a certain pattern withstarts_with
orlike
. - Starts
With string - Filters the output with case-sensitive characters indicating the beginning of the object name.
- With
Describe bool - Runs DESC STREAM for each user returned by SHOW STREAMS. The output of describe is saved to the description field. By default this value is set to true.
- Id string
- The provider-assigned unique ID for this managed resource.
- Streams
[]Get
Streams Stream - Holds the aggregated output of all streams details queries.
- In
Get
Streams In - IN clause to filter the list of objects
- Like string
- Filters the output with case-insensitive pattern, with support for SQL wildcard characters (
%
and_
). - Limit
Get
Streams Limit - Limits the number of rows returned. If the
limit.from
is set, then the limit wll start from the first element matched by the expression. The expression is only used to match with the first element, later on the elements are not matched by the prefix, but you can enforce a certain pattern withstarts_with
orlike
. - Starts
With string - Filters the output with case-sensitive characters indicating the beginning of the object name.
- With
Describe bool - Runs DESC STREAM for each user returned by SHOW STREAMS. The output of describe is saved to the description field. By default this value is set to true.
- id String
- The provider-assigned unique ID for this managed resource.
- streams
List<Get
Streams Stream> - Holds the aggregated output of all streams details queries.
- in
Get
Streams In - IN clause to filter the list of objects
- like String
- Filters the output with case-insensitive pattern, with support for SQL wildcard characters (
%
and_
). - limit
Get
Streams Limit - Limits the number of rows returned. If the
limit.from
is set, then the limit wll start from the first element matched by the expression. The expression is only used to match with the first element, later on the elements are not matched by the prefix, but you can enforce a certain pattern withstarts_with
orlike
. - starts
With String - Filters the output with case-sensitive characters indicating the beginning of the object name.
- with
Describe Boolean - Runs DESC STREAM for each user returned by SHOW STREAMS. The output of describe is saved to the description field. By default this value is set to true.
- id string
- The provider-assigned unique ID for this managed resource.
- streams
Get
Streams Stream[] - Holds the aggregated output of all streams details queries.
- in
Get
Streams In - IN clause to filter the list of objects
- like string
- Filters the output with case-insensitive pattern, with support for SQL wildcard characters (
%
and_
). - limit
Get
Streams Limit - Limits the number of rows returned. If the
limit.from
is set, then the limit wll start from the first element matched by the expression. The expression is only used to match with the first element, later on the elements are not matched by the prefix, but you can enforce a certain pattern withstarts_with
orlike
. - starts
With string - Filters the output with case-sensitive characters indicating the beginning of the object name.
- with
Describe boolean - Runs DESC STREAM for each user returned by SHOW STREAMS. The output of describe is saved to the description field. By default this value is set to true.
- id str
- The provider-assigned unique ID for this managed resource.
- streams
Sequence[Get
Streams Stream] - Holds the aggregated output of all streams details queries.
- in_
Get
Streams In - IN clause to filter the list of objects
- like str
- Filters the output with case-insensitive pattern, with support for SQL wildcard characters (
%
and_
). - limit
Get
Streams Limit - Limits the number of rows returned. If the
limit.from
is set, then the limit wll start from the first element matched by the expression. The expression is only used to match with the first element, later on the elements are not matched by the prefix, but you can enforce a certain pattern withstarts_with
orlike
. - starts_
with str - Filters the output with case-sensitive characters indicating the beginning of the object name.
- with_
describe bool - Runs DESC STREAM for each user returned by SHOW STREAMS. The output of describe is saved to the description field. By default this value is set to true.
- id String
- The provider-assigned unique ID for this managed resource.
- streams List<Property Map>
- Holds the aggregated output of all streams details queries.
- in Property Map
- IN clause to filter the list of objects
- like String
- Filters the output with case-insensitive pattern, with support for SQL wildcard characters (
%
and_
). - limit Property Map
- Limits the number of rows returned. If the
limit.from
is set, then the limit wll start from the first element matched by the expression. The expression is only used to match with the first element, later on the elements are not matched by the prefix, but you can enforce a certain pattern withstarts_with
orlike
. - starts
With String - Filters the output with case-sensitive characters indicating the beginning of the object name.
- with
Describe Boolean - Runs DESC STREAM for each user returned by SHOW STREAMS. The output of describe is saved to the description field. By default this value is set to true.
Supporting Types
GetStreamsIn
- Account bool
- Returns records for the entire account.
- Application string
- Returns records for the specified application.
- Application
Package string - Returns records for the specified application package.
- Database string
- Returns records for the current database in use or for a specified database.
- Schema string
- Returns records for the current schema in use or a specified schema. Use fully qualified name.
- Account bool
- Returns records for the entire account.
- Application string
- Returns records for the specified application.
- Application
Package string - Returns records for the specified application package.
- Database string
- Returns records for the current database in use or for a specified database.
- Schema string
- Returns records for the current schema in use or a specified schema. Use fully qualified name.
- account Boolean
- Returns records for the entire account.
- application String
- Returns records for the specified application.
- application
Package String - Returns records for the specified application package.
- database String
- Returns records for the current database in use or for a specified database.
- schema String
- Returns records for the current schema in use or a specified schema. Use fully qualified name.
- account boolean
- Returns records for the entire account.
- application string
- Returns records for the specified application.
- application
Package string - Returns records for the specified application package.
- database string
- Returns records for the current database in use or for a specified database.
- schema string
- Returns records for the current schema in use or a specified schema. Use fully qualified name.
- account bool
- Returns records for the entire account.
- application str
- Returns records for the specified application.
- application_
package str - Returns records for the specified application package.
- database str
- Returns records for the current database in use or for a specified database.
- schema str
- Returns records for the current schema in use or a specified schema. Use fully qualified name.
- account Boolean
- Returns records for the entire account.
- application String
- Returns records for the specified application.
- application
Package String - Returns records for the specified application package.
- database String
- Returns records for the current database in use or for a specified database.
- schema String
- Returns records for the current schema in use or a specified schema. Use fully qualified name.
GetStreamsLimit
GetStreamsStream
- Describe
Outputs List<GetStreams Stream Describe Output> - Holds the output of DESCRIBE STREAM.
- Show
Outputs List<GetStreams Stream Show Output> - Holds the output of SHOW STREAMS.
- Describe
Outputs []GetStreams Stream Describe Output - Holds the output of DESCRIBE STREAM.
- Show
Outputs []GetStreams Stream Show Output - Holds the output of SHOW STREAMS.
- describe
Outputs List<GetStreams Stream Describe Output> - Holds the output of DESCRIBE STREAM.
- show
Outputs List<GetStreams Stream Show Output> - Holds the output of SHOW STREAMS.
- describe
Outputs GetStreams Stream Describe Output[] - Holds the output of DESCRIBE STREAM.
- show
Outputs GetStreams Stream Show Output[] - Holds the output of SHOW STREAMS.
- describe_
outputs Sequence[GetStreams Stream Describe Output] - Holds the output of DESCRIBE STREAM.
- show_
outputs Sequence[GetStreams Stream Show Output] - Holds the output of SHOW STREAMS.
- describe
Outputs List<Property Map> - Holds the output of DESCRIBE STREAM.
- show
Outputs List<Property Map> - Holds the output of SHOW STREAMS.
GetStreamsStreamDescribeOutput
- 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
GetStreamsStreamShowOutput
- 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.