Snowflake v0.61.1 published on Thursday, Nov 14, 2024 by Pulumi
snowflake.getDynamicTables
Explore with Pulumi AI
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
Get
Dynamic Tables In - IN clause to filter the list of dynamic tables.
- Like
Get
Dynamic Tables Like - LIKE clause to filter the list of dynamic tables.
- Limit
Get
Dynamic Tables Limit - 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 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
Get
Dynamic Tables In - IN clause to filter the list of dynamic tables.
- Like
Get
Dynamic Tables Like - LIKE clause to filter the list of dynamic tables.
- Limit
Get
Dynamic Tables Limit - 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 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
Get
Dynamic Tables In - IN clause to filter the list of dynamic tables.
- like
Get
Dynamic Tables Like - LIKE clause to filter the list of dynamic tables.
- limit
Get
Dynamic Tables Limit - 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 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
Get
Dynamic Tables In - IN clause to filter the list of dynamic tables.
- like
Get
Dynamic Tables Like - LIKE clause to filter the list of dynamic tables.
- limit
Get
Dynamic Tables Limit - 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 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_
Get
Dynamic Tables In - IN clause to filter the list of dynamic tables.
- like
Get
Dynamic Tables Like - LIKE clause to filter the list of dynamic tables.
- limit
Get
Dynamic Tables Limit - 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).
- starts
With 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<Get
Dynamic Tables Record> - The list of dynamic tables.
- In
Get
Dynamic Tables In - IN clause to filter the list of dynamic tables.
- Like
Get
Dynamic Tables Like - LIKE clause to filter the list of dynamic tables.
- Limit
Get
Dynamic Tables Limit - 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 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
[]Get
Dynamic Tables Record - The list of dynamic tables.
- In
Get
Dynamic Tables In - IN clause to filter the list of dynamic tables.
- Like
Get
Dynamic Tables Like - LIKE clause to filter the list of dynamic tables.
- Limit
Get
Dynamic Tables Limit - 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 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<Get
Dynamic Tables Record> - The list of dynamic tables.
- in
Get
Dynamic Tables In - IN clause to filter the list of dynamic tables.
- like
Get
Dynamic Tables Like - LIKE clause to filter the list of dynamic tables.
- limit
Get
Dynamic Tables Limit - 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 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
Get
Dynamic Tables Record[] - The list of dynamic tables.
- in
Get
Dynamic Tables In - IN clause to filter the list of dynamic tables.
- like
Get
Dynamic Tables Like - LIKE clause to filter the list of dynamic tables.
- limit
Get
Dynamic Tables Limit - 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 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[Get
Dynamic Tables Record] - The list of dynamic tables.
- in_
Get
Dynamic Tables In - IN clause to filter the list of dynamic tables.
- like
Get
Dynamic Tables Like - LIKE clause to filter the list of dynamic tables.
- limit
Get
Dynamic Tables Limit - 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).
- starts
With 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
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
GetDynamicTablesRecord
- 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 string - The clustering key for the dynamic table.
- Comment string
- Comment for the dynamic table.
- Created
On string - Date and time when the dynamic table was created.
- Data
Timestamp string - Timestamp of the data in the base object(s) that is included in the dynamic table.
- Database
Name string - 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 stringOn - Timestamp of last suspension.
- Name string
- Name of the dynamic table.
- Owner string
- Role that owns the dynamic table.
- Refresh
Mode string - INCREMENTAL if the dynamic table will use incremental refreshes, or FULL if it will recompute the whole table on every refresh.
- Refresh
Mode stringReason - 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 string - Displays RUNNING for dynamic tables that are actively scheduling refreshes and SUSPENDED for suspended dynamic tables.
- Schema
Name string - Schema in which the dynamic table is stored.
- Target
Lag 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 string - The clustering key for the dynamic table.
- Comment string
- Comment for the dynamic table.
- Created
On string - Date and time when the dynamic table was created.
- Data
Timestamp string - Timestamp of the data in the base object(s) that is included in the dynamic table.
- Database
Name string - 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 stringOn - Timestamp of last suspension.
- Name string
- Name of the dynamic table.
- Owner string
- Role that owns the dynamic table.
- Refresh
Mode string - INCREMENTAL if the dynamic table will use incremental refreshes, or FULL if it will recompute the whole table on every refresh.
- Refresh
Mode stringReason - 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 string - Displays RUNNING for dynamic tables that are actively scheduling refreshes and SUSPENDED for suspended dynamic tables.
- Schema
Name string - Schema in which the dynamic table is stored.
- Target
Lag 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 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.
- cluster
By String - The clustering key for the dynamic table.
- comment String
- Comment for the dynamic table.
- created
On String - Date and time when the dynamic table was created.
- data
Timestamp String - Timestamp of the data in the base object(s) that is included in the dynamic table.
- database
Name String - Database in which the dynamic table is stored.
- is
Clone Boolean - TRUE if the dynamic table has been cloned, else FALSE.
- is
Replica Boolean - TRUE if the dynamic table is a replica. else FALSE.
- last
Suspended StringOn - Timestamp of last suspension.
- name String
- Name of the dynamic table.
- owner String
- Role that owns the dynamic table.
- refresh
Mode String - INCREMENTAL if the dynamic table will use incremental refreshes, or FULL if it will recompute the whole table on every refresh.
- refresh
Mode StringReason - Explanation for why FULL refresh mode was chosen. NULL if refresh mode is not FULL.
- rows Integer
- Number of rows in the table.
- scheduling
State String - Displays RUNNING for dynamic tables that are actively scheduling refreshes and SUSPENDED for suspended dynamic tables.
- schema
Name String - Schema in which the dynamic table is stored.
- target
Lag 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 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.
- cluster
By string - The clustering key for the dynamic table.
- comment string
- Comment for the dynamic table.
- created
On string - Date and time when the dynamic table was created.
- data
Timestamp string - Timestamp of the data in the base object(s) that is included in the dynamic table.
- database
Name string - Database in which the dynamic table is stored.
- is
Clone boolean - TRUE if the dynamic table has been cloned, else FALSE.
- is
Replica boolean - TRUE if the dynamic table is a replica. else FALSE.
- last
Suspended stringOn - Timestamp of last suspension.
- name string
- Name of the dynamic table.
- owner string
- Role that owns the dynamic table.
- refresh
Mode string - INCREMENTAL if the dynamic table will use incremental refreshes, or FULL if it will recompute the whole table on every refresh.
- refresh
Mode stringReason - Explanation for why FULL refresh mode was chosen. NULL if refresh mode is not FULL.
- rows number
- Number of rows in the table.
- scheduling
State string - Displays RUNNING for dynamic tables that are actively scheduling refreshes and SUSPENDED for suspended dynamic tables.
- schema
Name string - Schema in which the dynamic table is stored.
- target
Lag 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_ stron - 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_ strreason - 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.
- automatic
Clustering 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.
- cluster
By String - The clustering key for the dynamic table.
- comment String
- Comment for the dynamic table.
- created
On String - Date and time when the dynamic table was created.
- data
Timestamp String - Timestamp of the data in the base object(s) that is included in the dynamic table.
- database
Name String - Database in which the dynamic table is stored.
- is
Clone Boolean - TRUE if the dynamic table has been cloned, else FALSE.
- is
Replica Boolean - TRUE if the dynamic table is a replica. else FALSE.
- last
Suspended StringOn - Timestamp of last suspension.
- name String
- Name of the dynamic table.
- owner String
- Role that owns the dynamic table.
- refresh
Mode String - INCREMENTAL if the dynamic table will use incremental refreshes, or FULL if it will recompute the whole table on every refresh.
- refresh
Mode StringReason - Explanation for why FULL refresh mode was chosen. NULL if refresh mode is not FULL.
- rows Number
- Number of rows in the table.
- scheduling
State String - Displays RUNNING for dynamic tables that are actively scheduling refreshes and SUSPENDED for suspended dynamic tables.
- schema
Name String - Schema in which the dynamic table is stored.
- target
Lag 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.