snowflake.getStreamlits

Explore with Pulumi AI

Snowflake v0.59.0 published on Friday, Sep 20, 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 streamlits. Filtering is aligned with the current possibilities for SHOW STREAMLITS query (only like is supported). The results of SHOW and DESCRIBE are encapsulated in one output collection streamlits.

Using getStreamlits

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 getStreamlits(args: GetStreamlitsArgs, opts?: InvokeOptions): Promise<GetStreamlitsResult>
function getStreamlitsOutput(args: GetStreamlitsOutputArgs, opts?: InvokeOptions): Output<GetStreamlitsResult>

def get_streamlits(in_: Optional[GetStreamlitsIn] = None,
                   like: Optional[str] = None,
                   limit: Optional[GetStreamlitsLimit] = None,
                   with_describe: Optional[bool] = None,
                   opts: Optional[InvokeOptions] = None) -> GetStreamlitsResult
def get_streamlits_output(in_: Optional[pulumi.Input[GetStreamlitsInArgs]] = None,
                   like: Optional[pulumi.Input[str]] = None,
                   limit: Optional[pulumi.Input[GetStreamlitsLimitArgs]] = None,
                   with_describe: Optional[pulumi.Input[bool]] = None,
                   opts: Optional[InvokeOptions] = None) -> Output[GetStreamlitsResult]

func GetStreamlits(ctx *Context, args *GetStreamlitsArgs, opts ...InvokeOption) (*GetStreamlitsResult, error)
func GetStreamlitsOutput(ctx *Context, args *GetStreamlitsOutputArgs, opts ...InvokeOption) GetStreamlitsResultOutput

> Note: This function is named GetStreamlits in the Go SDK.

public static class GetStreamlits 
{
    public static Task<GetStreamlitsResult> InvokeAsync(GetStreamlitsArgs args, InvokeOptions? opts = null)
    public static Output<GetStreamlitsResult> Invoke(GetStreamlitsInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetStreamlitsResult> getStreamlits(GetStreamlitsArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

fn::invoke:
  function: snowflake:index/getStreamlits:getStreamlits
  arguments:
    # arguments dictionary

The following arguments are supported:

In GetStreamlitsIn: IN clause to filter the list of streamlits
Like string: Filters the output with case-insensitive pattern, with support for SQL wildcard characters (% and _).
Limit GetStreamlitsLimit: 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.
WithDescribe bool: Runs DESC STREAMLIT for each streamlit returned by SHOW STREAMLITS. The output of describe is saved to the description field. By default this value is set to true.

In GetStreamlitsIn: IN clause to filter the list of streamlits
Like string: Filters the output with case-insensitive pattern, with support for SQL wildcard characters (% and _).
Limit GetStreamlitsLimit: 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.
WithDescribe bool: Runs DESC STREAMLIT for each streamlit returned by SHOW STREAMLITS. The output of describe is saved to the description field. By default this value is set to true.

in GetStreamlitsIn: IN clause to filter the list of streamlits
like String: Filters the output with case-insensitive pattern, with support for SQL wildcard characters (% and _).
limit GetStreamlitsLimit: 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.
withDescribe Boolean: Runs DESC STREAMLIT for each streamlit returned by SHOW STREAMLITS. The output of describe is saved to the description field. By default this value is set to true.

in GetStreamlitsIn: IN clause to filter the list of streamlits
like string: Filters the output with case-insensitive pattern, with support for SQL wildcard characters (% and _).
limit GetStreamlitsLimit: 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.
withDescribe boolean: Runs DESC STREAMLIT for each streamlit returned by SHOW STREAMLITS. The output of describe is saved to the description field. By default this value is set to true.

in_ GetStreamlitsIn: IN clause to filter the list of streamlits
like str: Filters the output with case-insensitive pattern, with support for SQL wildcard characters (% and _).
limit GetStreamlitsLimit: 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.
with_describe bool: Runs DESC STREAMLIT for each streamlit returned by SHOW STREAMLITS. 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 streamlits
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.
withDescribe Boolean: Runs DESC STREAMLIT for each streamlit returned by SHOW STREAMLITS. The output of describe is saved to the description field. By default this value is set to true.

getStreamlits Result

The following output properties are available:

Id string: The provider-assigned unique ID for this managed resource.
Streamlits List<GetStreamlitsStreamlit>: Holds the aggregated output of all streamlits details queries.
In GetStreamlitsIn: IN clause to filter the list of streamlits
Like string: Filters the output with case-insensitive pattern, with support for SQL wildcard characters (% and _).
Limit GetStreamlitsLimit: 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.
WithDescribe bool: Runs DESC STREAMLIT for each streamlit returned by SHOW STREAMLITS. 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.
Streamlits []GetStreamlitsStreamlit: Holds the aggregated output of all streamlits details queries.
In GetStreamlitsIn: IN clause to filter the list of streamlits
Like string: Filters the output with case-insensitive pattern, with support for SQL wildcard characters (% and _).
Limit GetStreamlitsLimit: 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.
WithDescribe bool: Runs DESC STREAMLIT for each streamlit returned by SHOW STREAMLITS. 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.
streamlits List<GetStreamlitsStreamlit>: Holds the aggregated output of all streamlits details queries.
in GetStreamlitsIn: IN clause to filter the list of streamlits
like String: Filters the output with case-insensitive pattern, with support for SQL wildcard characters (% and _).
limit GetStreamlitsLimit: 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.
withDescribe Boolean: Runs DESC STREAMLIT for each streamlit returned by SHOW STREAMLITS. 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.
streamlits GetStreamlitsStreamlit[]: Holds the aggregated output of all streamlits details queries.
in GetStreamlitsIn: IN clause to filter the list of streamlits
like string: Filters the output with case-insensitive pattern, with support for SQL wildcard characters (% and _).
limit GetStreamlitsLimit: 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.
withDescribe boolean: Runs DESC STREAMLIT for each streamlit returned by SHOW STREAMLITS. 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.
streamlits Sequence[GetStreamlitsStreamlit]: Holds the aggregated output of all streamlits details queries.
in_ GetStreamlitsIn: IN clause to filter the list of streamlits
like str: Filters the output with case-insensitive pattern, with support for SQL wildcard characters (% and _).
limit GetStreamlitsLimit: 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.
with_describe bool: Runs DESC STREAMLIT for each streamlit returned by SHOW STREAMLITS. 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.
streamlits List<Property Map>: Holds the aggregated output of all streamlits details queries.
in Property Map: IN clause to filter the list of streamlits
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.
withDescribe Boolean: Runs DESC STREAMLIT for each streamlit returned by SHOW STREAMLITS. The output of describe is saved to the description field. By default this value is set to true.

Supporting Types

GetStreamlitsIn

Account bool: Returns records for the entire account.
Database string: Returns records for the current database in use or for a specified database (db_name).
Schema string: Returns records for the current schema in use or a specified schema (schema_name).

Account bool: Returns records for the entire account.
Database string: Returns records for the current database in use or for a specified database (db_name).
Schema string: Returns records for the current schema in use or a specified schema (schema_name).

account Boolean: Returns records for the entire account.
database String: Returns records for the current database in use or for a specified database (db_name).
schema String: Returns records for the current schema in use or a specified schema (schema_name).

account boolean: Returns records for the entire account.
database string: Returns records for the current database in use or for a specified database (db_name).
schema string: Returns records for the current schema in use or a specified schema (schema_name).

account bool: Returns records for the entire account.
database str: Returns records for the current database in use or for a specified database (db_name).
schema str: Returns records for the current schema in use or a specified schema (schema_name).

account Boolean: Returns records for the entire account.
database String: Returns records for the current database in use or for a specified database (db_name).
schema String: Returns records for the current schema in use or a specified schema (schema_name).

GetStreamlitsLimit

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.