Snowflake v0.59.0, Sep 20 24

Snowflake v0.59.0 published on Friday, Sep 20, 2024 by Pulumi

snowflake.getDynamicTables

Explore with Pulumi AI

Snowflake v0.59.0 published on Friday, Sep 20, 2024 by Pulumi

Using getDynamicTables

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 getDynamicTables(args: GetDynamicTablesArgs, opts?: InvokeOptions): Promise<GetDynamicTablesResult>
function getDynamicTablesOutput(args: GetDynamicTablesOutputArgs, opts?: InvokeOptions): Output<GetDynamicTablesResult>

def get_dynamic_tables(in_: Optional[GetDynamicTablesIn] = None,
                       like: Optional[GetDynamicTablesLike] = None,
                       limit: Optional[GetDynamicTablesLimit] = None,
                       starts_with: Optional[str] = None,
                       opts: Optional[InvokeOptions] = None) -> GetDynamicTablesResult
def get_dynamic_tables_output(in_: Optional[pulumi.Input[GetDynamicTablesInArgs]] = None,
                       like: Optional[pulumi.Input[GetDynamicTablesLikeArgs]] = None,
                       limit: Optional[pulumi.Input[GetDynamicTablesLimitArgs]] = None,
                       starts_with: Optional[pulumi.Input[str]] = None,
                       opts: Optional[InvokeOptions] = None) -> Output[GetDynamicTablesResult]

func GetDynamicTables(ctx *Context, args *GetDynamicTablesArgs, opts ...InvokeOption) (*GetDynamicTablesResult, error)
func GetDynamicTablesOutput(ctx *Context, args *GetDynamicTablesOutputArgs, opts ...InvokeOption) GetDynamicTablesResultOutput

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

public static class GetDynamicTables 
{
    public static Task<GetDynamicTablesResult> InvokeAsync(GetDynamicTablesArgs args, InvokeOptions? opts = null)
    public static Output<GetDynamicTablesResult> Invoke(GetDynamicTablesInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetDynamicTablesResult> getDynamicTables(GetDynamicTablesArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

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

The following arguments are supported:

In GetDynamicTablesIn: IN clause to filter the list of dynamic tables.
Like GetDynamicTablesLike: LIKE clause to filter the list of dynamic tables.
Limit GetDynamicTablesLimit: Optionally limits the maximum number of rows returned, while also enabling “pagination” of the results. Note that the actual number of rows returned might be less than the specified limit (e.g. the number of existing objects is less than the specified limit).
StartsWith string: Optionally filters the command output based on the characters that appear at the beginning of the object name. The string is case-sensitive.

In GetDynamicTablesIn: IN clause to filter the list of dynamic tables.
Like GetDynamicTablesLike: LIKE clause to filter the list of dynamic tables.
Limit GetDynamicTablesLimit: Optionally limits the maximum number of rows returned, while also enabling “pagination” of the results. Note that the actual number of rows returned might be less than the specified limit (e.g. the number of existing objects is less than the specified limit).
StartsWith string: Optionally filters the command output based on the characters that appear at the beginning of the object name. The string is case-sensitive.

in GetDynamicTablesIn: IN clause to filter the list of dynamic tables.
like GetDynamicTablesLike: LIKE clause to filter the list of dynamic tables.
limit GetDynamicTablesLimit: Optionally limits the maximum number of rows returned, while also enabling “pagination” of the results. Note that the actual number of rows returned might be less than the specified limit (e.g. the number of existing objects is less than the specified limit).
startsWith String: Optionally filters the command output based on the characters that appear at the beginning of the object name. The string is case-sensitive.

in GetDynamicTablesIn: IN clause to filter the list of dynamic tables.
like GetDynamicTablesLike: LIKE clause to filter the list of dynamic tables.
limit GetDynamicTablesLimit: Optionally limits the maximum number of rows returned, while also enabling “pagination” of the results. Note that the actual number of rows returned might be less than the specified limit (e.g. the number of existing objects is less than the specified limit).
startsWith string: Optionally filters the command output based on the characters that appear at the beginning of the object name. The string is case-sensitive.

in_ GetDynamicTablesIn: IN clause to filter the list of dynamic tables.
like GetDynamicTablesLike: LIKE clause to filter the list of dynamic tables.
limit GetDynamicTablesLimit: Optionally limits the maximum number of rows returned, while also enabling “pagination” of the results. Note that the actual number of rows returned might be less than the specified limit (e.g. the number of existing objects is less than the specified limit).
starts_with str: Optionally filters the command output based on the characters that appear at the beginning of the object name. The string is case-sensitive.

in Property Map: IN clause to filter the list of dynamic tables.
like Property Map: LIKE clause to filter the list of dynamic tables.
limit Property Map: Optionally limits the maximum number of rows returned, while also enabling “pagination” of the results. Note that the actual number of rows returned might be less than the specified limit (e.g. the number of existing objects is less than the specified limit).
startsWith String: Optionally filters the command output based on the characters that appear at the beginning of the object name. The string is case-sensitive.

getDynamicTables Result

The following output properties are available:

Id string: The provider-assigned unique ID for this managed resource.
Records List<GetDynamicTablesRecord>: The list of dynamic tables.
In GetDynamicTablesIn: IN clause to filter the list of dynamic tables.
Like GetDynamicTablesLike: LIKE clause to filter the list of dynamic tables.
Limit GetDynamicTablesLimit: Optionally limits the maximum number of rows returned, while also enabling “pagination” of the results. Note that the actual number of rows returned might be less than the specified limit (e.g. the number of existing objects is less than the specified limit).
StartsWith string: Optionally filters the command output based on the characters that appear at the beginning of the object name. The string is case-sensitive.

Id string: The provider-assigned unique ID for this managed resource.
Records []GetDynamicTablesRecord: The list of dynamic tables.
In GetDynamicTablesIn: IN clause to filter the list of dynamic tables.
Like GetDynamicTablesLike: LIKE clause to filter the list of dynamic tables.
Limit GetDynamicTablesLimit: Optionally limits the maximum number of rows returned, while also enabling “pagination” of the results. Note that the actual number of rows returned might be less than the specified limit (e.g. the number of existing objects is less than the specified limit).
StartsWith string: Optionally filters the command output based on the characters that appear at the beginning of the object name. The string is case-sensitive.

id String: The provider-assigned unique ID for this managed resource.
records List<GetDynamicTablesRecord>: The list of dynamic tables.
in GetDynamicTablesIn: IN clause to filter the list of dynamic tables.
like GetDynamicTablesLike: LIKE clause to filter the list of dynamic tables.
limit GetDynamicTablesLimit: Optionally limits the maximum number of rows returned, while also enabling “pagination” of the results. Note that the actual number of rows returned might be less than the specified limit (e.g. the number of existing objects is less than the specified limit).
startsWith String: Optionally filters the command output based on the characters that appear at the beginning of the object name. The string is case-sensitive.

id string: The provider-assigned unique ID for this managed resource.
records GetDynamicTablesRecord[]: The list of dynamic tables.
in GetDynamicTablesIn: IN clause to filter the list of dynamic tables.
like GetDynamicTablesLike: LIKE clause to filter the list of dynamic tables.
limit GetDynamicTablesLimit: Optionally limits the maximum number of rows returned, while also enabling “pagination” of the results. Note that the actual number of rows returned might be less than the specified limit (e.g. the number of existing objects is less than the specified limit).
startsWith string: Optionally filters the command output based on the characters that appear at the beginning of the object name. The string is case-sensitive.

id str: The provider-assigned unique ID for this managed resource.
records Sequence[GetDynamicTablesRecord]: The list of dynamic tables.
in_ GetDynamicTablesIn: IN clause to filter the list of dynamic tables.
like GetDynamicTablesLike: LIKE clause to filter the list of dynamic tables.
limit GetDynamicTablesLimit: Optionally limits the maximum number of rows returned, while also enabling “pagination” of the results. Note that the actual number of rows returned might be less than the specified limit (e.g. the number of existing objects is less than the specified limit).
starts_with str: Optionally filters the command output based on the characters that appear at the beginning of the object name. The string is case-sensitive.

id String: The provider-assigned unique ID for this managed resource.
records List<Property Map>: The list of dynamic tables.
in Property Map: IN clause to filter the list of dynamic tables.
like Property Map: LIKE clause to filter the list of dynamic tables.
limit Property Map: Optionally limits the maximum number of rows returned, while also enabling “pagination” of the results. Note that the actual number of rows returned might be less than the specified limit (e.g. the number of existing objects is less than the specified limit).
startsWith String: Optionally filters the command output based on the characters that appear at the beginning of the object name. The string is case-sensitive.

Supporting Types

GetDynamicTablesIn

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).

GetDynamicTablesLike

Pattern string: Filters the command output by object name. The filter uses case-insensitive pattern matching with support for SQL wildcard characters (% and _).

Pattern string: Filters the command output by object name. The filter uses case-insensitive pattern matching with support for SQL wildcard characters (% and _).

pattern String: Filters the command output by object name. The filter uses case-insensitive pattern matching with support for SQL wildcard characters (% and _).

pattern string: Filters the command output by object name. The filter uses case-insensitive pattern matching with support for SQL wildcard characters (% and _).

pattern str: Filters the command output by object name. The filter uses case-insensitive pattern matching with support for SQL wildcard characters (% and _).

pattern String: Filters the command output by object name. The filter uses case-insensitive pattern matching with support for SQL wildcard characters (% and _).

GetDynamicTablesLimit

From string: The optional FROM 'name_string' subclause effectively serves as a “cursor” for the results. This enables fetching the specified number of rows following the first row whose object name matches the specified string
Rows int: Specifies the maximum number of rows to return.

From string: The optional FROM 'name_string' subclause effectively serves as a “cursor” for the results. This enables fetching the specified number of rows following the first row whose object name matches the specified string
Rows int: Specifies the maximum number of rows to return.

from String: The optional FROM 'name_string' subclause effectively serves as a “cursor” for the results. This enables fetching the specified number of rows following the first row whose object name matches the specified string
rows Integer: Specifies the maximum number of rows to return.

from string: The optional FROM 'name_string' subclause effectively serves as a “cursor” for the results. This enables fetching the specified number of rows following the first row whose object name matches the specified string
rows number: Specifies the maximum number of rows to return.

from_ str: The optional FROM 'name_string' subclause effectively serves as a “cursor” for the results. This enables fetching the specified number of rows following the first row whose object name matches the specified string
rows int: Specifies the maximum number of rows to return.

from String: The optional FROM 'name_string' subclause effectively serves as a “cursor” for the results. This enables fetching the specified number of rows following the first row whose object name matches the specified string
rows Number: Specifies the maximum number of rows to return.

GetDynamicTablesRecord

AutomaticClustering bool: Whether auto-clustering is enabled on the dynamic table. Not currently supported for dynamic tables.
Bytes int: Number of bytes that will be scanned if the entire dynamic table is scanned in a query.
ClusterBy string: The clustering key for the dynamic table.
Comment string: Comment for the dynamic table.
CreatedOn string: Date and time when the dynamic table was created.
DataTimestamp string: Timestamp of the data in the base object(s) that is included in the dynamic table.
DatabaseName string: Database in which the dynamic table is stored.
IsClone bool: TRUE if the dynamic table has been cloned, else FALSE.
IsReplica bool: TRUE if the dynamic table is a replica. else FALSE.
LastSuspendedOn string: Timestamp of last suspension.
Name string: Name of the dynamic table.
Owner string: Role that owns the dynamic table.
RefreshMode string: INCREMENTAL if the dynamic table will use incremental refreshes, or FULL if it will recompute the whole table on every refresh.
RefreshModeReason string: Explanation for why FULL refresh mode was chosen. NULL if refresh mode is not FULL.
Rows int: Number of rows in the table.
SchedulingState string: Displays RUNNING for dynamic tables that are actively scheduling refreshes and SUSPENDED for suspended dynamic tables.
SchemaName string: Schema in which the dynamic table is stored.
TargetLag string: The maximum duration that the dynamic table’s content should lag behind real time.
Text string: The text of the command that created this dynamic table (e.g. CREATE DYNAMIC TABLE ...).
Warehouse string: Warehouse that provides the required resources to perform the incremental refreshes.

AutomaticClustering bool: Whether auto-clustering is enabled on the dynamic table. Not currently supported for dynamic tables.
Bytes int: Number of bytes that will be scanned if the entire dynamic table is scanned in a query.
ClusterBy string: The clustering key for the dynamic table.
Comment string: Comment for the dynamic table.
CreatedOn string: Date and time when the dynamic table was created.
DataTimestamp string: Timestamp of the data in the base object(s) that is included in the dynamic table.
DatabaseName string: Database in which the dynamic table is stored.
IsClone bool: TRUE if the dynamic table has been cloned, else FALSE.
IsReplica bool: TRUE if the dynamic table is a replica. else FALSE.
LastSuspendedOn string: Timestamp of last suspension.
Name string: Name of the dynamic table.
Owner string: Role that owns the dynamic table.
RefreshMode string: INCREMENTAL if the dynamic table will use incremental refreshes, or FULL if it will recompute the whole table on every refresh.
RefreshModeReason string: Explanation for why FULL refresh mode was chosen. NULL if refresh mode is not FULL.
Rows int: Number of rows in the table.
SchedulingState string: Displays RUNNING for dynamic tables that are actively scheduling refreshes and SUSPENDED for suspended dynamic tables.
SchemaName string: Schema in which the dynamic table is stored.
TargetLag string: The maximum duration that the dynamic table’s content should lag behind real time.
Text string: The text of the command that created this dynamic table (e.g. CREATE DYNAMIC TABLE ...).
Warehouse string: Warehouse that provides the required resources to perform the incremental refreshes.

automaticClustering Boolean: Whether auto-clustering is enabled on the dynamic table. Not currently supported for dynamic tables.
bytes Integer: Number of bytes that will be scanned if the entire dynamic table is scanned in a query.
clusterBy String: The clustering key for the dynamic table.
comment String: Comment for the dynamic table.
createdOn String: Date and time when the dynamic table was created.
dataTimestamp String: Timestamp of the data in the base object(s) that is included in the dynamic table.
databaseName String: Database in which the dynamic table is stored.
isClone Boolean: TRUE if the dynamic table has been cloned, else FALSE.
isReplica Boolean: TRUE if the dynamic table is a replica. else FALSE.
lastSuspendedOn String: Timestamp of last suspension.
name String: Name of the dynamic table.
owner String: Role that owns the dynamic table.
refreshMode String: INCREMENTAL if the dynamic table will use incremental refreshes, or FULL if it will recompute the whole table on every refresh.
refreshModeReason String: Explanation for why FULL refresh mode was chosen. NULL if refresh mode is not FULL.
rows Integer: Number of rows in the table.
schedulingState String: Displays RUNNING for dynamic tables that are actively scheduling refreshes and SUSPENDED for suspended dynamic tables.
schemaName String: Schema in which the dynamic table is stored.
targetLag String: The maximum duration that the dynamic table’s content should lag behind real time.
text String: The text of the command that created this dynamic table (e.g. CREATE DYNAMIC TABLE ...).
warehouse String: Warehouse that provides the required resources to perform the incremental refreshes.

automaticClustering boolean: Whether auto-clustering is enabled on the dynamic table. Not currently supported for dynamic tables.
bytes number: Number of bytes that will be scanned if the entire dynamic table is scanned in a query.
clusterBy string: The clustering key for the dynamic table.
comment string: Comment for the dynamic table.
createdOn string: Date and time when the dynamic table was created.
dataTimestamp string: Timestamp of the data in the base object(s) that is included in the dynamic table.
databaseName string: Database in which the dynamic table is stored.
isClone boolean: TRUE if the dynamic table has been cloned, else FALSE.
isReplica boolean: TRUE if the dynamic table is a replica. else FALSE.
lastSuspendedOn string: Timestamp of last suspension.
name string: Name of the dynamic table.
owner string: Role that owns the dynamic table.
refreshMode string: INCREMENTAL if the dynamic table will use incremental refreshes, or FULL if it will recompute the whole table on every refresh.
refreshModeReason string: Explanation for why FULL refresh mode was chosen. NULL if refresh mode is not FULL.
rows number: Number of rows in the table.
schedulingState string: Displays RUNNING for dynamic tables that are actively scheduling refreshes and SUSPENDED for suspended dynamic tables.
schemaName string: Schema in which the dynamic table is stored.
targetLag string: The maximum duration that the dynamic table’s content should lag behind real time.
text string: The text of the command that created this dynamic table (e.g. CREATE DYNAMIC TABLE ...).
warehouse string: Warehouse that provides the required resources to perform the incremental refreshes.

automatic_clustering bool: Whether auto-clustering is enabled on the dynamic table. Not currently supported for dynamic tables.
bytes int: Number of bytes that will be scanned if the entire dynamic table is scanned in a query.
cluster_by str: The clustering key for the dynamic table.
comment str: Comment for the dynamic table.
created_on str: Date and time when the dynamic table was created.
data_timestamp str: Timestamp of the data in the base object(s) that is included in the dynamic table.
database_name str: Database in which the dynamic table is stored.
is_clone bool: TRUE if the dynamic table has been cloned, else FALSE.
is_replica bool: TRUE if the dynamic table is a replica. else FALSE.
last_suspended_on str: Timestamp of last suspension.
name str: Name of the dynamic table.
owner str: Role that owns the dynamic table.
refresh_mode str: INCREMENTAL if the dynamic table will use incremental refreshes, or FULL if it will recompute the whole table on every refresh.
refresh_mode_reason str: Explanation for why FULL refresh mode was chosen. NULL if refresh mode is not FULL.
rows int: Number of rows in the table.
scheduling_state str: Displays RUNNING for dynamic tables that are actively scheduling refreshes and SUSPENDED for suspended dynamic tables.
schema_name str: Schema in which the dynamic table is stored.
target_lag str: The maximum duration that the dynamic table’s content should lag behind real time.
text str: The text of the command that created this dynamic table (e.g. CREATE DYNAMIC TABLE ...).
warehouse str: Warehouse that provides the required resources to perform the incremental refreshes.

automaticClustering Boolean: Whether auto-clustering is enabled on the dynamic table. Not currently supported for dynamic tables.
bytes Number: Number of bytes that will be scanned if the entire dynamic table is scanned in a query.
clusterBy String: The clustering key for the dynamic table.
comment String: Comment for the dynamic table.
createdOn String: Date and time when the dynamic table was created.
dataTimestamp String: Timestamp of the data in the base object(s) that is included in the dynamic table.
databaseName String: Database in which the dynamic table is stored.
isClone Boolean: TRUE if the dynamic table has been cloned, else FALSE.
isReplica Boolean: TRUE if the dynamic table is a replica. else FALSE.
lastSuspendedOn String: Timestamp of last suspension.
name String: Name of the dynamic table.
owner String: Role that owns the dynamic table.
refreshMode String: INCREMENTAL if the dynamic table will use incremental refreshes, or FULL if it will recompute the whole table on every refresh.
refreshModeReason String: Explanation for why FULL refresh mode was chosen. NULL if refresh mode is not FULL.
rows Number: Number of rows in the table.
schedulingState String: Displays RUNNING for dynamic tables that are actively scheduling refreshes and SUSPENDED for suspended dynamic tables.
schemaName String: Schema in which the dynamic table is stored.
targetLag String: The maximum duration that the dynamic table’s content should lag behind real time.
text String: The text of the command that created this dynamic table (e.g. CREATE DYNAMIC TABLE ...).
warehouse String: Warehouse that provides the required resources to perform the incremental refreshes.

Package Details

Repository: Snowflake pulumi/pulumi-snowflake
License: Apache-2.0
Notes: This Pulumi package is based on the snowflake Terraform Provider.

Snowflake v0.59.0 published on Friday, Sep 20, 2024 by Pulumi

pulumi/pulumi-snowflake

snowflake.getDynamicTables

On this page

On this page

Using getDynamicTables

getDynamicTables Result

Supporting Types

GetDynamicTablesIn

GetDynamicTablesLike

GetDynamicTablesLimit

GetDynamicTablesRecord

Package Details

On this page

On this page