getIcebergTables

Snowflake v2.19.0, Jul 31 26

Viewing docs for Snowflake v2.19.0
published on Friday, Jul 31, 2026 by Pulumi

Schema (JSON)

pulumi/pulumi-snowflake

Viewing docs for Snowflake v2.19.0
published on Friday, Jul 31, 2026 by Pulumi

Schema (JSON)

pulumi/pulumi-snowflake

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

Data source used to get details of filtered iceberg tables. Filtering is aligned with the current possibilities for SHOW ICEBERG TABLES query (like, in, startsWith, limit). The results of SHOW, DESCRIBE, and SHOW PARAMETERS are encapsulated in one output collection icebergTables.

Using getIcebergTables

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 getIcebergTables(args: GetIcebergTablesArgs, opts?: InvokeOptions): Promise<GetIcebergTablesResult>
function getIcebergTablesOutput(args: GetIcebergTablesOutputArgs, opts?: InvokeOptions): Output<GetIcebergTablesResult>

def get_iceberg_tables(in_: Optional[GetIcebergTablesIn] = None,
                       like: Optional[str] = None,
                       limit: Optional[GetIcebergTablesLimit] = None,
                       starts_with: Optional[str] = None,
                       with_describe: Optional[bool] = None,
                       with_parameters: Optional[bool] = None,
                       opts: Optional[InvokeOptions] = None) -> GetIcebergTablesResult
def get_iceberg_tables_output(in_: pulumi.Input[Optional[GetIcebergTablesInArgs]] = None,
                       like: pulumi.Input[Optional[str]] = None,
                       limit: pulumi.Input[Optional[GetIcebergTablesLimitArgs]] = None,
                       starts_with: pulumi.Input[Optional[str]] = None,
                       with_describe: pulumi.Input[Optional[bool]] = None,
                       with_parameters: pulumi.Input[Optional[bool]] = None,
                       opts: Optional[InvokeOptions] = None) -> Output[GetIcebergTablesResult]

func GetIcebergTables(ctx *Context, args *GetIcebergTablesArgs, opts ...InvokeOption) (*GetIcebergTablesResult, error)
func GetIcebergTablesOutput(ctx *Context, args *GetIcebergTablesOutputArgs, opts ...InvokeOption) GetIcebergTablesResultOutput

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

public static class GetIcebergTables 
{
    public static Task<GetIcebergTablesResult> InvokeAsync(GetIcebergTablesArgs args, InvokeOptions? opts = null)
    public static Output<GetIcebergTablesResult> Invoke(GetIcebergTablesInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetIcebergTablesResult> getIcebergTables(GetIcebergTablesArgs args, InvokeOptions options)
public static Output<GetIcebergTablesResult> getIcebergTables(GetIcebergTablesArgs args, InvokeOptions options)

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

data "snowflake_get_iceberg_tables" "name" {
    # arguments
}

The following arguments are supported:

In GetIcebergTablesIn: 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 GetIcebergTablesLimit: 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 startsWith or like.
StartsWith string: Filters the output with case-sensitive characters indicating the beginning of the object name.
WithDescribe bool: (Default: true) Runs DESC ICEBERG TABLE for each iceberg table returned by SHOW ICEBERG TABLES. The output of describe is saved to the describeOutput field. By default this value is set to true.
WithParameters bool: (Default: true) Runs SHOW PARAMETERS FOR ICEBERG TABLE for each iceberg table returned by SHOW ICEBERG TABLES. The output is saved to the parameters field. By default this value is set to true.

In GetIcebergTablesIn: 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 GetIcebergTablesLimit: 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 startsWith or like.
StartsWith string: Filters the output with case-sensitive characters indicating the beginning of the object name.
WithDescribe bool: (Default: true) Runs DESC ICEBERG TABLE for each iceberg table returned by SHOW ICEBERG TABLES. The output of describe is saved to the describeOutput field. By default this value is set to true.
WithParameters bool: (Default: true) Runs SHOW PARAMETERS FOR ICEBERG TABLE for each iceberg table returned by SHOW ICEBERG TABLES. The output is saved to the parameters field. By default this value is set to true.

in object: 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 object: 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 startsWith or like.
starts_with string: Filters the output with case-sensitive characters indicating the beginning of the object name.
with_describe bool: (Default: true) Runs DESC ICEBERG TABLE for each iceberg table returned by SHOW ICEBERG TABLES. The output of describe is saved to the describeOutput field. By default this value is set to true.
with_parameters bool: (Default: true) Runs SHOW PARAMETERS FOR ICEBERG TABLE for each iceberg table returned by SHOW ICEBERG TABLES. The output is saved to the parameters field. By default this value is set to true.

in GetIcebergTablesIn: 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 GetIcebergTablesLimit: 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 startsWith or like.
startsWith String: Filters the output with case-sensitive characters indicating the beginning of the object name.
withDescribe Boolean: (Default: true) Runs DESC ICEBERG TABLE for each iceberg table returned by SHOW ICEBERG TABLES. The output of describe is saved to the describeOutput field. By default this value is set to true.
withParameters Boolean: (Default: true) Runs SHOW PARAMETERS FOR ICEBERG TABLE for each iceberg table returned by SHOW ICEBERG TABLES. The output is saved to the parameters field. By default this value is set to true.

in GetIcebergTablesIn: 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 GetIcebergTablesLimit: 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 startsWith or like.
startsWith string: Filters the output with case-sensitive characters indicating the beginning of the object name.
withDescribe boolean: (Default: true) Runs DESC ICEBERG TABLE for each iceberg table returned by SHOW ICEBERG TABLES. The output of describe is saved to the describeOutput field. By default this value is set to true.
withParameters boolean: (Default: true) Runs SHOW PARAMETERS FOR ICEBERG TABLE for each iceberg table returned by SHOW ICEBERG TABLES. The output is saved to the parameters field. By default this value is set to true.

in_ GetIcebergTablesIn: 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 GetIcebergTablesLimit: 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 startsWith 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 ICEBERG TABLE for each iceberg table returned by SHOW ICEBERG TABLES. The output of describe is saved to the describeOutput field. By default this value is set to true.
with_parameters bool: (Default: true) Runs SHOW PARAMETERS FOR ICEBERG TABLE for each iceberg table returned by SHOW ICEBERG TABLES. The output is saved to the parameters 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 startsWith or like.
startsWith String: Filters the output with case-sensitive characters indicating the beginning of the object name.
withDescribe Boolean: (Default: true) Runs DESC ICEBERG TABLE for each iceberg table returned by SHOW ICEBERG TABLES. The output of describe is saved to the describeOutput field. By default this value is set to true.
withParameters Boolean: (Default: true) Runs SHOW PARAMETERS FOR ICEBERG TABLE for each iceberg table returned by SHOW ICEBERG TABLES. The output is saved to the parameters field. By default this value is set to true.