Welcome to Pulumi Registry, your window into the cloud. Read the announcement.

Snowflake

v0.2.1 published on Monday, Sep 27, 2021 by Pulumi

FileFormat

Import

format is database name | schema name | file format name

 $ pulumi import snowflake:index/fileFormat:FileFormat example 'dbName|schemaName|fileFormatName'

Example Usage

using Pulumi;
using Snowflake = Pulumi.Snowflake;

class MyStack : Stack
{
    public MyStack()
    {
        var exampleFileFormat = new Snowflake.FileFormat("exampleFileFormat", new Snowflake.FileFormatArgs
        {
            Database = "EXAMPLE_DB",
            FormatType = "CSV",
            Schema = "EXAMPLE_SCHEMA",
        });
    }

}
package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := snowflake.NewFileFormat(ctx, "exampleFileFormat", &snowflake.FileFormatArgs{
			Database:   pulumi.String("EXAMPLE_DB"),
			FormatType: pulumi.String("CSV"),
			Schema:     pulumi.String("EXAMPLE_SCHEMA"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
import pulumi
import pulumi_snowflake as snowflake

example_file_format = snowflake.FileFormat("exampleFileFormat",
    database="EXAMPLE_DB",
    format_type="CSV",
    schema="EXAMPLE_SCHEMA")
import * as pulumi from "@pulumi/pulumi";
import * as snowflake from "@pulumi/snowflake";

const exampleFileFormat = new snowflake.FileFormat("example_file_format", {
    database: "EXAMPLE_DB",
    formatType: "CSV",
    schema: "EXAMPLE_SCHEMA",
});

Create a FileFormat Resource

new FileFormat(name: string, args: FileFormatArgs, opts?: CustomResourceOptions);
@overload
def FileFormat(resource_name: str,
               opts: Optional[ResourceOptions] = None,
               allow_duplicate: Optional[bool] = None,
               binary_as_text: Optional[bool] = None,
               binary_format: Optional[str] = None,
               comment: Optional[str] = None,
               compression: Optional[str] = None,
               database: Optional[str] = None,
               date_format: Optional[str] = None,
               disable_auto_convert: Optional[bool] = None,
               disable_snowflake_data: Optional[bool] = None,
               empty_field_as_null: Optional[bool] = None,
               enable_octal: Optional[bool] = None,
               encoding: Optional[str] = None,
               error_on_column_count_mismatch: Optional[bool] = None,
               escape: Optional[str] = None,
               escape_unenclosed_field: Optional[str] = None,
               field_delimiter: Optional[str] = None,
               field_optionally_enclosed_by: Optional[str] = None,
               file_extension: Optional[str] = None,
               format_type: Optional[str] = None,
               ignore_utf8_errors: Optional[bool] = None,
               name: Optional[str] = None,
               null_ifs: Optional[Sequence[str]] = None,
               preserve_space: Optional[bool] = None,
               record_delimiter: Optional[str] = None,
               replace_invalid_characters: Optional[bool] = None,
               schema: Optional[str] = None,
               skip_blank_lines: Optional[bool] = None,
               skip_byte_order_mark: Optional[bool] = None,
               skip_header: Optional[int] = None,
               strip_null_values: Optional[bool] = None,
               strip_outer_array: Optional[bool] = None,
               strip_outer_element: Optional[bool] = None,
               time_format: Optional[str] = None,
               timestamp_format: Optional[str] = None,
               trim_space: Optional[bool] = None,
               validate_utf8: Optional[bool] = None)
@overload
def FileFormat(resource_name: str,
               args: FileFormatArgs,
               opts: Optional[ResourceOptions] = None)
func NewFileFormat(ctx *Context, name string, args FileFormatArgs, opts ...ResourceOption) (*FileFormat, error)
public FileFormat(string name, FileFormatArgs args, CustomResourceOptions? opts = null)
name string
The unique name of the resource.
args FileFormatArgs
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 FileFormatArgs
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 FileFormatArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name string
The unique name of the resource.
args FileFormatArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.

FileFormat Resource Properties

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

Inputs

The FileFormat resource accepts the following input properties:

Database string
The database in which to create the file format.
FormatType string
Specifies the format of the input files (for data loading) or output files (for data unloading).
Schema string
The schema in which to create the file format.
AllowDuplicate bool
Boolean that specifies to allow duplicate object field names (only the last one will be preserved).
BinaryAsText bool
Boolean that specifies whether to interpret columns with no defined logical data type as UTF-8 text.
BinaryFormat string
Defines the encoding format for binary input or output.
Comment string
Specifies a comment for the file format.
Compression string
Specifies the current compression algorithm for the data file.
DateFormat string
Defines the format of date values in the data files (data loading) or table (data unloading).
DisableAutoConvert bool
Boolean that specifies whether the XML parser disables automatic conversion of numeric and Boolean values from text to native representation.
DisableSnowflakeData bool
Boolean that specifies whether the XML parser disables recognition of Snowflake semi-structured data tags.
EmptyFieldAsNull bool
Specifies whether to insert SQL NULL for empty fields in an input file, which are represented by two successive delimiters.
EnableOctal bool
Boolean that enables parsing of octal numbers.
Encoding string
String (constant) that specifies the character set of the source data when loading data into a table.
ErrorOnColumnCountMismatch bool
Boolean that specifies whether to generate a parsing error if the number of delimited columns (i.e. fields) in an input file does not match the number of columns in the corresponding table.
Escape string
Single character string used as the escape character for field values.
EscapeUnenclosedField string
Single character string used as the escape character for unenclosed field values only.
FieldDelimiter string
Specifies one or more singlebyte or multibyte characters that separate fields in an input file (data loading) or unloaded file (data unloading).
FieldOptionallyEnclosedBy string
Character used to enclose strings.
FileExtension string
Specifies the extension for files unloaded to a stage.
IgnoreUtf8Errors bool
Boolean that specifies whether UTF-8 encoding errors produce error conditions.
Name string
Specifies the identifier for the file format; must be unique for the database and schema in which the file format is created.
NullIfs List<string>
String used to convert to and from SQL NULL.
PreserveSpace bool
Boolean that specifies whether the XML parser preserves leading and trailing spaces in element content.
RecordDelimiter string
Specifies one or more singlebyte or multibyte characters that separate records in an input file (data loading) or unloaded file (data unloading).
ReplaceInvalidCharacters bool
Boolean that specifies whether to replace invalid UTF-8 characters with the Unicode replacement character (�).
SkipBlankLines bool
Boolean that specifies to skip any blank lines encountered in the data files.
SkipByteOrderMark bool
Boolean that specifies whether to skip the BOM (byte order mark), if present in a data file.
SkipHeader int
Number of lines at the start of the file to skip.
StripNullValues bool
Boolean that instructs the JSON parser to remove object fields or array elements containing null values.
StripOuterArray bool
Boolean that instructs the JSON parser to remove outer brackets.
StripOuterElement bool
Boolean that specifies whether the XML parser strips out the outer XML element, exposing 2nd level elements as separate documents.
TimeFormat string
Defines the format of time values in the data files (data loading) or table (data unloading).
TimestampFormat string
Defines the format of timestamp values in the data files (data loading) or table (data unloading).
TrimSpace bool
Boolean that specifies whether to remove white space from fields.
ValidateUtf8 bool
Boolean that specifies whether to validate UTF-8 character encoding in string column data.
Database string
The database in which to create the file format.
FormatType string
Specifies the format of the input files (for data loading) or output files (for data unloading).
Schema string
The schema in which to create the file format.
AllowDuplicate bool
Boolean that specifies to allow duplicate object field names (only the last one will be preserved).
BinaryAsText bool
Boolean that specifies whether to interpret columns with no defined logical data type as UTF-8 text.
BinaryFormat string
Defines the encoding format for binary input or output.
Comment string
Specifies a comment for the file format.
Compression string
Specifies the current compression algorithm for the data file.
DateFormat string
Defines the format of date values in the data files (data loading) or table (data unloading).
DisableAutoConvert bool
Boolean that specifies whether the XML parser disables automatic conversion of numeric and Boolean values from text to native representation.
DisableSnowflakeData bool
Boolean that specifies whether the XML parser disables recognition of Snowflake semi-structured data tags.
EmptyFieldAsNull bool
Specifies whether to insert SQL NULL for empty fields in an input file, which are represented by two successive delimiters.
EnableOctal bool
Boolean that enables parsing of octal numbers.
Encoding string
String (constant) that specifies the character set of the source data when loading data into a table.
ErrorOnColumnCountMismatch bool
Boolean that specifies whether to generate a parsing error if the number of delimited columns (i.e. fields) in an input file does not match the number of columns in the corresponding table.
Escape string
Single character string used as the escape character for field values.
EscapeUnenclosedField string
Single character string used as the escape character for unenclosed field values only.
FieldDelimiter string
Specifies one or more singlebyte or multibyte characters that separate fields in an input file (data loading) or unloaded file (data unloading).
FieldOptionallyEnclosedBy string
Character used to enclose strings.
FileExtension string
Specifies the extension for files unloaded to a stage.
IgnoreUtf8Errors bool
Boolean that specifies whether UTF-8 encoding errors produce error conditions.
Name string
Specifies the identifier for the file format; must be unique for the database and schema in which the file format is created.
NullIfs []string
String used to convert to and from SQL NULL.
PreserveSpace bool
Boolean that specifies whether the XML parser preserves leading and trailing spaces in element content.
RecordDelimiter string
Specifies one or more singlebyte or multibyte characters that separate records in an input file (data loading) or unloaded file (data unloading).
ReplaceInvalidCharacters bool
Boolean that specifies whether to replace invalid UTF-8 characters with the Unicode replacement character (�).
SkipBlankLines bool
Boolean that specifies to skip any blank lines encountered in the data files.
SkipByteOrderMark bool
Boolean that specifies whether to skip the BOM (byte order mark), if present in a data file.
SkipHeader int
Number of lines at the start of the file to skip.
StripNullValues bool
Boolean that instructs the JSON parser to remove object fields or array elements containing null values.
StripOuterArray bool
Boolean that instructs the JSON parser to remove outer brackets.
StripOuterElement bool
Boolean that specifies whether the XML parser strips out the outer XML element, exposing 2nd level elements as separate documents.
TimeFormat string
Defines the format of time values in the data files (data loading) or table (data unloading).
TimestampFormat string
Defines the format of timestamp values in the data files (data loading) or table (data unloading).
TrimSpace bool
Boolean that specifies whether to remove white space from fields.
ValidateUtf8 bool
Boolean that specifies whether to validate UTF-8 character encoding in string column data.
database string
The database in which to create the file format.
formatType string
Specifies the format of the input files (for data loading) or output files (for data unloading).
schema string
The schema in which to create the file format.
allowDuplicate boolean
Boolean that specifies to allow duplicate object field names (only the last one will be preserved).
binaryAsText boolean
Boolean that specifies whether to interpret columns with no defined logical data type as UTF-8 text.
binaryFormat string
Defines the encoding format for binary input or output.
comment string
Specifies a comment for the file format.
compression string
Specifies the current compression algorithm for the data file.
dateFormat string
Defines the format of date values in the data files (data loading) or table (data unloading).
disableAutoConvert boolean
Boolean that specifies whether the XML parser disables automatic conversion of numeric and Boolean values from text to native representation.
disableSnowflakeData boolean
Boolean that specifies whether the XML parser disables recognition of Snowflake semi-structured data tags.
emptyFieldAsNull boolean
Specifies whether to insert SQL NULL for empty fields in an input file, which are represented by two successive delimiters.
enableOctal boolean
Boolean that enables parsing of octal numbers.
encoding string
String (constant) that specifies the character set of the source data when loading data into a table.
errorOnColumnCountMismatch boolean
Boolean that specifies whether to generate a parsing error if the number of delimited columns (i.e. fields) in an input file does not match the number of columns in the corresponding table.
escape string
Single character string used as the escape character for field values.
escapeUnenclosedField string
Single character string used as the escape character for unenclosed field values only.
fieldDelimiter string
Specifies one or more singlebyte or multibyte characters that separate fields in an input file (data loading) or unloaded file (data unloading).
fieldOptionallyEnclosedBy string
Character used to enclose strings.
fileExtension string
Specifies the extension for files unloaded to a stage.
ignoreUtf8Errors boolean
Boolean that specifies whether UTF-8 encoding errors produce error conditions.
name string
Specifies the identifier for the file format; must be unique for the database and schema in which the file format is created.
nullIfs string[]
String used to convert to and from SQL NULL.
preserveSpace boolean
Boolean that specifies whether the XML parser preserves leading and trailing spaces in element content.
recordDelimiter string
Specifies one or more singlebyte or multibyte characters that separate records in an input file (data loading) or unloaded file (data unloading).
replaceInvalidCharacters boolean
Boolean that specifies whether to replace invalid UTF-8 characters with the Unicode replacement character (�).
skipBlankLines boolean
Boolean that specifies to skip any blank lines encountered in the data files.
skipByteOrderMark boolean
Boolean that specifies whether to skip the BOM (byte order mark), if present in a data file.
skipHeader number
Number of lines at the start of the file to skip.
stripNullValues boolean
Boolean that instructs the JSON parser to remove object fields or array elements containing null values.
stripOuterArray boolean
Boolean that instructs the JSON parser to remove outer brackets.
stripOuterElement boolean
Boolean that specifies whether the XML parser strips out the outer XML element, exposing 2nd level elements as separate documents.
timeFormat string
Defines the format of time values in the data files (data loading) or table (data unloading).
timestampFormat string
Defines the format of timestamp values in the data files (data loading) or table (data unloading).
trimSpace boolean
Boolean that specifies whether to remove white space from fields.
validateUtf8 boolean
Boolean that specifies whether to validate UTF-8 character encoding in string column data.
database str
The database in which to create the file format.
format_type str
Specifies the format of the input files (for data loading) or output files (for data unloading).
schema str
The schema in which to create the file format.
allow_duplicate bool
Boolean that specifies to allow duplicate object field names (only the last one will be preserved).
binary_as_text bool
Boolean that specifies whether to interpret columns with no defined logical data type as UTF-8 text.
binary_format str
Defines the encoding format for binary input or output.
comment str
Specifies a comment for the file format.
compression str
Specifies the current compression algorithm for the data file.
date_format str
Defines the format of date values in the data files (data loading) or table (data unloading).
disable_auto_convert bool
Boolean that specifies whether the XML parser disables automatic conversion of numeric and Boolean values from text to native representation.
disable_snowflake_data bool
Boolean that specifies whether the XML parser disables recognition of Snowflake semi-structured data tags.
empty_field_as_null bool
Specifies whether to insert SQL NULL for empty fields in an input file, which are represented by two successive delimiters.
enable_octal bool
Boolean that enables parsing of octal numbers.
encoding str
String (constant) that specifies the character set of the source data when loading data into a table.
error_on_column_count_mismatch bool
Boolean that specifies whether to generate a parsing error if the number of delimited columns (i.e. fields) in an input file does not match the number of columns in the corresponding table.
escape str
Single character string used as the escape character for field values.
escape_unenclosed_field str
Single character string used as the escape character for unenclosed field values only.
field_delimiter str
Specifies one or more singlebyte or multibyte characters that separate fields in an input file (data loading) or unloaded file (data unloading).
field_optionally_enclosed_by str
Character used to enclose strings.
file_extension str
Specifies the extension for files unloaded to a stage.
ignore_utf8_errors bool
Boolean that specifies whether UTF-8 encoding errors produce error conditions.
name str
Specifies the identifier for the file format; must be unique for the database and schema in which the file format is created.
null_ifs Sequence[str]
String used to convert to and from SQL NULL.
preserve_space bool
Boolean that specifies whether the XML parser preserves leading and trailing spaces in element content.
record_delimiter str
Specifies one or more singlebyte or multibyte characters that separate records in an input file (data loading) or unloaded file (data unloading).
replace_invalid_characters bool
Boolean that specifies whether to replace invalid UTF-8 characters with the Unicode replacement character (�).
skip_blank_lines bool
Boolean that specifies to skip any blank lines encountered in the data files.
skip_byte_order_mark bool
Boolean that specifies whether to skip the BOM (byte order mark), if present in a data file.
skip_header int
Number of lines at the start of the file to skip.
strip_null_values bool
Boolean that instructs the JSON parser to remove object fields or array elements containing null values.
strip_outer_array bool
Boolean that instructs the JSON parser to remove outer brackets.
strip_outer_element bool
Boolean that specifies whether the XML parser strips out the outer XML element, exposing 2nd level elements as separate documents.
time_format str
Defines the format of time values in the data files (data loading) or table (data unloading).
timestamp_format str
Defines the format of timestamp values in the data files (data loading) or table (data unloading).
trim_space bool
Boolean that specifies whether to remove white space from fields.
validate_utf8 bool
Boolean that specifies whether to validate UTF-8 character encoding in string column data.

Outputs

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

Id string
The provider-assigned unique ID for this managed resource.
Id string
The provider-assigned unique ID for this managed resource.
id string
The provider-assigned unique ID for this managed resource.
id str
The provider-assigned unique ID for this managed resource.

Look up an Existing FileFormat Resource

Get an existing FileFormat 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?: FileFormatState, opts?: CustomResourceOptions): FileFormat
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        allow_duplicate: Optional[bool] = None,
        binary_as_text: Optional[bool] = None,
        binary_format: Optional[str] = None,
        comment: Optional[str] = None,
        compression: Optional[str] = None,
        database: Optional[str] = None,
        date_format: Optional[str] = None,
        disable_auto_convert: Optional[bool] = None,
        disable_snowflake_data: Optional[bool] = None,
        empty_field_as_null: Optional[bool] = None,
        enable_octal: Optional[bool] = None,
        encoding: Optional[str] = None,
        error_on_column_count_mismatch: Optional[bool] = None,
        escape: Optional[str] = None,
        escape_unenclosed_field: Optional[str] = None,
        field_delimiter: Optional[str] = None,
        field_optionally_enclosed_by: Optional[str] = None,
        file_extension: Optional[str] = None,
        format_type: Optional[str] = None,
        ignore_utf8_errors: Optional[bool] = None,
        name: Optional[str] = None,
        null_ifs: Optional[Sequence[str]] = None,
        preserve_space: Optional[bool] = None,
        record_delimiter: Optional[str] = None,
        replace_invalid_characters: Optional[bool] = None,
        schema: Optional[str] = None,
        skip_blank_lines: Optional[bool] = None,
        skip_byte_order_mark: Optional[bool] = None,
        skip_header: Optional[int] = None,
        strip_null_values: Optional[bool] = None,
        strip_outer_array: Optional[bool] = None,
        strip_outer_element: Optional[bool] = None,
        time_format: Optional[str] = None,
        timestamp_format: Optional[str] = None,
        trim_space: Optional[bool] = None,
        validate_utf8: Optional[bool] = None) -> FileFormat
func GetFileFormat(ctx *Context, name string, id IDInput, state *FileFormatState, opts ...ResourceOption) (*FileFormat, error)
public static FileFormat Get(string name, Input<string> id, FileFormatState? state, CustomResourceOptions? opts = null)
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.

The following state arguments are supported:

AllowDuplicate bool
Boolean that specifies to allow duplicate object field names (only the last one will be preserved).
BinaryAsText bool
Boolean that specifies whether to interpret columns with no defined logical data type as UTF-8 text.
BinaryFormat string
Defines the encoding format for binary input or output.
Comment string
Specifies a comment for the file format.
Compression string
Specifies the current compression algorithm for the data file.
Database string
The database in which to create the file format.
DateFormat string
Defines the format of date values in the data files (data loading) or table (data unloading).
DisableAutoConvert bool
Boolean that specifies whether the XML parser disables automatic conversion of numeric and Boolean values from text to native representation.
DisableSnowflakeData bool
Boolean that specifies whether the XML parser disables recognition of Snowflake semi-structured data tags.
EmptyFieldAsNull bool
Specifies whether to insert SQL NULL for empty fields in an input file, which are represented by two successive delimiters.
EnableOctal bool
Boolean that enables parsing of octal numbers.
Encoding string
String (constant) that specifies the character set of the source data when loading data into a table.
ErrorOnColumnCountMismatch bool
Boolean that specifies whether to generate a parsing error if the number of delimited columns (i.e. fields) in an input file does not match the number of columns in the corresponding table.
Escape string
Single character string used as the escape character for field values.
EscapeUnenclosedField string
Single character string used as the escape character for unenclosed field values only.
FieldDelimiter string
Specifies one or more singlebyte or multibyte characters that separate fields in an input file (data loading) or unloaded file (data unloading).
FieldOptionallyEnclosedBy string
Character used to enclose strings.
FileExtension string
Specifies the extension for files unloaded to a stage.
FormatType string
Specifies the format of the input files (for data loading) or output files (for data unloading).
IgnoreUtf8Errors bool
Boolean that specifies whether UTF-8 encoding errors produce error conditions.
Name string
Specifies the identifier for the file format; must be unique for the database and schema in which the file format is created.
NullIfs List<string>
String used to convert to and from SQL NULL.
PreserveSpace bool
Boolean that specifies whether the XML parser preserves leading and trailing spaces in element content.
RecordDelimiter string
Specifies one or more singlebyte or multibyte characters that separate records in an input file (data loading) or unloaded file (data unloading).
ReplaceInvalidCharacters bool
Boolean that specifies whether to replace invalid UTF-8 characters with the Unicode replacement character (�).
Schema string
The schema in which to create the file format.
SkipBlankLines bool
Boolean that specifies to skip any blank lines encountered in the data files.
SkipByteOrderMark bool
Boolean that specifies whether to skip the BOM (byte order mark), if present in a data file.
SkipHeader int
Number of lines at the start of the file to skip.
StripNullValues bool
Boolean that instructs the JSON parser to remove object fields or array elements containing null values.
StripOuterArray bool
Boolean that instructs the JSON parser to remove outer brackets.
StripOuterElement bool
Boolean that specifies whether the XML parser strips out the outer XML element, exposing 2nd level elements as separate documents.
TimeFormat string
Defines the format of time values in the data files (data loading) or table (data unloading).
TimestampFormat string
Defines the format of timestamp values in the data files (data loading) or table (data unloading).
TrimSpace bool
Boolean that specifies whether to remove white space from fields.
ValidateUtf8 bool
Boolean that specifies whether to validate UTF-8 character encoding in string column data.
AllowDuplicate bool
Boolean that specifies to allow duplicate object field names (only the last one will be preserved).
BinaryAsText bool
Boolean that specifies whether to interpret columns with no defined logical data type as UTF-8 text.
BinaryFormat string
Defines the encoding format for binary input or output.
Comment string
Specifies a comment for the file format.
Compression string
Specifies the current compression algorithm for the data file.
Database string
The database in which to create the file format.
DateFormat string
Defines the format of date values in the data files (data loading) or table (data unloading).
DisableAutoConvert bool
Boolean that specifies whether the XML parser disables automatic conversion of numeric and Boolean values from text to native representation.
DisableSnowflakeData bool
Boolean that specifies whether the XML parser disables recognition of Snowflake semi-structured data tags.
EmptyFieldAsNull bool
Specifies whether to insert SQL NULL for empty fields in an input file, which are represented by two successive delimiters.
EnableOctal bool
Boolean that enables parsing of octal numbers.
Encoding string
String (constant) that specifies the character set of the source data when loading data into a table.
ErrorOnColumnCountMismatch bool
Boolean that specifies whether to generate a parsing error if the number of delimited columns (i.e. fields) in an input file does not match the number of columns in the corresponding table.
Escape string
Single character string used as the escape character for field values.
EscapeUnenclosedField string
Single character string used as the escape character for unenclosed field values only.
FieldDelimiter string
Specifies one or more singlebyte or multibyte characters that separate fields in an input file (data loading) or unloaded file (data unloading).
FieldOptionallyEnclosedBy string
Character used to enclose strings.
FileExtension string
Specifies the extension for files unloaded to a stage.
FormatType string
Specifies the format of the input files (for data loading) or output files (for data unloading).
IgnoreUtf8Errors bool
Boolean that specifies whether UTF-8 encoding errors produce error conditions.
Name string
Specifies the identifier for the file format; must be unique for the database and schema in which the file format is created.
NullIfs []string
String used to convert to and from SQL NULL.
PreserveSpace bool
Boolean that specifies whether the XML parser preserves leading and trailing spaces in element content.
RecordDelimiter string
Specifies one or more singlebyte or multibyte characters that separate records in an input file (data loading) or unloaded file (data unloading).
ReplaceInvalidCharacters bool
Boolean that specifies whether to replace invalid UTF-8 characters with the Unicode replacement character (�).
Schema string
The schema in which to create the file format.
SkipBlankLines bool
Boolean that specifies to skip any blank lines encountered in the data files.
SkipByteOrderMark bool
Boolean that specifies whether to skip the BOM (byte order mark), if present in a data file.
SkipHeader int
Number of lines at the start of the file to skip.
StripNullValues bool
Boolean that instructs the JSON parser to remove object fields or array elements containing null values.
StripOuterArray bool
Boolean that instructs the JSON parser to remove outer brackets.
StripOuterElement bool
Boolean that specifies whether the XML parser strips out the outer XML element, exposing 2nd level elements as separate documents.
TimeFormat string
Defines the format of time values in the data files (data loading) or table (data unloading).
TimestampFormat string
Defines the format of timestamp values in the data files (data loading) or table (data unloading).
TrimSpace bool
Boolean that specifies whether to remove white space from fields.
ValidateUtf8 bool
Boolean that specifies whether to validate UTF-8 character encoding in string column data.
allowDuplicate boolean
Boolean that specifies to allow duplicate object field names (only the last one will be preserved).
binaryAsText boolean
Boolean that specifies whether to interpret columns with no defined logical data type as UTF-8 text.
binaryFormat string
Defines the encoding format for binary input or output.
comment string
Specifies a comment for the file format.
compression string
Specifies the current compression algorithm for the data file.
database string
The database in which to create the file format.
dateFormat string
Defines the format of date values in the data files (data loading) or table (data unloading).
disableAutoConvert boolean
Boolean that specifies whether the XML parser disables automatic conversion of numeric and Boolean values from text to native representation.
disableSnowflakeData boolean
Boolean that specifies whether the XML parser disables recognition of Snowflake semi-structured data tags.
emptyFieldAsNull boolean
Specifies whether to insert SQL NULL for empty fields in an input file, which are represented by two successive delimiters.
enableOctal boolean
Boolean that enables parsing of octal numbers.
encoding string
String (constant) that specifies the character set of the source data when loading data into a table.
errorOnColumnCountMismatch boolean
Boolean that specifies whether to generate a parsing error if the number of delimited columns (i.e. fields) in an input file does not match the number of columns in the corresponding table.
escape string
Single character string used as the escape character for field values.
escapeUnenclosedField string
Single character string used as the escape character for unenclosed field values only.
fieldDelimiter string
Specifies one or more singlebyte or multibyte characters that separate fields in an input file (data loading) or unloaded file (data unloading).
fieldOptionallyEnclosedBy string
Character used to enclose strings.
fileExtension string
Specifies the extension for files unloaded to a stage.
formatType string
Specifies the format of the input files (for data loading) or output files (for data unloading).
ignoreUtf8Errors boolean
Boolean that specifies whether UTF-8 encoding errors produce error conditions.
name string
Specifies the identifier for the file format; must be unique for the database and schema in which the file format is created.
nullIfs string[]
String used to convert to and from SQL NULL.
preserveSpace boolean
Boolean that specifies whether the XML parser preserves leading and trailing spaces in element content.
recordDelimiter string
Specifies one or more singlebyte or multibyte characters that separate records in an input file (data loading) or unloaded file (data unloading).
replaceInvalidCharacters boolean
Boolean that specifies whether to replace invalid UTF-8 characters with the Unicode replacement character (�).
schema string
The schema in which to create the file format.
skipBlankLines boolean
Boolean that specifies to skip any blank lines encountered in the data files.
skipByteOrderMark boolean
Boolean that specifies whether to skip the BOM (byte order mark), if present in a data file.
skipHeader number
Number of lines at the start of the file to skip.
stripNullValues boolean
Boolean that instructs the JSON parser to remove object fields or array elements containing null values.
stripOuterArray boolean
Boolean that instructs the JSON parser to remove outer brackets.
stripOuterElement boolean
Boolean that specifies whether the XML parser strips out the outer XML element, exposing 2nd level elements as separate documents.
timeFormat string
Defines the format of time values in the data files (data loading) or table (data unloading).
timestampFormat string
Defines the format of timestamp values in the data files (data loading) or table (data unloading).
trimSpace boolean
Boolean that specifies whether to remove white space from fields.
validateUtf8 boolean
Boolean that specifies whether to validate UTF-8 character encoding in string column data.
allow_duplicate bool
Boolean that specifies to allow duplicate object field names (only the last one will be preserved).
binary_as_text bool
Boolean that specifies whether to interpret columns with no defined logical data type as UTF-8 text.
binary_format str
Defines the encoding format for binary input or output.
comment str
Specifies a comment for the file format.
compression str
Specifies the current compression algorithm for the data file.
database str
The database in which to create the file format.
date_format str
Defines the format of date values in the data files (data loading) or table (data unloading).
disable_auto_convert bool
Boolean that specifies whether the XML parser disables automatic conversion of numeric and Boolean values from text to native representation.
disable_snowflake_data bool
Boolean that specifies whether the XML parser disables recognition of Snowflake semi-structured data tags.
empty_field_as_null bool
Specifies whether to insert SQL NULL for empty fields in an input file, which are represented by two successive delimiters.
enable_octal bool
Boolean that enables parsing of octal numbers.
encoding str
String (constant) that specifies the character set of the source data when loading data into a table.
error_on_column_count_mismatch bool
Boolean that specifies whether to generate a parsing error if the number of delimited columns (i.e. fields) in an input file does not match the number of columns in the corresponding table.
escape str
Single character string used as the escape character for field values.
escape_unenclosed_field str
Single character string used as the escape character for unenclosed field values only.
field_delimiter str
Specifies one or more singlebyte or multibyte characters that separate fields in an input file (data loading) or unloaded file (data unloading).
field_optionally_enclosed_by str
Character used to enclose strings.
file_extension str
Specifies the extension for files unloaded to a stage.
format_type str
Specifies the format of the input files (for data loading) or output files (for data unloading).
ignore_utf8_errors bool
Boolean that specifies whether UTF-8 encoding errors produce error conditions.
name str
Specifies the identifier for the file format; must be unique for the database and schema in which the file format is created.
null_ifs Sequence[str]
String used to convert to and from SQL NULL.
preserve_space bool
Boolean that specifies whether the XML parser preserves leading and trailing spaces in element content.
record_delimiter str
Specifies one or more singlebyte or multibyte characters that separate records in an input file (data loading) or unloaded file (data unloading).
replace_invalid_characters bool
Boolean that specifies whether to replace invalid UTF-8 characters with the Unicode replacement character (�).
schema str
The schema in which to create the file format.
skip_blank_lines bool
Boolean that specifies to skip any blank lines encountered in the data files.
skip_byte_order_mark bool
Boolean that specifies whether to skip the BOM (byte order mark), if present in a data file.
skip_header int
Number of lines at the start of the file to skip.
strip_null_values bool
Boolean that instructs the JSON parser to remove object fields or array elements containing null values.
strip_outer_array bool
Boolean that instructs the JSON parser to remove outer brackets.
strip_outer_element bool
Boolean that specifies whether the XML parser strips out the outer XML element, exposing 2nd level elements as separate documents.
time_format str
Defines the format of time values in the data files (data loading) or table (data unloading).
timestamp_format str
Defines the format of timestamp values in the data files (data loading) or table (data unloading).
trim_space bool
Boolean that specifies whether to remove white space from fields.
validate_utf8 bool
Boolean that specifies whether to validate UTF-8 character encoding in string column data.

Package Details

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