Sign in Dashboard Get started
  1. Registry
  2. Packages
  3. Snowflake Provider
  4. API Docs
  5. getFileFormats
Viewing docs for Snowflake v2.19.0
published on Friday, Jul 31, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-snowflake

snowflake.getFileFormats

snowflake logo
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 file formats. Filtering is aligned with the current possibilities for SHOW FILE FORMATS query. The results of SHOW and DESCRIBE are encapsulated in one output collection fileFormats.

    Using getFileFormats

    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 getFileFormats(args: GetFileFormatsArgs, opts?: InvokeOptions): Promise<GetFileFormatsResult>
function getFileFormatsOutput(args: GetFileFormatsOutputArgs, opts?: InvokeOptions): Output<GetFileFormatsResult>
    def get_file_formats(in_: Optional[GetFileFormatsIn] = None,
                     like: Optional[str] = None,
                     with_describe: Optional[bool] = None,
                     opts: Optional[InvokeOptions] = None) -> GetFileFormatsResult
def get_file_formats_output(in_: pulumi.Input[Optional[GetFileFormatsInArgs]] = None,
                     like: pulumi.Input[Optional[str]] = None,
                     with_describe: pulumi.Input[Optional[bool]] = None,
                     opts: Optional[InvokeOptions] = None) -> Output[GetFileFormatsResult]
    func GetFileFormats(ctx *Context, args *GetFileFormatsArgs, opts ...InvokeOption) (*GetFileFormatsResult, error)
func GetFileFormatsOutput(ctx *Context, args *GetFileFormatsOutputArgs, opts ...InvokeOption) GetFileFormatsResultOutput

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

    public static class GetFileFormats 
{
    public static Task<GetFileFormatsResult> InvokeAsync(GetFileFormatsArgs args, InvokeOptions? opts = null)
    public static Output<GetFileFormatsResult> Invoke(GetFileFormatsInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetFileFormatsResult> getFileFormats(GetFileFormatsArgs args, InvokeOptions options)
public static Output<GetFileFormatsResult> getFileFormats(GetFileFormatsArgs args, InvokeOptions options)

    fn::invoke:
  function: snowflake:index/getFileFormats:getFileFormats
  arguments:
    # arguments dictionary
    data "snowflake_get_file_formats" "name" {
    # arguments
}

    The following arguments are supported:

    In GetFileFormatsIn
    IN clause to filter the list of objects
    Like string
    Filters the output with case-insensitive pattern, with support for SQL wildcard characters (% and _).
    WithDescribe bool
    (Default: true) Runs DESC FILE FORMAT for each file format returned by SHOW FILE FORMATS. The output of describe is saved to the describeOutput field. By default this value is set to true.
    In GetFileFormatsIn
    IN clause to filter the list of objects
    Like string
    Filters the output with case-insensitive pattern, with support for SQL wildcard characters (% and _).
    WithDescribe bool
    (Default: true) Runs DESC FILE FORMAT for each file format returned by SHOW FILE FORMATS. The output of describe is saved to the describeOutput 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 _).
    with_describe bool
    (Default: true) Runs DESC FILE FORMAT for each file format returned by SHOW FILE FORMATS. The output of describe is saved to the describeOutput field. By default this value is set to true.
    in GetFileFormatsIn
    IN clause to filter the list of objects
    like String
    Filters the output with case-insensitive pattern, with support for SQL wildcard characters (% and _).
    withDescribe Boolean
    (Default: true) Runs DESC FILE FORMAT for each file format returned by SHOW FILE FORMATS. The output of describe is saved to the describeOutput field. By default this value is set to true.
    in GetFileFormatsIn
    IN clause to filter the list of objects
    like string
    Filters the output with case-insensitive pattern, with support for SQL wildcard characters (% and _).
    withDescribe boolean
    (Default: true) Runs DESC FILE FORMAT for each file format returned by SHOW FILE FORMATS. The output of describe is saved to the describeOutput field. By default this value is set to true.
    in_ GetFileFormatsIn
    IN clause to filter the list of objects
    like str
    Filters the output with case-insensitive pattern, with support for SQL wildcard characters (% and _).
    with_describe bool
    (Default: true) Runs DESC FILE FORMAT for each file format returned by SHOW FILE FORMATS. The output of describe is saved to the describeOutput 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 _).
    withDescribe Boolean
    (Default: true) Runs DESC FILE FORMAT for each file format returned by SHOW FILE FORMATS. The output of describe is saved to the describeOutput field. By default this value is set to true.

    getFileFormats Result

    The following output properties are available:

    FileFormats List<GetFileFormatsFileFormat>
    Holds the aggregated output of all file formats details queries.
    Id string
    The provider-assigned unique ID for this managed resource.
    In GetFileFormatsIn
    IN clause to filter the list of objects
    Like string
    Filters the output with case-insensitive pattern, with support for SQL wildcard characters (% and _).
    WithDescribe bool
    (Default: true) Runs DESC FILE FORMAT for each file format returned by SHOW FILE FORMATS. The output of describe is saved to the describeOutput field. By default this value is set to true.
    FileFormats []GetFileFormatsFileFormat
    Holds the aggregated output of all file formats details queries.
    Id string
    The provider-assigned unique ID for this managed resource.
    In GetFileFormatsIn
    IN clause to filter the list of objects
    Like string
    Filters the output with case-insensitive pattern, with support for SQL wildcard characters (% and _).
    WithDescribe bool
    (Default: true) Runs DESC FILE FORMAT for each file format returned by SHOW FILE FORMATS. The output of describe is saved to the describeOutput field. By default this value is set to true.
    file_formats list(object)
    Holds the aggregated output of all file formats details queries.
    id string
    The provider-assigned unique ID for this managed resource.
    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 _).
    with_describe bool
    (Default: true) Runs DESC FILE FORMAT for each file format returned by SHOW FILE FORMATS. The output of describe is saved to the describeOutput field. By default this value is set to true.
    fileFormats List<GetFileFormatsFileFormat>
    Holds the aggregated output of all file formats details queries.
    id String
    The provider-assigned unique ID for this managed resource.
    in GetFileFormatsIn
    IN clause to filter the list of objects
    like String
    Filters the output with case-insensitive pattern, with support for SQL wildcard characters (% and _).
    withDescribe Boolean
    (Default: true) Runs DESC FILE FORMAT for each file format returned by SHOW FILE FORMATS. The output of describe is saved to the describeOutput field. By default this value is set to true.
    fileFormats GetFileFormatsFileFormat[]
    Holds the aggregated output of all file formats details queries.
    id string
    The provider-assigned unique ID for this managed resource.
    in GetFileFormatsIn
    IN clause to filter the list of objects
    like string
    Filters the output with case-insensitive pattern, with support for SQL wildcard characters (% and _).
    withDescribe boolean
    (Default: true) Runs DESC FILE FORMAT for each file format returned by SHOW FILE FORMATS. The output of describe is saved to the describeOutput field. By default this value is set to true.
    file_formats Sequence[GetFileFormatsFileFormat]
    Holds the aggregated output of all file formats details queries.
    id str
    The provider-assigned unique ID for this managed resource.
    in_ GetFileFormatsIn
    IN clause to filter the list of objects
    like str
    Filters the output with case-insensitive pattern, with support for SQL wildcard characters (% and _).
    with_describe bool
    (Default: true) Runs DESC FILE FORMAT for each file format returned by SHOW FILE FORMATS. The output of describe is saved to the describeOutput field. By default this value is set to true.
    fileFormats List<Property Map>
    Holds the aggregated output of all file formats details queries.
    id String
    The provider-assigned unique ID for this managed resource.
    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 _).
    withDescribe Boolean
    (Default: true) Runs DESC FILE FORMAT for each file format returned by SHOW FILE FORMATS. The output of describe is saved to the describeOutput field. By default this value is set to true.

    Supporting Types

    GetFileFormatsFileFormat

    DescribeOutputs List<GetFileFormatsFileFormatDescribeOutput>
    Holds the output of DESCRIBE FILE FORMAT. Because every file format type returns a different set of properties, this is a union of the properties of all the file format types; only the fields applicable to the given file format type are filled.
    ShowOutputs List<GetFileFormatsFileFormatShowOutput>
    Holds the output of SHOW FILE FORMATS.
    DescribeOutputs []GetFileFormatsFileFormatDescribeOutput
    Holds the output of DESCRIBE FILE FORMAT. Because every file format type returns a different set of properties, this is a union of the properties of all the file format types; only the fields applicable to the given file format type are filled.
    ShowOutputs []GetFileFormatsFileFormatShowOutput
    Holds the output of SHOW FILE FORMATS.
    describe_outputs list(object)
    Holds the output of DESCRIBE FILE FORMAT. Because every file format type returns a different set of properties, this is a union of the properties of all the file format types; only the fields applicable to the given file format type are filled.
    show_outputs list(object)
    Holds the output of SHOW FILE FORMATS.
    describeOutputs List<GetFileFormatsFileFormatDescribeOutput>
    Holds the output of DESCRIBE FILE FORMAT. Because every file format type returns a different set of properties, this is a union of the properties of all the file format types; only the fields applicable to the given file format type are filled.
    showOutputs List<GetFileFormatsFileFormatShowOutput>
    Holds the output of SHOW FILE FORMATS.
    describeOutputs GetFileFormatsFileFormatDescribeOutput[]
    Holds the output of DESCRIBE FILE FORMAT. Because every file format type returns a different set of properties, this is a union of the properties of all the file format types; only the fields applicable to the given file format type are filled.
    showOutputs GetFileFormatsFileFormatShowOutput[]
    Holds the output of SHOW FILE FORMATS.
    describe_outputs Sequence[GetFileFormatsFileFormatDescribeOutput]
    Holds the output of DESCRIBE FILE FORMAT. Because every file format type returns a different set of properties, this is a union of the properties of all the file format types; only the fields applicable to the given file format type are filled.
    show_outputs Sequence[GetFileFormatsFileFormatShowOutput]
    Holds the output of SHOW FILE FORMATS.
    describeOutputs List<Property Map>
    Holds the output of DESCRIBE FILE FORMAT. Because every file format type returns a different set of properties, this is a union of the properties of all the file format types; only the fields applicable to the given file format type are filled.
    showOutputs List<Property Map>
    Holds the output of SHOW FILE FORMATS.

    GetFileFormatsFileFormatDescribeOutput

    GetFileFormatsFileFormatShowOutput

    Comment string
    CreatedOn string
    DatabaseName string
    FormatOptions string
    Name string
    Owner string
    OwnerRoleType string
    SchemaName string
    Type string
    Comment string
    CreatedOn string
    DatabaseName string
    FormatOptions string
    Name string
    Owner string
    OwnerRoleType string
    SchemaName string
    Type string
    comment string
    created_on string
    database_name string
    format_options string
    name string
    owner string
    owner_role_type string
    schema_name string
    type string
    comment String
    createdOn String
    databaseName String
    formatOptions String
    name String
    owner String
    ownerRoleType String
    schemaName String
    type String
    comment string
    createdOn string
    databaseName string
    formatOptions string
    name string
    owner string
    ownerRoleType string
    schemaName string
    type string
    comment String
    createdOn String
    databaseName String
    formatOptions String
    name String
    owner String
    ownerRoleType String
    schemaName String
    type String

    GetFileFormatsIn

    Account bool
    Returns records for the entire account.
    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.
    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.
    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.
    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.
    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.
    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.
    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.

    Package Details

    Repository
    Snowflake pulumi/pulumi-snowflake
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the snowflake Terraform Provider.
    snowflake logo
    Viewing docs for Snowflake v2.19.0
    published on Friday, Jul 31, 2026 by Pulumi
    Schema (JSON)
    pulumi/pulumi-snowflake

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial