snowflake.getSchemas

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 schemas. Filtering is aligned with the current possibilities for SHOW SCHEMAS query. The results of SHOW, DESCRIBE, and SHOW PARAMETERS IN are encapsulated in one output collection.

Using getSchemas

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 getSchemas(args: GetSchemasArgs, opts?: InvokeOptions): Promise<GetSchemasResult>
function getSchemasOutput(args: GetSchemasOutputArgs, opts?: InvokeOptions): Output<GetSchemasResult>

def get_schemas(in_: Optional[GetSchemasIn] = None,
                like: Optional[str] = None,
                limit: Optional[GetSchemasLimit] = None,
                starts_with: Optional[str] = None,
                with_describe: Optional[bool] = None,
                with_parameters: Optional[bool] = None,
                opts: Optional[InvokeOptions] = None) -> GetSchemasResult
def get_schemas_output(in_: Optional[pulumi.Input[GetSchemasInArgs]] = None,
                like: Optional[pulumi.Input[str]] = None,
                limit: Optional[pulumi.Input[GetSchemasLimitArgs]] = None,
                starts_with: Optional[pulumi.Input[str]] = None,
                with_describe: Optional[pulumi.Input[bool]] = None,
                with_parameters: Optional[pulumi.Input[bool]] = None,
                opts: Optional[InvokeOptions] = None) -> Output[GetSchemasResult]

func GetSchemas(ctx *Context, args *GetSchemasArgs, opts ...InvokeOption) (*GetSchemasResult, error)
func GetSchemasOutput(ctx *Context, args *GetSchemasOutputArgs, opts ...InvokeOption) GetSchemasResultOutput

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

public static class GetSchemas 
{
    public static Task<GetSchemasResult> InvokeAsync(GetSchemasArgs args, InvokeOptions? opts = null)
    public static Output<GetSchemasResult> Invoke(GetSchemasInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetSchemasResult> getSchemas(GetSchemasArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

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

The following arguments are supported:

In GetSchemasIn: 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 GetSchemasLimit: 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 SCHEMA for each schema returned by SHOW SCHEMAS. The output of describe is saved to the description field. By default this value is set to true.
WithParameters bool: Runs SHOW PARAMETERS FOR SCHEMA for each schema returned by SHOW SCHEMAS. The output of describe is saved to the parameters field as a map. By default this value is set to true.

In GetSchemasIn: 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 GetSchemasLimit: 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 SCHEMA for each schema returned by SHOW SCHEMAS. The output of describe is saved to the description field. By default this value is set to true.
WithParameters bool: Runs SHOW PARAMETERS FOR SCHEMA for each schema returned by SHOW SCHEMAS. The output of describe is saved to the parameters field as a map. By default this value is set to true.

in GetSchemasIn: 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 GetSchemasLimit: 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 SCHEMA for each schema returned by SHOW SCHEMAS. The output of describe is saved to the description field. By default this value is set to true.
withParameters Boolean: Runs SHOW PARAMETERS FOR SCHEMA for each schema returned by SHOW SCHEMAS. The output of describe is saved to the parameters field as a map. By default this value is set to true.

in GetSchemasIn: 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 GetSchemasLimit: 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 SCHEMA for each schema returned by SHOW SCHEMAS. The output of describe is saved to the description field. By default this value is set to true.
withParameters boolean: Runs SHOW PARAMETERS FOR SCHEMA for each schema returned by SHOW SCHEMAS. The output of describe is saved to the parameters field as a map. By default this value is set to true.

in_ GetSchemasIn: 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 GetSchemasLimit: 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 SCHEMA for each schema returned by SHOW SCHEMAS. The output of describe is saved to the description field. By default this value is set to true.
with_parameters bool: Runs SHOW PARAMETERS FOR SCHEMA for each schema returned by SHOW SCHEMAS. The output of describe is saved to the parameters field as a map. 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.
startsWith String: Filters the output with case-sensitive characters indicating the beginning of the object name.
withDescribe Boolean: Runs DESC SCHEMA for each schema returned by SHOW SCHEMAS. The output of describe is saved to the description field. By default this value is set to true.
withParameters Boolean: Runs SHOW PARAMETERS FOR SCHEMA for each schema returned by SHOW SCHEMAS. The output of describe is saved to the parameters field as a map. By default this value is set to true.

getSchemas Result

The following output properties are available:

Id string: The provider-assigned unique ID for this managed resource.
Schemas List<GetSchemasSchema>: Holds the aggregated output of all SCHEMA details queries.
In GetSchemasIn: 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 GetSchemasLimit: 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 SCHEMA for each schema returned by SHOW SCHEMAS. The output of describe is saved to the description field. By default this value is set to true.
WithParameters bool: Runs SHOW PARAMETERS FOR SCHEMA for each schema returned by SHOW SCHEMAS. The output of describe is saved to the parameters field as a map. By default this value is set to true.

Id string: The provider-assigned unique ID for this managed resource.
Schemas []GetSchemasSchema: Holds the aggregated output of all SCHEMA details queries.
In GetSchemasIn: 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 GetSchemasLimit: 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 SCHEMA for each schema returned by SHOW SCHEMAS. The output of describe is saved to the description field. By default this value is set to true.
WithParameters bool: Runs SHOW PARAMETERS FOR SCHEMA for each schema returned by SHOW SCHEMAS. The output of describe is saved to the parameters field as a map. By default this value is set to true.

id String: The provider-assigned unique ID for this managed resource.
schemas List<GetSchemasSchema>: Holds the aggregated output of all SCHEMA details queries.
in GetSchemasIn: 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 GetSchemasLimit: 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 SCHEMA for each schema returned by SHOW SCHEMAS. The output of describe is saved to the description field. By default this value is set to true.
withParameters Boolean: Runs SHOW PARAMETERS FOR SCHEMA for each schema returned by SHOW SCHEMAS. The output of describe is saved to the parameters field as a map. By default this value is set to true.

id string: The provider-assigned unique ID for this managed resource.
schemas GetSchemasSchema[]: Holds the aggregated output of all SCHEMA details queries.
in GetSchemasIn: 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 GetSchemasLimit: 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 SCHEMA for each schema returned by SHOW SCHEMAS. The output of describe is saved to the description field. By default this value is set to true.
withParameters boolean: Runs SHOW PARAMETERS FOR SCHEMA for each schema returned by SHOW SCHEMAS. The output of describe is saved to the parameters field as a map. By default this value is set to true.

id str: The provider-assigned unique ID for this managed resource.
schemas Sequence[GetSchemasSchema]: Holds the aggregated output of all SCHEMA details queries.
in_ GetSchemasIn: 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 GetSchemasLimit: 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 SCHEMA for each schema returned by SHOW SCHEMAS. The output of describe is saved to the description field. By default this value is set to true.
with_parameters bool: Runs SHOW PARAMETERS FOR SCHEMA for each schema returned by SHOW SCHEMAS. The output of describe is saved to the parameters field as a map. By default this value is set to true.

id String: The provider-assigned unique ID for this managed resource.
schemas List<Property Map>: Holds the aggregated output of all SCHEMA 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.
startsWith String: Filters the output with case-sensitive characters indicating the beginning of the object name.
withDescribe Boolean: Runs DESC SCHEMA for each schema returned by SHOW SCHEMAS. The output of describe is saved to the description field. By default this value is set to true.
withParameters Boolean: Runs SHOW PARAMETERS FOR SCHEMA for each schema returned by SHOW SCHEMAS. The output of describe is saved to the parameters field as a map. By default this value is set to true.

Supporting Types

GetSchemasIn

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 (db_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 (db_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 (db_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 (db_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 (db_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 (db_name).

GetSchemasLimit

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.