snowflake.getTables

Explore with Pulumi AI

Snowflake v2.1.0 published on Thursday, Jun 26, 2025 by Pulumi

!> Caution: Preview Feature This feature is considered a preview feature in the provider, regardless of the state of the resource in Snowflake. We do not guarantee its stability. It will be reworked and marked as a stable feature in future releases. Breaking changes are expected, even without bumping the major version. To use this feature, add the relevant feature name to preview_features_enabled field in the provider configuration. Please always refer to the Getting Help section in our Github repo to best determine how to get help for your questions.

Datasource used to get details of filtered tables. Filtering is aligned with the current possibilities for SHOW TABLES query. The results of SHOW and DESCRIBE (COLUMNS) are encapsulated in one output collection tables.

Example Usage

Example coming soon!

Example coming soon!

Example coming soon!

Example coming soon!

Example coming soon!

variables:
  current:
    fn::invoke:
      function: snowflake:getTables
      arguments:
        database: MYDB
        schema: MYSCHEMA

Note If a field has a default value, it is shown next to the type in the schema.

Using getTables

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 getTables(args: GetTablesArgs, opts?: InvokeOptions): Promise<GetTablesResult>
function getTablesOutput(args: GetTablesOutputArgs, opts?: InvokeOptions): Output<GetTablesResult>

def get_tables(in_: Optional[GetTablesIn] = None,
               like: Optional[str] = None,
               limit: Optional[GetTablesLimit] = None,
               starts_with: Optional[str] = None,
               with_describe: Optional[bool] = None,
               opts: Optional[InvokeOptions] = None) -> GetTablesResult
def get_tables_output(in_: Optional[pulumi.Input[GetTablesInArgs]] = None,
               like: Optional[pulumi.Input[str]] = None,
               limit: Optional[pulumi.Input[GetTablesLimitArgs]] = None,
               starts_with: Optional[pulumi.Input[str]] = None,
               with_describe: Optional[pulumi.Input[bool]] = None,
               opts: Optional[InvokeOptions] = None) -> Output[GetTablesResult]

func GetTables(ctx *Context, args *GetTablesArgs, opts ...InvokeOption) (*GetTablesResult, error)
func GetTablesOutput(ctx *Context, args *GetTablesOutputArgs, opts ...InvokeOption) GetTablesResultOutput

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

public static class GetTables 
{
    public static Task<GetTablesResult> InvokeAsync(GetTablesArgs args, InvokeOptions? opts = null)
    public static Output<GetTablesResult> Invoke(GetTablesInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetTablesResult> getTables(GetTablesArgs args, InvokeOptions options)
public static Output<GetTablesResult> getTables(GetTablesArgs args, InvokeOptions options)

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

The following arguments are supported:

In GetTablesIn: 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 GetTablesLimit: Limits the number of rows returned. If the limit.from is set, then the limit will 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: (Default: true) Runs DESC TABLE for each table returned by SHOW TABLES. The output of describe is saved to the description field. By default this value is set to true.

In GetTablesIn: 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 GetTablesLimit: Limits the number of rows returned. If the limit.from is set, then the limit will 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: (Default: true) Runs DESC TABLE for each table returned by SHOW TABLES. The output of describe is saved to the description field. By default this value is set to true.

in GetTablesIn: 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 GetTablesLimit: Limits the number of rows returned. If the limit.from is set, then the limit will 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: (Default: true) Runs DESC TABLE for each table returned by SHOW TABLES. The output of describe is saved to the description field. By default this value is set to true.

in GetTablesIn: 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 GetTablesLimit: Limits the number of rows returned. If the limit.from is set, then the limit will 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: (Default: true) Runs DESC TABLE for each table returned by SHOW TABLES. The output of describe is saved to the description field. By default this value is set to true.

in_ GetTablesIn: 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 GetTablesLimit: Limits the number of rows returned. If the limit.from is set, then the limit will 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: (Default: true) Runs DESC TABLE for each table returned by SHOW TABLES. 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 will 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: (Default: true) Runs DESC TABLE for each table returned by SHOW TABLES. The output of describe is saved to the description field. By default this value is set to true.

getTables Result

The following output properties are available:

Id string: The provider-assigned unique ID for this managed resource.
Tables List<GetTablesTable>: Holds the aggregated output of all tables details queries.
In GetTablesIn: 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 GetTablesLimit: Limits the number of rows returned. If the limit.from is set, then the limit will 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: (Default: true) Runs DESC TABLE for each table returned by SHOW TABLES. 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.
Tables []GetTablesTable: Holds the aggregated output of all tables details queries.
In GetTablesIn: 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 GetTablesLimit: Limits the number of rows returned. If the limit.from is set, then the limit will 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: (Default: true) Runs DESC TABLE for each table returned by SHOW TABLES. 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.
tables List<GetTablesTable>: Holds the aggregated output of all tables details queries.
in GetTablesIn: 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 GetTablesLimit: Limits the number of rows returned. If the limit.from is set, then the limit will 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: (Default: true) Runs DESC TABLE for each table returned by SHOW TABLES. 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.
tables GetTablesTable[]: Holds the aggregated output of all tables details queries.
in GetTablesIn: 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 GetTablesLimit: Limits the number of rows returned. If the limit.from is set, then the limit will 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: (Default: true) Runs DESC TABLE for each table returned by SHOW TABLES. 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.
tables Sequence[GetTablesTable]: Holds the aggregated output of all tables details queries.
in_ GetTablesIn: 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 GetTablesLimit: Limits the number of rows returned. If the limit.from is set, then the limit will 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: (Default: true) Runs DESC TABLE for each table returned by SHOW TABLES. 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.
tables List<Property Map>: Holds the aggregated output of all tables 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 will 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: (Default: true) Runs DESC TABLE for each table returned by SHOW TABLES. The output of describe is saved to the description field. By default this value is set to true.

Supporting Types

GetTablesIn

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.

GetTablesLimit

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.