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

snowflake.FileFormatOrc

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.

    Note A file format cannot be dropped successfully if it has dependent external tables. Before dropping the resource, first drop the dependent external tables manually.

    Note Snowflake returns the same DESCRIBE FILE FORMAT output for nullIf set to an empty list and for nullIf set to a list with a single empty string. Because of that, the provider cannot detect an external change between these two values, and describe_output.null_if is empty in both cases.

    Resource used to manage ORC file formats. For more information, check file format documentation.

    Example Usage

    Note Instead of using fully_qualified_name, you can reference objects managed outside Terraform by constructing a correct ID, consult identifiers guide.

    import * as pulumi from "@pulumi/pulumi";
import * as snowflake from "@pulumi/snowflake";

//# Minimal
const basic = new snowflake.FileFormatOrc("basic", {
    database: "database_name",
    schema: "schema_name",
    name: "file_format_name",
});
//# Complete (with every optional set)
const complete = new snowflake.FileFormatOrc("complete", {
    database: "database_name",
    schema: "schema_name",
    name: "file_format_name",
    trimSpace: "true",
    nullIfs: [
        "NULL",
        "",
    ],
    replaceInvalidCharacters: "false",
    comment: "My ORC file format",
});

    import pulumi
import pulumi_snowflake as snowflake

## Minimal
basic = snowflake.FileFormatOrc("basic",
    database="database_name",
    schema="schema_name",
    name="file_format_name")
## Complete (with every optional set)
complete = snowflake.FileFormatOrc("complete",
    database="database_name",
    schema="schema_name",
    name="file_format_name",
    trim_space="true",
    null_ifs=[
        "NULL",
        "",
    ],
    replace_invalid_characters="false",
    comment="My ORC file format")

    package main

import (
	"github.com/pulumi/pulumi-snowflake/sdk/v2/go/snowflake"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		// # Minimal
		_, err := snowflake.NewFileFormatOrc(ctx, "basic", &snowflake.FileFormatOrcArgs{
			Database: pulumi.String("database_name"),
			Schema:   pulumi.String("schema_name"),
			Name:     pulumi.String("file_format_name"),
		})
		if err != nil {
			return err
		}
		// # Complete (with every optional set)
		_, err = snowflake.NewFileFormatOrc(ctx, "complete", &snowflake.FileFormatOrcArgs{
			Database:  pulumi.String("database_name"),
			Schema:    pulumi.String("schema_name"),
			Name:      pulumi.String("file_format_name"),
			TrimSpace: pulumi.String("true"),
			NullIfs: pulumi.StringArray{
				pulumi.String("NULL"),
				pulumi.String(""),
			},
			ReplaceInvalidCharacters: pulumi.String("false"),
			Comment:                  pulumi.String("My ORC file format"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Snowflake = Pulumi.Snowflake;

return await Deployment.RunAsync(() => 
{
    //# Minimal
    var basic = new Snowflake.FileFormatOrc("basic", new()
    {
        Database = "database_name",
        Schema = "schema_name",
        Name = "file_format_name",
    });

    //# Complete (with every optional set)
    var complete = new Snowflake.FileFormatOrc("complete", new()
    {
        Database = "database_name",
        Schema = "schema_name",
        Name = "file_format_name",
        TrimSpace = "true",
        NullIfs = new[]
        {
            "NULL",
            "",
        },
        ReplaceInvalidCharacters = "false",
        Comment = "My ORC file format",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.snowflake.FileFormatOrc;
import com.pulumi.snowflake.FileFormatOrcArgs;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        //# Minimal
        var basic = new FileFormatOrc("basic", FileFormatOrcArgs.builder()
            .database("database_name")
            .schema("schema_name")
            .name("file_format_name")
            .build());

        //# Complete (with every optional set)
        var complete = new FileFormatOrc("complete", FileFormatOrcArgs.builder()
            .database("database_name")
            .schema("schema_name")
            .name("file_format_name")
            .trimSpace("true")
            .nullIfs(            
                "NULL",
                "")
            .replaceInvalidCharacters("false")
            .comment("My ORC file format")
            .build());

    }
}

    resources:
  ## Minimal
  basic:
    type: snowflake:FileFormatOrc
    properties:
      database: database_name
      schema: schema_name
      name: file_format_name
  ## Complete (with every optional set)
  complete:
    type: snowflake:FileFormatOrc
    properties:
      database: database_name
      schema: schema_name
      name: file_format_name
      trimSpace: 'true'
      nullIfs:
        - NULL
        - ""
      replaceInvalidCharacters: 'false'
      comment: My ORC file format

    pulumi {
  required_providers {
    snowflake = {
      source = "pulumi/snowflake"
    }
  }
}

## Minimal
resource "snowflake_fileformatorc" "basic" {
  database = "database_name"
  schema   = "schema_name"
  name     = "file_format_name"
}
## Complete (with every optional set)
resource "snowflake_fileformatorc" "complete" {
  database                   = "database_name"
  schema                     = "schema_name"
  name                       = "file_format_name"
  trim_space                 = "true"
  null_ifs                   = ["NULL", ""]
  replace_invalid_characters = "false"
  comment                    = "My ORC file format"
}

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

    Create FileFormatOrc Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new FileFormatOrc(name: string, args: FileFormatOrcArgs, opts?: CustomResourceOptions);
    @overload
def FileFormatOrc(resource_name: str,
                  args: FileFormatOrcArgs,
                  opts: Optional[ResourceOptions] = None)

@overload
def FileFormatOrc(resource_name: str,
                  opts: Optional[ResourceOptions] = None,
                  database: Optional[str] = None,
                  schema: Optional[str] = None,
                  comment: Optional[str] = None,
                  name: Optional[str] = None,
                  null_ifs: Optional[Sequence[str]] = None,
                  replace_invalid_characters: Optional[str] = None,
                  trim_space: Optional[str] = None)
    func NewFileFormatOrc(ctx *Context, name string, args FileFormatOrcArgs, opts ...ResourceOption) (*FileFormatOrc, error)
    public FileFormatOrc(string name, FileFormatOrcArgs args, CustomResourceOptions? opts = null)
    public FileFormatOrc(String name, FileFormatOrcArgs args)
public FileFormatOrc(String name, FileFormatOrcArgs args, CustomResourceOptions options)

    type: snowflake:FileFormatOrc
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.


    resource "snowflake_file_format_orc" "name" {
    # resource properties
}

    Parameters

    name string
    The unique name of the resource.
    args FileFormatOrcArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args FileFormatOrcArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args FileFormatOrcArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args FileFormatOrcArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args FileFormatOrcArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var fileFormatOrcResource = new Snowflake.FileFormatOrc("fileFormatOrcResource", new()
{
    Database = "string",
    Schema = "string",
    Comment = "string",
    Name = "string",
    NullIfs = new[]
    {
        "string",
    },
    ReplaceInvalidCharacters = "string",
    TrimSpace = "string",
});

    example, err := snowflake.NewFileFormatOrc(ctx, "fileFormatOrcResource", &snowflake.FileFormatOrcArgs{
	Database: pulumi.String("string"),
	Schema:   pulumi.String("string"),
	Comment:  pulumi.String("string"),
	Name:     pulumi.String("string"),
	NullIfs: pulumi.StringArray{
		pulumi.String("string"),
	},
	ReplaceInvalidCharacters: pulumi.String("string"),
	TrimSpace:                pulumi.String("string"),
})

    resource "snowflake_file_format_orc" "fileFormatOrcResource" {
  lifecycle {
    create_before_destroy = true
  }
  database                   = "string"
  schema                     = "string"
  comment                    = "string"
  name                       = "string"
  null_ifs                   = ["string"]
  replace_invalid_characters = "string"
  trim_space                 = "string"
}

    var fileFormatOrcResource = new FileFormatOrc("fileFormatOrcResource", FileFormatOrcArgs.builder()
    .database("string")
    .schema("string")
    .comment("string")
    .name("string")
    .nullIfs("string")
    .replaceInvalidCharacters("string")
    .trimSpace("string")
    .build());

    file_format_orc_resource = snowflake.FileFormatOrc("fileFormatOrcResource",
    database="string",
    schema="string",
    comment="string",
    name="string",
    null_ifs=["string"],
    replace_invalid_characters="string",
    trim_space="string")

    const fileFormatOrcResource = new snowflake.FileFormatOrc("fileFormatOrcResource", {
    database: "string",
    schema: "string",
    comment: "string",
    name: "string",
    nullIfs: ["string"],
    replaceInvalidCharacters: "string",
    trimSpace: "string",
});

    type: snowflake:FileFormatOrc
properties:
    comment: string
    database: string
    name: string
    nullIfs:
        - string
    replaceInvalidCharacters: string
    schema: string
    trimSpace: string

    FileFormatOrc Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The FileFormatOrc resource accepts the following input properties:

    Database string
    The database in which to create the file format. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
    Schema string
    The schema in which to create the file format. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
    Comment string
    Specifies a comment for the file format.
    Name string
    Specifies the identifier for the file format; must be unique for the database and schema in which the file format is created. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
    NullIfs List<string>
    String used to convert to and from SQL NULL.
    ReplaceInvalidCharacters string
    (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (default)) Boolean that specifies whether to replace invalid UTF-8 characters with the Unicode replacement character. Available options are: "true" or "false". When the value is not set in the configuration the provider will put "default" there which means to use the Snowflake default for this value.
    TrimSpace string
    (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (default)) Boolean that specifies whether to remove white space from fields. Available options are: "true" or "false". When the value is not set in the configuration the provider will put "default" there which means to use the Snowflake default for this value.
    Database string
    The database in which to create the file format. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
    Schema string
    The schema in which to create the file format. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
    Comment string
    Specifies a comment for the file format.
    Name string
    Specifies the identifier for the file format; must be unique for the database and schema in which the file format is created. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
    NullIfs []string
    String used to convert to and from SQL NULL.
    ReplaceInvalidCharacters string
    (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (default)) Boolean that specifies whether to replace invalid UTF-8 characters with the Unicode replacement character. Available options are: "true" or "false". When the value is not set in the configuration the provider will put "default" there which means to use the Snowflake default for this value.
    TrimSpace string
    (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (default)) Boolean that specifies whether to remove white space from fields. Available options are: "true" or "false". When the value is not set in the configuration the provider will put "default" there which means to use the Snowflake default for this value.
    database string
    The database in which to create the file format. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
    schema string
    The schema in which to create the file format. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
    comment string
    Specifies a comment for the file format.
    name string
    Specifies the identifier for the file format; must be unique for the database and schema in which the file format is created. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
    null_ifs list(string)
    String used to convert to and from SQL NULL.
    replace_invalid_characters string
    (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (default)) Boolean that specifies whether to replace invalid UTF-8 characters with the Unicode replacement character. Available options are: "true" or "false". When the value is not set in the configuration the provider will put "default" there which means to use the Snowflake default for this value.
    trim_space string
    (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (default)) Boolean that specifies whether to remove white space from fields. Available options are: "true" or "false". When the value is not set in the configuration the provider will put "default" there which means to use the Snowflake default for this value.
    database String
    The database in which to create the file format. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
    schema String
    The schema in which to create the file format. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
    comment String
    Specifies a comment for the file format.
    name String
    Specifies the identifier for the file format; must be unique for the database and schema in which the file format is created. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
    nullIfs List<String>
    String used to convert to and from SQL NULL.
    replaceInvalidCharacters String
    (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (default)) Boolean that specifies whether to replace invalid UTF-8 characters with the Unicode replacement character. Available options are: "true" or "false". When the value is not set in the configuration the provider will put "default" there which means to use the Snowflake default for this value.
    trimSpace String
    (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (default)) Boolean that specifies whether to remove white space from fields. Available options are: "true" or "false". When the value is not set in the configuration the provider will put "default" there which means to use the Snowflake default for this value.
    database string
    The database in which to create the file format. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
    schema string
    The schema in which to create the file format. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
    comment string
    Specifies a comment for the file format.
    name string
    Specifies the identifier for the file format; must be unique for the database and schema in which the file format is created. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
    nullIfs string[]
    String used to convert to and from SQL NULL.
    replaceInvalidCharacters string
    (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (default)) Boolean that specifies whether to replace invalid UTF-8 characters with the Unicode replacement character. Available options are: "true" or "false". When the value is not set in the configuration the provider will put "default" there which means to use the Snowflake default for this value.
    trimSpace string
    (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (default)) Boolean that specifies whether to remove white space from fields. Available options are: "true" or "false". When the value is not set in the configuration the provider will put "default" there which means to use the Snowflake default for this value.
    database str
    The database in which to create the file format. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
    schema str
    The schema in which to create the file format. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
    comment str
    Specifies a comment for the file format.
    name str
    Specifies the identifier for the file format; must be unique for the database and schema in which the file format is created. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
    null_ifs Sequence[str]
    String used to convert to and from SQL NULL.
    replace_invalid_characters str
    (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (default)) Boolean that specifies whether to replace invalid UTF-8 characters with the Unicode replacement character. Available options are: "true" or "false". When the value is not set in the configuration the provider will put "default" there which means to use the Snowflake default for this value.
    trim_space str
    (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (default)) Boolean that specifies whether to remove white space from fields. Available options are: "true" or "false". When the value is not set in the configuration the provider will put "default" there which means to use the Snowflake default for this value.
    database String
    The database in which to create the file format. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
    schema String
    The schema in which to create the file format. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
    comment String
    Specifies a comment for the file format.
    name String
    Specifies the identifier for the file format; must be unique for the database and schema in which the file format is created. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
    nullIfs List<String>
    String used to convert to and from SQL NULL.
    replaceInvalidCharacters String
    (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (default)) Boolean that specifies whether to replace invalid UTF-8 characters with the Unicode replacement character. Available options are: "true" or "false". When the value is not set in the configuration the provider will put "default" there which means to use the Snowflake default for this value.
    trimSpace String
    (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (default)) Boolean that specifies whether to remove white space from fields. Available options are: "true" or "false". When the value is not set in the configuration the provider will put "default" there which means to use the Snowflake default for this value.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the FileFormatOrc resource produces the following output properties:

    DescribeOutputs List<FileFormatOrcDescribeOutput>
    Outputs the result of DESCRIBE FILE FORMAT for this file format.
    FullyQualifiedName string
    Fully qualified name of the resource. For more information, see object name resolution.
    Id string
    The provider-assigned unique ID for this managed resource.
    ShowOutputs List<FileFormatOrcShowOutput>
    Outputs the result of SHOW FILE FORMATS for this file format.
    Type string
    Specifies the type of the file format. This field is used to detect when the file format type was changed outside of Terraform and to recreate the resource when that happens.
    DescribeOutputs []FileFormatOrcDescribeOutput
    Outputs the result of DESCRIBE FILE FORMAT for this file format.
    FullyQualifiedName string
    Fully qualified name of the resource. For more information, see object name resolution.
    Id string
    The provider-assigned unique ID for this managed resource.
    ShowOutputs []FileFormatOrcShowOutput
    Outputs the result of SHOW FILE FORMATS for this file format.
    Type string
    Specifies the type of the file format. This field is used to detect when the file format type was changed outside of Terraform and to recreate the resource when that happens.
    describe_outputs list(object)
    Outputs the result of DESCRIBE FILE FORMAT for this file format.
    fully_qualified_name string
    Fully qualified name of the resource. For more information, see object name resolution.
    id string
    The provider-assigned unique ID for this managed resource.
    show_outputs list(object)
    Outputs the result of SHOW FILE FORMATS for this file format.
    type string
    Specifies the type of the file format. This field is used to detect when the file format type was changed outside of Terraform and to recreate the resource when that happens.
    describeOutputs List<FileFormatOrcDescribeOutput>
    Outputs the result of DESCRIBE FILE FORMAT for this file format.
    fullyQualifiedName String
    Fully qualified name of the resource. For more information, see object name resolution.
    id String
    The provider-assigned unique ID for this managed resource.
    showOutputs List<FileFormatOrcShowOutput>
    Outputs the result of SHOW FILE FORMATS for this file format.
    type String
    Specifies the type of the file format. This field is used to detect when the file format type was changed outside of Terraform and to recreate the resource when that happens.
    describeOutputs FileFormatOrcDescribeOutput[]
    Outputs the result of DESCRIBE FILE FORMAT for this file format.
    fullyQualifiedName string
    Fully qualified name of the resource. For more information, see object name resolution.
    id string
    The provider-assigned unique ID for this managed resource.
    showOutputs FileFormatOrcShowOutput[]
    Outputs the result of SHOW FILE FORMATS for this file format.
    type string
    Specifies the type of the file format. This field is used to detect when the file format type was changed outside of Terraform and to recreate the resource when that happens.
    describe_outputs Sequence[FileFormatOrcDescribeOutput]
    Outputs the result of DESCRIBE FILE FORMAT for this file format.
    fully_qualified_name str
    Fully qualified name of the resource. For more information, see object name resolution.
    id str
    The provider-assigned unique ID for this managed resource.
    show_outputs Sequence[FileFormatOrcShowOutput]
    Outputs the result of SHOW FILE FORMATS for this file format.
    type str
    Specifies the type of the file format. This field is used to detect when the file format type was changed outside of Terraform and to recreate the resource when that happens.
    describeOutputs List<Property Map>
    Outputs the result of DESCRIBE FILE FORMAT for this file format.
    fullyQualifiedName String
    Fully qualified name of the resource. For more information, see object name resolution.
    id String
    The provider-assigned unique ID for this managed resource.
    showOutputs List<Property Map>
    Outputs the result of SHOW FILE FORMATS for this file format.
    type String
    Specifies the type of the file format. This field is used to detect when the file format type was changed outside of Terraform and to recreate the resource when that happens.

    Look up Existing FileFormatOrc Resource

    Get an existing FileFormatOrc resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: FileFormatOrcState, opts?: CustomResourceOptions): FileFormatOrc
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        comment: Optional[str] = None,
        database: Optional[str] = None,
        describe_outputs: Optional[Sequence[FileFormatOrcDescribeOutputArgs]] = None,
        fully_qualified_name: Optional[str] = None,
        name: Optional[str] = None,
        null_ifs: Optional[Sequence[str]] = None,
        replace_invalid_characters: Optional[str] = None,
        schema: Optional[str] = None,
        show_outputs: Optional[Sequence[FileFormatOrcShowOutputArgs]] = None,
        trim_space: Optional[str] = None,
        type: Optional[str] = None) -> FileFormatOrc
    func GetFileFormatOrc(ctx *Context, name string, id IDInput, state *FileFormatOrcState, opts ...ResourceOption) (*FileFormatOrc, error)
    public static FileFormatOrc Get(string name, Input<string> id, FileFormatOrcState? state, CustomResourceOptions? opts = null)
    public static FileFormatOrc get(String name, Output<String> id, FileFormatOrcState state, CustomResourceOptions options)
    resources:  _:    type: snowflake:FileFormatOrc    get:      id: ${id}
    import {
  to = snowflake_file_format_orc.example
  id = "${id}"
}
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    Comment string
    Specifies a comment for the file format.
    Database string
    The database in which to create the file format. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
    DescribeOutputs List<FileFormatOrcDescribeOutput>
    Outputs the result of DESCRIBE FILE FORMAT for this file format.
    FullyQualifiedName string
    Fully qualified name of the resource. For more information, see object name resolution.
    Name string
    Specifies the identifier for the file format; must be unique for the database and schema in which the file format is created. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
    NullIfs List<string>
    String used to convert to and from SQL NULL.
    ReplaceInvalidCharacters string
    (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (default)) Boolean that specifies whether to replace invalid UTF-8 characters with the Unicode replacement character. Available options are: "true" or "false". When the value is not set in the configuration the provider will put "default" there which means to use the Snowflake default for this value.
    Schema string
    The schema in which to create the file format. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
    ShowOutputs List<FileFormatOrcShowOutput>
    Outputs the result of SHOW FILE FORMATS for this file format.
    TrimSpace string
    (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (default)) Boolean that specifies whether to remove white space from fields. Available options are: "true" or "false". When the value is not set in the configuration the provider will put "default" there which means to use the Snowflake default for this value.
    Type string
    Specifies the type of the file format. This field is used to detect when the file format type was changed outside of Terraform and to recreate the resource when that happens.
    Comment string
    Specifies a comment for the file format.
    Database string
    The database in which to create the file format. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
    DescribeOutputs []FileFormatOrcDescribeOutputArgs
    Outputs the result of DESCRIBE FILE FORMAT for this file format.
    FullyQualifiedName string
    Fully qualified name of the resource. For more information, see object name resolution.
    Name string
    Specifies the identifier for the file format; must be unique for the database and schema in which the file format is created. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
    NullIfs []string
    String used to convert to and from SQL NULL.
    ReplaceInvalidCharacters string
    (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (default)) Boolean that specifies whether to replace invalid UTF-8 characters with the Unicode replacement character. Available options are: "true" or "false". When the value is not set in the configuration the provider will put "default" there which means to use the Snowflake default for this value.
    Schema string
    The schema in which to create the file format. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
    ShowOutputs []FileFormatOrcShowOutputArgs
    Outputs the result of SHOW FILE FORMATS for this file format.
    TrimSpace string
    (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (default)) Boolean that specifies whether to remove white space from fields. Available options are: "true" or "false". When the value is not set in the configuration the provider will put "default" there which means to use the Snowflake default for this value.
    Type string
    Specifies the type of the file format. This field is used to detect when the file format type was changed outside of Terraform and to recreate the resource when that happens.
    comment string
    Specifies a comment for the file format.
    database string
    The database in which to create the file format. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
    describe_outputs list(object)
    Outputs the result of DESCRIBE FILE FORMAT for this file format.
    fully_qualified_name string
    Fully qualified name of the resource. For more information, see object name resolution.
    name string
    Specifies the identifier for the file format; must be unique for the database and schema in which the file format is created. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
    null_ifs list(string)
    String used to convert to and from SQL NULL.
    replace_invalid_characters string
    (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (default)) Boolean that specifies whether to replace invalid UTF-8 characters with the Unicode replacement character. Available options are: "true" or "false". When the value is not set in the configuration the provider will put "default" there which means to use the Snowflake default for this value.
    schema string
    The schema in which to create the file format. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
    show_outputs list(object)
    Outputs the result of SHOW FILE FORMATS for this file format.
    trim_space string
    (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (default)) Boolean that specifies whether to remove white space from fields. Available options are: "true" or "false". When the value is not set in the configuration the provider will put "default" there which means to use the Snowflake default for this value.
    type string
    Specifies the type of the file format. This field is used to detect when the file format type was changed outside of Terraform and to recreate the resource when that happens.
    comment String
    Specifies a comment for the file format.
    database String
    The database in which to create the file format. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
    describeOutputs List<FileFormatOrcDescribeOutput>
    Outputs the result of DESCRIBE FILE FORMAT for this file format.
    fullyQualifiedName String
    Fully qualified name of the resource. For more information, see object name resolution.
    name String
    Specifies the identifier for the file format; must be unique for the database and schema in which the file format is created. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
    nullIfs List<String>
    String used to convert to and from SQL NULL.
    replaceInvalidCharacters String
    (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (default)) Boolean that specifies whether to replace invalid UTF-8 characters with the Unicode replacement character. Available options are: "true" or "false". When the value is not set in the configuration the provider will put "default" there which means to use the Snowflake default for this value.
    schema String
    The schema in which to create the file format. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
    showOutputs List<FileFormatOrcShowOutput>
    Outputs the result of SHOW FILE FORMATS for this file format.
    trimSpace String
    (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (default)) Boolean that specifies whether to remove white space from fields. Available options are: "true" or "false". When the value is not set in the configuration the provider will put "default" there which means to use the Snowflake default for this value.
    type String
    Specifies the type of the file format. This field is used to detect when the file format type was changed outside of Terraform and to recreate the resource when that happens.
    comment string
    Specifies a comment for the file format.
    database string
    The database in which to create the file format. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
    describeOutputs FileFormatOrcDescribeOutput[]
    Outputs the result of DESCRIBE FILE FORMAT for this file format.
    fullyQualifiedName string
    Fully qualified name of the resource. For more information, see object name resolution.
    name string
    Specifies the identifier for the file format; must be unique for the database and schema in which the file format is created. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
    nullIfs string[]
    String used to convert to and from SQL NULL.
    replaceInvalidCharacters string
    (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (default)) Boolean that specifies whether to replace invalid UTF-8 characters with the Unicode replacement character. Available options are: "true" or "false". When the value is not set in the configuration the provider will put "default" there which means to use the Snowflake default for this value.
    schema string
    The schema in which to create the file format. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
    showOutputs FileFormatOrcShowOutput[]
    Outputs the result of SHOW FILE FORMATS for this file format.
    trimSpace string
    (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (default)) Boolean that specifies whether to remove white space from fields. Available options are: "true" or "false". When the value is not set in the configuration the provider will put "default" there which means to use the Snowflake default for this value.
    type string
    Specifies the type of the file format. This field is used to detect when the file format type was changed outside of Terraform and to recreate the resource when that happens.
    comment str
    Specifies a comment for the file format.
    database str
    The database in which to create the file format. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
    describe_outputs Sequence[FileFormatOrcDescribeOutputArgs]
    Outputs the result of DESCRIBE FILE FORMAT for this file format.
    fully_qualified_name str
    Fully qualified name of the resource. For more information, see object name resolution.
    name str
    Specifies the identifier for the file format; must be unique for the database and schema in which the file format is created. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
    null_ifs Sequence[str]
    String used to convert to and from SQL NULL.
    replace_invalid_characters str
    (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (default)) Boolean that specifies whether to replace invalid UTF-8 characters with the Unicode replacement character. Available options are: "true" or "false". When the value is not set in the configuration the provider will put "default" there which means to use the Snowflake default for this value.
    schema str
    The schema in which to create the file format. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
    show_outputs Sequence[FileFormatOrcShowOutputArgs]
    Outputs the result of SHOW FILE FORMATS for this file format.
    trim_space str
    (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (default)) Boolean that specifies whether to remove white space from fields. Available options are: "true" or "false". When the value is not set in the configuration the provider will put "default" there which means to use the Snowflake default for this value.
    type str
    Specifies the type of the file format. This field is used to detect when the file format type was changed outside of Terraform and to recreate the resource when that happens.
    comment String
    Specifies a comment for the file format.
    database String
    The database in which to create the file format. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
    describeOutputs List<Property Map>
    Outputs the result of DESCRIBE FILE FORMAT for this file format.
    fullyQualifiedName String
    Fully qualified name of the resource. For more information, see object name resolution.
    name String
    Specifies the identifier for the file format; must be unique for the database and schema in which the file format is created. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
    nullIfs List<String>
    String used to convert to and from SQL NULL.
    replaceInvalidCharacters String
    (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (default)) Boolean that specifies whether to replace invalid UTF-8 characters with the Unicode replacement character. Available options are: "true" or "false". When the value is not set in the configuration the provider will put "default" there which means to use the Snowflake default for this value.
    schema String
    The schema in which to create the file format. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
    showOutputs List<Property Map>
    Outputs the result of SHOW FILE FORMATS for this file format.
    trimSpace String
    (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (default)) Boolean that specifies whether to remove white space from fields. Available options are: "true" or "false". When the value is not set in the configuration the provider will put "default" there which means to use the Snowflake default for this value.
    type String
    Specifies the type of the file format. This field is used to detect when the file format type was changed outside of Terraform and to recreate the resource when that happens.

    Supporting Types

    FileFormatOrcDescribeOutput, FileFormatOrcDescribeOutputArgs

    Id string
    NullIfs List<string>
    ReplaceInvalidCharacters bool
    TrimSpace bool
    Type string
    Id string
    NullIfs []string
    ReplaceInvalidCharacters bool
    TrimSpace bool
    Type string
    id string
    null_ifs list(string)
    replace_invalid_characters bool
    trim_space bool
    type string
    id String
    nullIfs List<String>
    replaceInvalidCharacters Boolean
    trimSpace Boolean
    type String
    id string
    nullIfs string[]
    replaceInvalidCharacters boolean
    trimSpace boolean
    type string
    id String
    nullIfs List<String>
    replaceInvalidCharacters Boolean
    trimSpace Boolean
    type String

    FileFormatOrcShowOutput, FileFormatOrcShowOutputArgs

    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

    Import

    $ pulumi import snowflake:index/fileFormatOrc:FileFormatOrc example '"<database_name>"."<schema_name>"."<file_format_name>"'

    To learn more about importing existing cloud resources, see Importing resources.

    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