1. Packages
  2. Snowflake Provider
  3. API Docs
  4. getStreams
Snowflake v0.61.1 published on Thursday, Nov 14, 2024 by Pulumi

snowflake.getStreams

Explore with Pulumi AI

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

    !> 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 GetStreamsIn
    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 GetStreamsLimit
    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 with starts_with or like.
    StartsWith string
    Filters the output with case-sensitive characters indicating the beginning of the object name.
    WithDescribe 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 GetStreamsIn
    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 GetStreamsLimit
    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 with starts_with or like.
    StartsWith string
    Filters the output with case-sensitive characters indicating the beginning of the object name.
    WithDescribe 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 GetStreamsIn
    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 GetStreamsLimit
    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 with starts_with or like.
    startsWith String
    Filters the output with case-sensitive characters indicating the beginning of the object name.
    withDescribe 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 GetStreamsIn
    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 GetStreamsLimit
    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 with starts_with or like.
    startsWith string
    Filters the output with case-sensitive characters indicating the beginning of the object name.
    withDescribe 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_ GetStreamsIn
    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 GetStreamsLimit
    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 with starts_with or like.
    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 with starts_with or like.
    startsWith String
    Filters the output with case-sensitive characters indicating the beginning of the object name.
    withDescribe 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<GetStreamsStream>
    Holds the aggregated output of all streams details queries.
    In GetStreamsIn
    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 GetStreamsLimit
    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 with starts_with or like.
    StartsWith string
    Filters the output with case-sensitive characters indicating the beginning of the object name.
    WithDescribe 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 []GetStreamsStream
    Holds the aggregated output of all streams details queries.
    In GetStreamsIn
    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 GetStreamsLimit
    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 with starts_with or like.
    StartsWith string
    Filters the output with case-sensitive characters indicating the beginning of the object name.
    WithDescribe 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<GetStreamsStream>
    Holds the aggregated output of all streams details queries.
    in GetStreamsIn
    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 GetStreamsLimit
    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 with starts_with or like.
    startsWith String
    Filters the output with case-sensitive characters indicating the beginning of the object name.
    withDescribe 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 GetStreamsStream[]
    Holds the aggregated output of all streams details queries.
    in GetStreamsIn
    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 GetStreamsLimit
    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 with starts_with or like.
    startsWith string
    Filters the output with case-sensitive characters indicating the beginning of the object name.
    withDescribe 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[GetStreamsStream]
    Holds the aggregated output of all streams details queries.
    in_ GetStreamsIn
    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 GetStreamsLimit
    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 with starts_with or like.
    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 with starts_with or like.
    startsWith String
    Filters the output with case-sensitive characters indicating the beginning of the object name.
    withDescribe 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.
    ApplicationPackage 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.
    ApplicationPackage 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.
    applicationPackage 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.
    applicationPackage 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.
    applicationPackage 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

    Rows int
    The maximum number of rows to return.
    From string
    Specifies a case-sensitive pattern that is used to match object name. After the first match, the limit on the number of rows will be applied.
    Rows int
    The maximum number of rows to return.
    From string
    Specifies a case-sensitive pattern that is used to match object name. After the first match, the limit on the number of rows will be applied.
    rows Integer
    The maximum number of rows to return.
    from String
    Specifies a case-sensitive pattern that is used to match object name. After the first match, the limit on the number of rows will be applied.
    rows number
    The maximum number of rows to return.
    from string
    Specifies a case-sensitive pattern that is used to match object name. After the first match, the limit on the number of rows will be applied.
    rows int
    The maximum number of rows to return.
    from_ str
    Specifies a case-sensitive pattern that is used to match object name. After the first match, the limit on the number of rows will be applied.
    rows Number
    The maximum number of rows to return.
    from String
    Specifies a case-sensitive pattern that is used to match object name. After the first match, the limit on the number of rows will be applied.

    GetStreamsStream

    DescribeOutputs List<GetStreamsStreamDescribeOutput>
    Holds the output of DESCRIBE STREAM.
    ShowOutputs List<GetStreamsStreamShowOutput>
    Holds the output of SHOW STREAMS.
    DescribeOutputs []GetStreamsStreamDescribeOutput
    Holds the output of DESCRIBE STREAM.
    ShowOutputs []GetStreamsStreamShowOutput
    Holds the output of SHOW STREAMS.
    describeOutputs List<GetStreamsStreamDescribeOutput>
    Holds the output of DESCRIBE STREAM.
    showOutputs List<GetStreamsStreamShowOutput>
    Holds the output of SHOW STREAMS.
    describeOutputs GetStreamsStreamDescribeOutput[]
    Holds the output of DESCRIBE STREAM.
    showOutputs GetStreamsStreamShowOutput[]
    Holds the output of SHOW STREAMS.
    describe_outputs Sequence[GetStreamsStreamDescribeOutput]
    Holds the output of DESCRIBE STREAM.
    show_outputs Sequence[GetStreamsStreamShowOutput]
    Holds the output of SHOW STREAMS.
    describeOutputs List<Property Map>
    Holds the output of DESCRIBE STREAM.
    showOutputs List<Property Map>
    Holds the output of SHOW STREAMS.

    GetStreamsStreamDescribeOutput

    BaseTables List<string>
    Comment string
    CreatedOn string
    DatabaseName string
    InvalidReason string
    Mode string
    Name string
    Owner string
    OwnerRoleType string
    SchemaName string
    SourceType string
    Stale bool
    StaleAfter string
    TableName string
    Type string
    BaseTables []string
    Comment string
    CreatedOn string
    DatabaseName string
    InvalidReason string
    Mode string
    Name string
    Owner string
    OwnerRoleType string
    SchemaName string
    SourceType string
    Stale bool
    StaleAfter string
    TableName string
    Type string
    baseTables List<String>
    comment String
    createdOn String
    databaseName String
    invalidReason String
    mode String
    name String
    owner String
    ownerRoleType String
    schemaName String
    sourceType String
    stale Boolean
    staleAfter String
    tableName String
    type String
    baseTables string[]
    comment string
    createdOn string
    databaseName string
    invalidReason string
    mode string
    name string
    owner string
    ownerRoleType string
    schemaName string
    sourceType string
    stale boolean
    staleAfter string
    tableName string
    type string
    baseTables List<String>
    comment String
    createdOn String
    databaseName String
    invalidReason String
    mode String
    name String
    owner String
    ownerRoleType String
    schemaName String
    sourceType String
    stale Boolean
    staleAfter String
    tableName String
    type String

    GetStreamsStreamShowOutput

    BaseTables List<string>
    Comment string
    CreatedOn string
    DatabaseName string
    InvalidReason string
    Mode string
    Name string
    Owner string
    OwnerRoleType string
    SchemaName string
    SourceType string
    Stale bool
    StaleAfter string
    TableName string
    Type string
    BaseTables []string
    Comment string
    CreatedOn string
    DatabaseName string
    InvalidReason string
    Mode string
    Name string
    Owner string
    OwnerRoleType string
    SchemaName string
    SourceType string
    Stale bool
    StaleAfter string
    TableName string
    Type string
    baseTables List<String>
    comment String
    createdOn String
    databaseName String
    invalidReason String
    mode String
    name String
    owner String
    ownerRoleType String
    schemaName String
    sourceType String
    stale Boolean
    staleAfter String
    tableName String
    type String
    baseTables string[]
    comment string
    createdOn string
    databaseName string
    invalidReason string
    mode string
    name string
    owner string
    ownerRoleType string
    schemaName string
    sourceType string
    stale boolean
    staleAfter string
    tableName string
    type string
    baseTables List<String>
    comment String
    createdOn String
    databaseName String
    invalidReason String
    mode String
    name String
    owner String
    ownerRoleType String
    schemaName String
    sourceType String
    stale Boolean
    staleAfter String
    tableName 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.
    snowflake logo
    Snowflake v0.61.1 published on Thursday, Nov 14, 2024 by Pulumi