published on Friday, Jul 31, 2026 by Pulumi
published on Friday, Jul 31, 2026 by Pulumi
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
previewFeaturesEnabledfield 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 FORMAToutput fornullIfset to an empty list and fornullIfset to a list with a single empty string. Because of that, the provider cannot detect an external change between these two values, anddescribe_output.null_ifis empty in both cases.
Resource used to manage CSV 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.FileFormatCsv("basic", {
database: "database_name",
schema: "schema_name",
name: "file_format_name",
});
//# Complete (with every optional set)
const complete = new snowflake.FileFormatCsv("complete", {
database: "database_name",
schema: "schema_name",
name: "file_format_name",
compression: "GZIP",
recordDelimiter: ";",
fieldDelimiter: "|",
multiLine: "true",
fileExtension: ".csv",
skipHeader: 1,
skipBlankLines: "true",
dateFormat: "YYYY-MM-DD",
timeFormat: "HH24:MI:SS",
timestampFormat: "YYYY-MM-DD HH24:MI:SS.FF3",
binaryFormat: "BASE64",
escape: "NONE",
escapeUnenclosedField: "NONE",
trimSpace: "true",
fieldOptionallyEnclosedBy: "\"",
nullIfs: [
"NULL",
"",
],
errorOnColumnCountMismatch: "false",
replaceInvalidCharacters: "false",
emptyFieldAsNull: "true",
skipByteOrderMark: "true",
encoding: "UTF8",
comment: "My CSV file format",
});
import pulumi
import pulumi_snowflake as snowflake
## Minimal
basic = snowflake.FileFormatCsv("basic",
database="database_name",
schema="schema_name",
name="file_format_name")
## Complete (with every optional set)
complete = snowflake.FileFormatCsv("complete",
database="database_name",
schema="schema_name",
name="file_format_name",
compression="GZIP",
record_delimiter=";",
field_delimiter="|",
multi_line="true",
file_extension=".csv",
skip_header=1,
skip_blank_lines="true",
date_format="YYYY-MM-DD",
time_format="HH24:MI:SS",
timestamp_format="YYYY-MM-DD HH24:MI:SS.FF3",
binary_format="BASE64",
escape="NONE",
escape_unenclosed_field="NONE",
trim_space="true",
field_optionally_enclosed_by="\"",
null_ifs=[
"NULL",
"",
],
error_on_column_count_mismatch="false",
replace_invalid_characters="false",
empty_field_as_null="true",
skip_byte_order_mark="true",
encoding="UTF8",
comment="My CSV 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.NewFileFormatCsv(ctx, "basic", &snowflake.FileFormatCsvArgs{
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.NewFileFormatCsv(ctx, "complete", &snowflake.FileFormatCsvArgs{
Database: pulumi.String("database_name"),
Schema: pulumi.String("schema_name"),
Name: pulumi.String("file_format_name"),
Compression: pulumi.String("GZIP"),
RecordDelimiter: pulumi.String(";"),
FieldDelimiter: pulumi.String("|"),
MultiLine: pulumi.String("true"),
FileExtension: pulumi.String(".csv"),
SkipHeader: pulumi.Int(1),
SkipBlankLines: pulumi.String("true"),
DateFormat: pulumi.String("YYYY-MM-DD"),
TimeFormat: pulumi.String("HH24:MI:SS"),
TimestampFormat: pulumi.String("YYYY-MM-DD HH24:MI:SS.FF3"),
BinaryFormat: pulumi.String("BASE64"),
Escape: pulumi.String("NONE"),
EscapeUnenclosedField: pulumi.String("NONE"),
TrimSpace: pulumi.String("true"),
FieldOptionallyEnclosedBy: pulumi.String("\""),
NullIfs: pulumi.StringArray{
pulumi.String("NULL"),
pulumi.String(""),
},
ErrorOnColumnCountMismatch: pulumi.String("false"),
ReplaceInvalidCharacters: pulumi.String("false"),
EmptyFieldAsNull: pulumi.String("true"),
SkipByteOrderMark: pulumi.String("true"),
Encoding: pulumi.String("UTF8"),
Comment: pulumi.String("My CSV 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.FileFormatCsv("basic", new()
{
Database = "database_name",
Schema = "schema_name",
Name = "file_format_name",
});
//# Complete (with every optional set)
var complete = new Snowflake.FileFormatCsv("complete", new()
{
Database = "database_name",
Schema = "schema_name",
Name = "file_format_name",
Compression = "GZIP",
RecordDelimiter = ";",
FieldDelimiter = "|",
MultiLine = "true",
FileExtension = ".csv",
SkipHeader = 1,
SkipBlankLines = "true",
DateFormat = "YYYY-MM-DD",
TimeFormat = "HH24:MI:SS",
TimestampFormat = "YYYY-MM-DD HH24:MI:SS.FF3",
BinaryFormat = "BASE64",
Escape = "NONE",
EscapeUnenclosedField = "NONE",
TrimSpace = "true",
FieldOptionallyEnclosedBy = "\"",
NullIfs = new[]
{
"NULL",
"",
},
ErrorOnColumnCountMismatch = "false",
ReplaceInvalidCharacters = "false",
EmptyFieldAsNull = "true",
SkipByteOrderMark = "true",
Encoding = "UTF8",
Comment = "My CSV file format",
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.snowflake.FileFormatCsv;
import com.pulumi.snowflake.FileFormatCsvArgs;
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 FileFormatCsv("basic", FileFormatCsvArgs.builder()
.database("database_name")
.schema("schema_name")
.name("file_format_name")
.build());
//# Complete (with every optional set)
var complete = new FileFormatCsv("complete", FileFormatCsvArgs.builder()
.database("database_name")
.schema("schema_name")
.name("file_format_name")
.compression("GZIP")
.recordDelimiter(";")
.fieldDelimiter("|")
.multiLine("true")
.fileExtension(".csv")
.skipHeader(1)
.skipBlankLines("true")
.dateFormat("YYYY-MM-DD")
.timeFormat("HH24:MI:SS")
.timestampFormat("YYYY-MM-DD HH24:MI:SS.FF3")
.binaryFormat("BASE64")
.escape("NONE")
.escapeUnenclosedField("NONE")
.trimSpace("true")
.fieldOptionallyEnclosedBy("\"")
.nullIfs(
"NULL",
"")
.errorOnColumnCountMismatch("false")
.replaceInvalidCharacters("false")
.emptyFieldAsNull("true")
.skipByteOrderMark("true")
.encoding("UTF8")
.comment("My CSV file format")
.build());
}
}
resources:
## Minimal
basic:
type: snowflake:FileFormatCsv
properties:
database: database_name
schema: schema_name
name: file_format_name
## Complete (with every optional set)
complete:
type: snowflake:FileFormatCsv
properties:
database: database_name
schema: schema_name
name: file_format_name
compression: GZIP
recordDelimiter: ;
fieldDelimiter: '|'
multiLine: 'true'
fileExtension: .csv
skipHeader: 1
skipBlankLines: 'true'
dateFormat: YYYY-MM-DD
timeFormat: HH24:MI:SS
timestampFormat: YYYY-MM-DD HH24:MI:SS.FF3
binaryFormat: BASE64
escape: NONE
escapeUnenclosedField: NONE
trimSpace: 'true'
fieldOptionallyEnclosedBy: '"'
nullIfs:
- NULL
- ""
errorOnColumnCountMismatch: 'false'
replaceInvalidCharacters: 'false'
emptyFieldAsNull: 'true'
skipByteOrderMark: 'true'
encoding: UTF8
comment: My CSV file format
pulumi {
required_providers {
snowflake = {
source = "pulumi/snowflake"
}
}
}
## Minimal
resource "snowflake_fileformatcsv" "basic" {
database = "database_name"
schema = "schema_name"
name = "file_format_name"
}
## Complete (with every optional set)
resource "snowflake_fileformatcsv" "complete" {
database = "database_name"
schema = "schema_name"
name = "file_format_name"
compression = "GZIP"
record_delimiter = ";"
field_delimiter = "|"
multi_line = "true"
file_extension = ".csv"
skip_header = 1
skip_blank_lines = "true"
date_format = "YYYY-MM-DD"
time_format = "HH24:MI:SS"
timestamp_format = "YYYY-MM-DD HH24:MI:SS.FF3"
binary_format = "BASE64"
escape = "NONE"
escape_unenclosed_field = "NONE"
trim_space = "true"
field_optionally_enclosed_by = "\""
null_ifs = ["NULL", ""]
error_on_column_count_mismatch = "false"
replace_invalid_characters = "false"
empty_field_as_null = "true"
skip_byte_order_mark = "true"
encoding = "UTF8"
comment = "My CSV file format"
}
Note If a field has a default value, it is shown next to the type in the schema.
Create FileFormatCsv Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new FileFormatCsv(name: string, args: FileFormatCsvArgs, opts?: CustomResourceOptions);@overload
def FileFormatCsv(resource_name: str,
args: FileFormatCsvArgs,
opts: Optional[ResourceOptions] = None)
@overload
def FileFormatCsv(resource_name: str,
opts: Optional[ResourceOptions] = None,
database: Optional[str] = None,
schema: Optional[str] = None,
file_extension: Optional[str] = None,
escape: Optional[str] = None,
date_format: Optional[str] = None,
empty_field_as_null: Optional[str] = None,
encoding: Optional[str] = None,
error_on_column_count_mismatch: Optional[str] = None,
multi_line: Optional[str] = None,
escape_unenclosed_field: Optional[str] = None,
field_delimiter: Optional[str] = None,
field_optionally_enclosed_by: Optional[str] = None,
compression: Optional[str] = None,
binary_format: Optional[str] = None,
replace_invalid_characters: Optional[str] = None,
null_ifs: Optional[Sequence[str]] = None,
parse_header: Optional[str] = None,
record_delimiter: Optional[str] = None,
name: Optional[str] = None,
comment: Optional[str] = None,
skip_blank_lines: Optional[str] = None,
skip_byte_order_mark: Optional[str] = None,
skip_header: Optional[int] = None,
time_format: Optional[str] = None,
timestamp_format: Optional[str] = None,
trim_space: Optional[str] = None)func NewFileFormatCsv(ctx *Context, name string, args FileFormatCsvArgs, opts ...ResourceOption) (*FileFormatCsv, error)public FileFormatCsv(string name, FileFormatCsvArgs args, CustomResourceOptions? opts = null)
public FileFormatCsv(String name, FileFormatCsvArgs args)
public FileFormatCsv(String name, FileFormatCsvArgs args, CustomResourceOptions options)
type: snowflake:FileFormatCsv
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
resource "snowflake_file_format_csv" "name" {
# resource properties
}Parameters
- name string
- The unique name of the resource.
- args FileFormatCsvArgs
- 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 FileFormatCsvArgs
- 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 FileFormatCsvArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args FileFormatCsvArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args FileFormatCsvArgs
- 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 fileFormatCsvResource = new Snowflake.FileFormatCsv("fileFormatCsvResource", new()
{
Database = "string",
Schema = "string",
FileExtension = "string",
Escape = "string",
DateFormat = "string",
EmptyFieldAsNull = "string",
Encoding = "string",
ErrorOnColumnCountMismatch = "string",
MultiLine = "string",
EscapeUnenclosedField = "string",
FieldDelimiter = "string",
FieldOptionallyEnclosedBy = "string",
Compression = "string",
BinaryFormat = "string",
ReplaceInvalidCharacters = "string",
NullIfs = new[]
{
"string",
},
ParseHeader = "string",
RecordDelimiter = "string",
Name = "string",
Comment = "string",
SkipBlankLines = "string",
SkipByteOrderMark = "string",
SkipHeader = 0,
TimeFormat = "string",
TimestampFormat = "string",
TrimSpace = "string",
});
example, err := snowflake.NewFileFormatCsv(ctx, "fileFormatCsvResource", &snowflake.FileFormatCsvArgs{
Database: pulumi.String("string"),
Schema: pulumi.String("string"),
FileExtension: pulumi.String("string"),
Escape: pulumi.String("string"),
DateFormat: pulumi.String("string"),
EmptyFieldAsNull: pulumi.String("string"),
Encoding: pulumi.String("string"),
ErrorOnColumnCountMismatch: pulumi.String("string"),
MultiLine: pulumi.String("string"),
EscapeUnenclosedField: pulumi.String("string"),
FieldDelimiter: pulumi.String("string"),
FieldOptionallyEnclosedBy: pulumi.String("string"),
Compression: pulumi.String("string"),
BinaryFormat: pulumi.String("string"),
ReplaceInvalidCharacters: pulumi.String("string"),
NullIfs: pulumi.StringArray{
pulumi.String("string"),
},
ParseHeader: pulumi.String("string"),
RecordDelimiter: pulumi.String("string"),
Name: pulumi.String("string"),
Comment: pulumi.String("string"),
SkipBlankLines: pulumi.String("string"),
SkipByteOrderMark: pulumi.String("string"),
SkipHeader: pulumi.Int(0),
TimeFormat: pulumi.String("string"),
TimestampFormat: pulumi.String("string"),
TrimSpace: pulumi.String("string"),
})
resource "snowflake_file_format_csv" "fileFormatCsvResource" {
lifecycle {
create_before_destroy = true
}
database = "string"
schema = "string"
file_extension = "string"
escape = "string"
date_format = "string"
empty_field_as_null = "string"
encoding = "string"
error_on_column_count_mismatch = "string"
multi_line = "string"
escape_unenclosed_field = "string"
field_delimiter = "string"
field_optionally_enclosed_by = "string"
compression = "string"
binary_format = "string"
replace_invalid_characters = "string"
null_ifs = ["string"]
parse_header = "string"
record_delimiter = "string"
name = "string"
comment = "string"
skip_blank_lines = "string"
skip_byte_order_mark = "string"
skip_header = 0
time_format = "string"
timestamp_format = "string"
trim_space = "string"
}
var fileFormatCsvResource = new FileFormatCsv("fileFormatCsvResource", FileFormatCsvArgs.builder()
.database("string")
.schema("string")
.fileExtension("string")
.escape("string")
.dateFormat("string")
.emptyFieldAsNull("string")
.encoding("string")
.errorOnColumnCountMismatch("string")
.multiLine("string")
.escapeUnenclosedField("string")
.fieldDelimiter("string")
.fieldOptionallyEnclosedBy("string")
.compression("string")
.binaryFormat("string")
.replaceInvalidCharacters("string")
.nullIfs("string")
.parseHeader("string")
.recordDelimiter("string")
.name("string")
.comment("string")
.skipBlankLines("string")
.skipByteOrderMark("string")
.skipHeader(0)
.timeFormat("string")
.timestampFormat("string")
.trimSpace("string")
.build());
file_format_csv_resource = snowflake.FileFormatCsv("fileFormatCsvResource",
database="string",
schema="string",
file_extension="string",
escape="string",
date_format="string",
empty_field_as_null="string",
encoding="string",
error_on_column_count_mismatch="string",
multi_line="string",
escape_unenclosed_field="string",
field_delimiter="string",
field_optionally_enclosed_by="string",
compression="string",
binary_format="string",
replace_invalid_characters="string",
null_ifs=["string"],
parse_header="string",
record_delimiter="string",
name="string",
comment="string",
skip_blank_lines="string",
skip_byte_order_mark="string",
skip_header=0,
time_format="string",
timestamp_format="string",
trim_space="string")
const fileFormatCsvResource = new snowflake.FileFormatCsv("fileFormatCsvResource", {
database: "string",
schema: "string",
fileExtension: "string",
escape: "string",
dateFormat: "string",
emptyFieldAsNull: "string",
encoding: "string",
errorOnColumnCountMismatch: "string",
multiLine: "string",
escapeUnenclosedField: "string",
fieldDelimiter: "string",
fieldOptionallyEnclosedBy: "string",
compression: "string",
binaryFormat: "string",
replaceInvalidCharacters: "string",
nullIfs: ["string"],
parseHeader: "string",
recordDelimiter: "string",
name: "string",
comment: "string",
skipBlankLines: "string",
skipByteOrderMark: "string",
skipHeader: 0,
timeFormat: "string",
timestampFormat: "string",
trimSpace: "string",
});
type: snowflake:FileFormatCsv
properties:
binaryFormat: string
comment: string
compression: string
database: string
dateFormat: string
emptyFieldAsNull: string
encoding: string
errorOnColumnCountMismatch: string
escape: string
escapeUnenclosedField: string
fieldDelimiter: string
fieldOptionallyEnclosedBy: string
fileExtension: string
multiLine: string
name: string
nullIfs:
- string
parseHeader: string
recordDelimiter: string
replaceInvalidCharacters: string
schema: string
skipBlankLines: string
skipByteOrderMark: string
skipHeader: 0
timeFormat: string
timestampFormat: string
trimSpace: string
FileFormatCsv 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 FileFormatCsv 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:
|,.,". - Binary
Format string - Defines the encoding format for binary input or output. Valid values:
HEX|BASE64|UTF8. - Comment string
- Specifies a comment for the file format.
- Compression string
- Specifies the compression format. Valid values:
AUTO|GZIP|BZ2|BROTLI|ZSTD|DEFLATE|RAW_DEFLATE|NONE. - Date
Format string - Defines the format of date values in the data files. Use
AUTOto have Snowflake auto-detect the format. - Empty
Field stringAs Null - (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (
default)) Boolean that specifies whether to insert SQL NULL for empty fields in an input file. 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. - Encoding string
- Specifies the character set of the source data when loading data into a table. Valid values:
BIG5|EUCJP|EUCKR|GB18030|IBM420|IBM424|ISO2022CN|ISO2022JP|ISO2022KR|ISO88591|ISO88592|ISO88595|ISO88596|ISO88597|ISO88598|ISO88599|ISO885915|KOI8R|SHIFTJIS|UTF8|UTF16|UTF16BE|UTF16LE|UTF32|UTF32BE|UTF32LE|WINDOWS1250|WINDOWS1251|WINDOWS1252|WINDOWS1253|WINDOWS1254|WINDOWS1255|WINDOWS1256. - Error
On stringColumn Count Mismatch - (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (
default)) Boolean that specifies whether to generate a parsing error if the number of delimited columns in an input file does not match the number of columns in the corresponding table. 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. - Escape string
- Single character string used as the escape character for field values. Use
NONEto specify no escape character. NOTE: This value may be not imported properly from Snowflake. Snowflake returns escaped values. - Escape
Unenclosed stringField - Single character string used as the escape character for unenclosed field values only. Use
NONEto specify no escape character. NOTE: This value may be not imported properly from Snowflake. Snowflake returns escaped values. - Field
Delimiter string - One or more singlebyte or multibyte characters that separate fields in an input file. Use
NONEto specify no delimiter. - Field
Optionally stringEnclosed By - Character used to enclose strings. Use
NONEto specify no enclosure character. - File
Extension string - Specifies the extension for files unloaded to a stage.
- Multi
Line string - (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (
default)) Boolean that specifies whether to parse CSV files containing multiple records on a single line. 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. - 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.
- Parse
Header string - (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (
default)) Boolean that specifies whether to use the first row headers in the data files to determine column names. 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. - Record
Delimiter string - One or more singlebyte or multibyte characters that separate records in an input file. Use
NONEto specify no delimiter. - Replace
Invalid stringCharacters - (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. - Skip
Blank stringLines - (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (
default)) Boolean that specifies to skip any blank lines encountered in the data files. 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. - Skip
Byte stringOrder Mark - (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (
default)) Boolean that specifies whether to skip the BOM (byte order mark) if present in a data file. 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. - Skip
Header int - (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (
-1)) Number of lines at the start of the file to skip. - Time
Format string - Defines the format of time values in the data files. Use
AUTOto have Snowflake auto-detect the format. - Timestamp
Format string - Defines the format of timestamp values in the data files. Use
AUTOto have Snowflake auto-detect the 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.
- 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:
|,.,". - Binary
Format string - Defines the encoding format for binary input or output. Valid values:
HEX|BASE64|UTF8. - Comment string
- Specifies a comment for the file format.
- Compression string
- Specifies the compression format. Valid values:
AUTO|GZIP|BZ2|BROTLI|ZSTD|DEFLATE|RAW_DEFLATE|NONE. - Date
Format string - Defines the format of date values in the data files. Use
AUTOto have Snowflake auto-detect the format. - Empty
Field stringAs Null - (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (
default)) Boolean that specifies whether to insert SQL NULL for empty fields in an input file. 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. - Encoding string
- Specifies the character set of the source data when loading data into a table. Valid values:
BIG5|EUCJP|EUCKR|GB18030|IBM420|IBM424|ISO2022CN|ISO2022JP|ISO2022KR|ISO88591|ISO88592|ISO88595|ISO88596|ISO88597|ISO88598|ISO88599|ISO885915|KOI8R|SHIFTJIS|UTF8|UTF16|UTF16BE|UTF16LE|UTF32|UTF32BE|UTF32LE|WINDOWS1250|WINDOWS1251|WINDOWS1252|WINDOWS1253|WINDOWS1254|WINDOWS1255|WINDOWS1256. - Error
On stringColumn Count Mismatch - (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (
default)) Boolean that specifies whether to generate a parsing error if the number of delimited columns in an input file does not match the number of columns in the corresponding table. 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. - Escape string
- Single character string used as the escape character for field values. Use
NONEto specify no escape character. NOTE: This value may be not imported properly from Snowflake. Snowflake returns escaped values. - Escape
Unenclosed stringField - Single character string used as the escape character for unenclosed field values only. Use
NONEto specify no escape character. NOTE: This value may be not imported properly from Snowflake. Snowflake returns escaped values. - Field
Delimiter string - One or more singlebyte or multibyte characters that separate fields in an input file. Use
NONEto specify no delimiter. - Field
Optionally stringEnclosed By - Character used to enclose strings. Use
NONEto specify no enclosure character. - File
Extension string - Specifies the extension for files unloaded to a stage.
- Multi
Line string - (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (
default)) Boolean that specifies whether to parse CSV files containing multiple records on a single line. 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. - 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 []string - String used to convert to and from SQL NULL.
- Parse
Header string - (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (
default)) Boolean that specifies whether to use the first row headers in the data files to determine column names. 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. - Record
Delimiter string - One or more singlebyte or multibyte characters that separate records in an input file. Use
NONEto specify no delimiter. - Replace
Invalid stringCharacters - (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. - Skip
Blank stringLines - (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (
default)) Boolean that specifies to skip any blank lines encountered in the data files. 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. - Skip
Byte stringOrder Mark - (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (
default)) Boolean that specifies whether to skip the BOM (byte order mark) if present in a data file. 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. - Skip
Header int - (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (
-1)) Number of lines at the start of the file to skip. - Time
Format string - Defines the format of time values in the data files. Use
AUTOto have Snowflake auto-detect the format. - Timestamp
Format string - Defines the format of timestamp values in the data files. Use
AUTOto have Snowflake auto-detect the 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.
- 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:
|,.,". - binary_
format string - Defines the encoding format for binary input or output. Valid values:
HEX|BASE64|UTF8. - comment string
- Specifies a comment for the file format.
- compression string
- Specifies the compression format. Valid values:
AUTO|GZIP|BZ2|BROTLI|ZSTD|DEFLATE|RAW_DEFLATE|NONE. - date_
format string - Defines the format of date values in the data files. Use
AUTOto have Snowflake auto-detect the format. - empty_
field_ stringas_ null - (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (
default)) Boolean that specifies whether to insert SQL NULL for empty fields in an input file. 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. - encoding string
- Specifies the character set of the source data when loading data into a table. Valid values:
BIG5|EUCJP|EUCKR|GB18030|IBM420|IBM424|ISO2022CN|ISO2022JP|ISO2022KR|ISO88591|ISO88592|ISO88595|ISO88596|ISO88597|ISO88598|ISO88599|ISO885915|KOI8R|SHIFTJIS|UTF8|UTF16|UTF16BE|UTF16LE|UTF32|UTF32BE|UTF32LE|WINDOWS1250|WINDOWS1251|WINDOWS1252|WINDOWS1253|WINDOWS1254|WINDOWS1255|WINDOWS1256. - error_
on_ stringcolumn_ count_ mismatch - (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (
default)) Boolean that specifies whether to generate a parsing error if the number of delimited columns in an input file does not match the number of columns in the corresponding table. 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. - escape string
- Single character string used as the escape character for field values. Use
NONEto specify no escape character. NOTE: This value may be not imported properly from Snowflake. Snowflake returns escaped values. - escape_
unenclosed_ stringfield - Single character string used as the escape character for unenclosed field values only. Use
NONEto specify no escape character. NOTE: This value may be not imported properly from Snowflake. Snowflake returns escaped values. - field_
delimiter string - One or more singlebyte or multibyte characters that separate fields in an input file. Use
NONEto specify no delimiter. - field_
optionally_ stringenclosed_ by - Character used to enclose strings. Use
NONEto specify no enclosure character. - file_
extension string - Specifies the extension for files unloaded to a stage.
- multi_
line string - (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (
default)) Boolean that specifies whether to parse CSV files containing multiple records on a single line. 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. - 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.
- parse_
header string - (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (
default)) Boolean that specifies whether to use the first row headers in the data files to determine column names. 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. - record_
delimiter string - One or more singlebyte or multibyte characters that separate records in an input file. Use
NONEto specify no delimiter. - replace_
invalid_ stringcharacters - (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. - skip_
blank_ stringlines - (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (
default)) Boolean that specifies to skip any blank lines encountered in the data files. 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. - skip_
byte_ stringorder_ mark - (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (
default)) Boolean that specifies whether to skip the BOM (byte order mark) if present in a data file. 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. - skip_
header number - (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (
-1)) Number of lines at the start of the file to skip. - time_
format string - Defines the format of time values in the data files. Use
AUTOto have Snowflake auto-detect the format. - timestamp_
format string - Defines the format of timestamp values in the data files. Use
AUTOto have Snowflake auto-detect the 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.
- 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:
|,.,". - binary
Format String - Defines the encoding format for binary input or output. Valid values:
HEX|BASE64|UTF8. - comment String
- Specifies a comment for the file format.
- compression String
- Specifies the compression format. Valid values:
AUTO|GZIP|BZ2|BROTLI|ZSTD|DEFLATE|RAW_DEFLATE|NONE. - date
Format String - Defines the format of date values in the data files. Use
AUTOto have Snowflake auto-detect the format. - empty
Field StringAs Null - (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (
default)) Boolean that specifies whether to insert SQL NULL for empty fields in an input file. 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. - encoding String
- Specifies the character set of the source data when loading data into a table. Valid values:
BIG5|EUCJP|EUCKR|GB18030|IBM420|IBM424|ISO2022CN|ISO2022JP|ISO2022KR|ISO88591|ISO88592|ISO88595|ISO88596|ISO88597|ISO88598|ISO88599|ISO885915|KOI8R|SHIFTJIS|UTF8|UTF16|UTF16BE|UTF16LE|UTF32|UTF32BE|UTF32LE|WINDOWS1250|WINDOWS1251|WINDOWS1252|WINDOWS1253|WINDOWS1254|WINDOWS1255|WINDOWS1256. - error
On StringColumn Count Mismatch - (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (
default)) Boolean that specifies whether to generate a parsing error if the number of delimited columns in an input file does not match the number of columns in the corresponding table. 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. - escape String
- Single character string used as the escape character for field values. Use
NONEto specify no escape character. NOTE: This value may be not imported properly from Snowflake. Snowflake returns escaped values. - escape
Unenclosed StringField - Single character string used as the escape character for unenclosed field values only. Use
NONEto specify no escape character. NOTE: This value may be not imported properly from Snowflake. Snowflake returns escaped values. - field
Delimiter String - One or more singlebyte or multibyte characters that separate fields in an input file. Use
NONEto specify no delimiter. - field
Optionally StringEnclosed By - Character used to enclose strings. Use
NONEto specify no enclosure character. - file
Extension String - Specifies the extension for files unloaded to a stage.
- multi
Line String - (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (
default)) Boolean that specifies whether to parse CSV files containing multiple records on a single line. 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. - 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.
- parse
Header String - (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (
default)) Boolean that specifies whether to use the first row headers in the data files to determine column names. 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. - record
Delimiter String - One or more singlebyte or multibyte characters that separate records in an input file. Use
NONEto specify no delimiter. - replace
Invalid StringCharacters - (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. - skip
Blank StringLines - (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (
default)) Boolean that specifies to skip any blank lines encountered in the data files. 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. - skip
Byte StringOrder Mark - (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (
default)) Boolean that specifies whether to skip the BOM (byte order mark) if present in a data file. 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. - skip
Header Integer - (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (
-1)) Number of lines at the start of the file to skip. - time
Format String - Defines the format of time values in the data files. Use
AUTOto have Snowflake auto-detect the format. - timestamp
Format String - Defines the format of timestamp values in the data files. Use
AUTOto have Snowflake auto-detect the 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.
- 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:
|,.,". - binary
Format string - Defines the encoding format for binary input or output. Valid values:
HEX|BASE64|UTF8. - comment string
- Specifies a comment for the file format.
- compression string
- Specifies the compression format. Valid values:
AUTO|GZIP|BZ2|BROTLI|ZSTD|DEFLATE|RAW_DEFLATE|NONE. - date
Format string - Defines the format of date values in the data files. Use
AUTOto have Snowflake auto-detect the format. - empty
Field stringAs Null - (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (
default)) Boolean that specifies whether to insert SQL NULL for empty fields in an input file. 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. - encoding string
- Specifies the character set of the source data when loading data into a table. Valid values:
BIG5|EUCJP|EUCKR|GB18030|IBM420|IBM424|ISO2022CN|ISO2022JP|ISO2022KR|ISO88591|ISO88592|ISO88595|ISO88596|ISO88597|ISO88598|ISO88599|ISO885915|KOI8R|SHIFTJIS|UTF8|UTF16|UTF16BE|UTF16LE|UTF32|UTF32BE|UTF32LE|WINDOWS1250|WINDOWS1251|WINDOWS1252|WINDOWS1253|WINDOWS1254|WINDOWS1255|WINDOWS1256. - error
On stringColumn Count Mismatch - (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (
default)) Boolean that specifies whether to generate a parsing error if the number of delimited columns in an input file does not match the number of columns in the corresponding table. 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. - escape string
- Single character string used as the escape character for field values. Use
NONEto specify no escape character. NOTE: This value may be not imported properly from Snowflake. Snowflake returns escaped values. - escape
Unenclosed stringField - Single character string used as the escape character for unenclosed field values only. Use
NONEto specify no escape character. NOTE: This value may be not imported properly from Snowflake. Snowflake returns escaped values. - field
Delimiter string - One or more singlebyte or multibyte characters that separate fields in an input file. Use
NONEto specify no delimiter. - field
Optionally stringEnclosed By - Character used to enclose strings. Use
NONEto specify no enclosure character. - file
Extension string - Specifies the extension for files unloaded to a stage.
- multi
Line string - (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (
default)) Boolean that specifies whether to parse CSV files containing multiple records on a single line. 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. - 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 string[] - String used to convert to and from SQL NULL.
- parse
Header string - (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (
default)) Boolean that specifies whether to use the first row headers in the data files to determine column names. 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. - record
Delimiter string - One or more singlebyte or multibyte characters that separate records in an input file. Use
NONEto specify no delimiter. - replace
Invalid stringCharacters - (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. - skip
Blank stringLines - (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (
default)) Boolean that specifies to skip any blank lines encountered in the data files. 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. - skip
Byte stringOrder Mark - (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (
default)) Boolean that specifies whether to skip the BOM (byte order mark) if present in a data file. 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. - skip
Header number - (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (
-1)) Number of lines at the start of the file to skip. - time
Format string - Defines the format of time values in the data files. Use
AUTOto have Snowflake auto-detect the format. - timestamp
Format string - Defines the format of timestamp values in the data files. Use
AUTOto have Snowflake auto-detect the 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.
- 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:
|,.,". - binary_
format str - Defines the encoding format for binary input or output. Valid values:
HEX|BASE64|UTF8. - comment str
- Specifies a comment for the file format.
- compression str
- Specifies the compression format. Valid values:
AUTO|GZIP|BZ2|BROTLI|ZSTD|DEFLATE|RAW_DEFLATE|NONE. - date_
format str - Defines the format of date values in the data files. Use
AUTOto have Snowflake auto-detect the format. - empty_
field_ stras_ null - (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (
default)) Boolean that specifies whether to insert SQL NULL for empty fields in an input file. 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. - encoding str
- Specifies the character set of the source data when loading data into a table. Valid values:
BIG5|EUCJP|EUCKR|GB18030|IBM420|IBM424|ISO2022CN|ISO2022JP|ISO2022KR|ISO88591|ISO88592|ISO88595|ISO88596|ISO88597|ISO88598|ISO88599|ISO885915|KOI8R|SHIFTJIS|UTF8|UTF16|UTF16BE|UTF16LE|UTF32|UTF32BE|UTF32LE|WINDOWS1250|WINDOWS1251|WINDOWS1252|WINDOWS1253|WINDOWS1254|WINDOWS1255|WINDOWS1256. - error_
on_ strcolumn_ count_ mismatch - (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (
default)) Boolean that specifies whether to generate a parsing error if the number of delimited columns in an input file does not match the number of columns in the corresponding table. 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. - escape str
- Single character string used as the escape character for field values. Use
NONEto specify no escape character. NOTE: This value may be not imported properly from Snowflake. Snowflake returns escaped values. - escape_
unenclosed_ strfield - Single character string used as the escape character for unenclosed field values only. Use
NONEto specify no escape character. NOTE: This value may be not imported properly from Snowflake. Snowflake returns escaped values. - field_
delimiter str - One or more singlebyte or multibyte characters that separate fields in an input file. Use
NONEto specify no delimiter. - field_
optionally_ strenclosed_ by - Character used to enclose strings. Use
NONEto specify no enclosure character. - file_
extension str - Specifies the extension for files unloaded to a stage.
- multi_
line str - (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (
default)) Boolean that specifies whether to parse CSV files containing multiple records on a single line. 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. - 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.
- parse_
header str - (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (
default)) Boolean that specifies whether to use the first row headers in the data files to determine column names. 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. - record_
delimiter str - One or more singlebyte or multibyte characters that separate records in an input file. Use
NONEto specify no delimiter. - replace_
invalid_ strcharacters - (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. - skip_
blank_ strlines - (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (
default)) Boolean that specifies to skip any blank lines encountered in the data files. 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. - skip_
byte_ strorder_ mark - (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (
default)) Boolean that specifies whether to skip the BOM (byte order mark) if present in a data file. 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. - skip_
header int - (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (
-1)) Number of lines at the start of the file to skip. - time_
format str - Defines the format of time values in the data files. Use
AUTOto have Snowflake auto-detect the format. - timestamp_
format str - Defines the format of timestamp values in the data files. Use
AUTOto have Snowflake auto-detect the 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.
- 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:
|,.,". - binary
Format String - Defines the encoding format for binary input or output. Valid values:
HEX|BASE64|UTF8. - comment String
- Specifies a comment for the file format.
- compression String
- Specifies the compression format. Valid values:
AUTO|GZIP|BZ2|BROTLI|ZSTD|DEFLATE|RAW_DEFLATE|NONE. - date
Format String - Defines the format of date values in the data files. Use
AUTOto have Snowflake auto-detect the format. - empty
Field StringAs Null - (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (
default)) Boolean that specifies whether to insert SQL NULL for empty fields in an input file. 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. - encoding String
- Specifies the character set of the source data when loading data into a table. Valid values:
BIG5|EUCJP|EUCKR|GB18030|IBM420|IBM424|ISO2022CN|ISO2022JP|ISO2022KR|ISO88591|ISO88592|ISO88595|ISO88596|ISO88597|ISO88598|ISO88599|ISO885915|KOI8R|SHIFTJIS|UTF8|UTF16|UTF16BE|UTF16LE|UTF32|UTF32BE|UTF32LE|WINDOWS1250|WINDOWS1251|WINDOWS1252|WINDOWS1253|WINDOWS1254|WINDOWS1255|WINDOWS1256. - error
On StringColumn Count Mismatch - (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (
default)) Boolean that specifies whether to generate a parsing error if the number of delimited columns in an input file does not match the number of columns in the corresponding table. 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. - escape String
- Single character string used as the escape character for field values. Use
NONEto specify no escape character. NOTE: This value may be not imported properly from Snowflake. Snowflake returns escaped values. - escape
Unenclosed StringField - Single character string used as the escape character for unenclosed field values only. Use
NONEto specify no escape character. NOTE: This value may be not imported properly from Snowflake. Snowflake returns escaped values. - field
Delimiter String - One or more singlebyte or multibyte characters that separate fields in an input file. Use
NONEto specify no delimiter. - field
Optionally StringEnclosed By - Character used to enclose strings. Use
NONEto specify no enclosure character. - file
Extension String - Specifies the extension for files unloaded to a stage.
- multi
Line String - (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (
default)) Boolean that specifies whether to parse CSV files containing multiple records on a single line. 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. - 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.
- parse
Header String - (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (
default)) Boolean that specifies whether to use the first row headers in the data files to determine column names. 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. - record
Delimiter String - One or more singlebyte or multibyte characters that separate records in an input file. Use
NONEto specify no delimiter. - replace
Invalid StringCharacters - (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. - skip
Blank StringLines - (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (
default)) Boolean that specifies to skip any blank lines encountered in the data files. 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. - skip
Byte StringOrder Mark - (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (
default)) Boolean that specifies whether to skip the BOM (byte order mark) if present in a data file. 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. - skip
Header Number - (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (
-1)) Number of lines at the start of the file to skip. - time
Format String - Defines the format of time values in the data files. Use
AUTOto have Snowflake auto-detect the format. - timestamp
Format String - Defines the format of timestamp values in the data files. Use
AUTOto have Snowflake auto-detect the 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.
Outputs
All input properties are implicitly available as output properties. Additionally, the FileFormatCsv resource produces the following output properties:
- Describe
Outputs List<FileFormat Csv Describe Output> - Outputs the result of
DESCRIBE FILE FORMATfor this file format. - Fully
Qualified stringName - 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<FileFormat Csv Show Output> - Outputs the result of
SHOW FILE FORMATSfor 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 []FileFormat Csv Describe Output - Outputs the result of
DESCRIBE FILE FORMATfor this file format. - Fully
Qualified stringName - 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 []FileFormat Csv Show Output - Outputs the result of
SHOW FILE FORMATSfor 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 FORMATfor this file format. - fully_
qualified_ stringname - 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 FORMATSfor 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<FileFormat Csv Describe Output> - Outputs the result of
DESCRIBE FILE FORMATfor this file format. - fully
Qualified StringName - 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<FileFormat Csv Show Output> - Outputs the result of
SHOW FILE FORMATSfor 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 FileFormat Csv Describe Output[] - Outputs the result of
DESCRIBE FILE FORMATfor this file format. - fully
Qualified stringName - 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 FileFormat Csv Show Output[] - Outputs the result of
SHOW FILE FORMATSfor 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[FileFormat Csv Describe Output] - Outputs the result of
DESCRIBE FILE FORMATfor this file format. - fully_
qualified_ strname - 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[FileFormat Csv Show Output] - Outputs the result of
SHOW FILE FORMATSfor 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.
- describe
Outputs List<Property Map> - Outputs the result of
DESCRIBE FILE FORMATfor this file format. - fully
Qualified StringName - 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<Property Map> - Outputs the result of
SHOW FILE FORMATSfor 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 FileFormatCsv Resource
Get an existing FileFormatCsv 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?: FileFormatCsvState, opts?: CustomResourceOptions): FileFormatCsv@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
binary_format: Optional[str] = None,
comment: Optional[str] = None,
compression: Optional[str] = None,
database: Optional[str] = None,
date_format: Optional[str] = None,
describe_outputs: Optional[Sequence[FileFormatCsvDescribeOutputArgs]] = None,
empty_field_as_null: Optional[str] = None,
encoding: Optional[str] = None,
error_on_column_count_mismatch: Optional[str] = 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,
fully_qualified_name: Optional[str] = None,
multi_line: Optional[str] = None,
name: Optional[str] = None,
null_ifs: Optional[Sequence[str]] = None,
parse_header: Optional[str] = None,
record_delimiter: Optional[str] = None,
replace_invalid_characters: Optional[str] = None,
schema: Optional[str] = None,
show_outputs: Optional[Sequence[FileFormatCsvShowOutputArgs]] = None,
skip_blank_lines: Optional[str] = None,
skip_byte_order_mark: Optional[str] = None,
skip_header: Optional[int] = None,
time_format: Optional[str] = None,
timestamp_format: Optional[str] = None,
trim_space: Optional[str] = None,
type: Optional[str] = None) -> FileFormatCsvfunc GetFileFormatCsv(ctx *Context, name string, id IDInput, state *FileFormatCsvState, opts ...ResourceOption) (*FileFormatCsv, error)public static FileFormatCsv Get(string name, Input<string> id, FileFormatCsvState? state, CustomResourceOptions? opts = null)public static FileFormatCsv get(String name, Output<String> id, FileFormatCsvState state, CustomResourceOptions options)resources: _: type: snowflake:FileFormatCsv get: id: ${id}import {
to = snowflake_file_format_csv.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.
- Binary
Format string - Defines the encoding format for binary input or output. Valid values:
HEX|BASE64|UTF8. - Comment string
- Specifies a comment for the file format.
- Compression string
- Specifies the compression format. Valid values:
AUTO|GZIP|BZ2|BROTLI|ZSTD|DEFLATE|RAW_DEFLATE|NONE. - Database string
- The database in which to create the file format. Due to technical limitations (read more here), avoid using the following characters:
|,.,". - Date
Format string - Defines the format of date values in the data files. Use
AUTOto have Snowflake auto-detect the format. - Describe
Outputs List<FileFormat Csv Describe Output> - Outputs the result of
DESCRIBE FILE FORMATfor this file format. - Empty
Field stringAs Null - (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (
default)) Boolean that specifies whether to insert SQL NULL for empty fields in an input file. 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. - Encoding string
- Specifies the character set of the source data when loading data into a table. Valid values:
BIG5|EUCJP|EUCKR|GB18030|IBM420|IBM424|ISO2022CN|ISO2022JP|ISO2022KR|ISO88591|ISO88592|ISO88595|ISO88596|ISO88597|ISO88598|ISO88599|ISO885915|KOI8R|SHIFTJIS|UTF8|UTF16|UTF16BE|UTF16LE|UTF32|UTF32BE|UTF32LE|WINDOWS1250|WINDOWS1251|WINDOWS1252|WINDOWS1253|WINDOWS1254|WINDOWS1255|WINDOWS1256. - Error
On stringColumn Count Mismatch - (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (
default)) Boolean that specifies whether to generate a parsing error if the number of delimited columns in an input file does not match the number of columns in the corresponding table. 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. - Escape string
- Single character string used as the escape character for field values. Use
NONEto specify no escape character. NOTE: This value may be not imported properly from Snowflake. Snowflake returns escaped values. - Escape
Unenclosed stringField - Single character string used as the escape character for unenclosed field values only. Use
NONEto specify no escape character. NOTE: This value may be not imported properly from Snowflake. Snowflake returns escaped values. - Field
Delimiter string - One or more singlebyte or multibyte characters that separate fields in an input file. Use
NONEto specify no delimiter. - Field
Optionally stringEnclosed By - Character used to enclose strings. Use
NONEto specify no enclosure character. - File
Extension string - Specifies the extension for files unloaded to a stage.
- Fully
Qualified stringName - Fully qualified name of the resource. For more information, see object name resolution.
- Multi
Line string - (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (
default)) Boolean that specifies whether to parse CSV files containing multiple records on a single line. 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. - 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.
- Parse
Header string - (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (
default)) Boolean that specifies whether to use the first row headers in the data files to determine column names. 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. - Record
Delimiter string - One or more singlebyte or multibyte characters that separate records in an input file. Use
NONEto specify no delimiter. - Replace
Invalid stringCharacters - (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<FileFormat Csv Show Output> - Outputs the result of
SHOW FILE FORMATSfor this file format. - Skip
Blank stringLines - (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (
default)) Boolean that specifies to skip any blank lines encountered in the data files. 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. - Skip
Byte stringOrder Mark - (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (
default)) Boolean that specifies whether to skip the BOM (byte order mark) if present in a data file. 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. - Skip
Header int - (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (
-1)) Number of lines at the start of the file to skip. - Time
Format string - Defines the format of time values in the data files. Use
AUTOto have Snowflake auto-detect the format. - Timestamp
Format string - Defines the format of timestamp values in the data files. Use
AUTOto have Snowflake auto-detect the 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.
- Binary
Format string - Defines the encoding format for binary input or output. Valid values:
HEX|BASE64|UTF8. - Comment string
- Specifies a comment for the file format.
- Compression string
- Specifies the compression format. Valid values:
AUTO|GZIP|BZ2|BROTLI|ZSTD|DEFLATE|RAW_DEFLATE|NONE. - Database string
- The database in which to create the file format. Due to technical limitations (read more here), avoid using the following characters:
|,.,". - Date
Format string - Defines the format of date values in the data files. Use
AUTOto have Snowflake auto-detect the format. - Describe
Outputs []FileFormat Csv Describe Output Args - Outputs the result of
DESCRIBE FILE FORMATfor this file format. - Empty
Field stringAs Null - (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (
default)) Boolean that specifies whether to insert SQL NULL for empty fields in an input file. 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. - Encoding string
- Specifies the character set of the source data when loading data into a table. Valid values:
BIG5|EUCJP|EUCKR|GB18030|IBM420|IBM424|ISO2022CN|ISO2022JP|ISO2022KR|ISO88591|ISO88592|ISO88595|ISO88596|ISO88597|ISO88598|ISO88599|ISO885915|KOI8R|SHIFTJIS|UTF8|UTF16|UTF16BE|UTF16LE|UTF32|UTF32BE|UTF32LE|WINDOWS1250|WINDOWS1251|WINDOWS1252|WINDOWS1253|WINDOWS1254|WINDOWS1255|WINDOWS1256. - Error
On stringColumn Count Mismatch - (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (
default)) Boolean that specifies whether to generate a parsing error if the number of delimited columns in an input file does not match the number of columns in the corresponding table. 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. - Escape string
- Single character string used as the escape character for field values. Use
NONEto specify no escape character. NOTE: This value may be not imported properly from Snowflake. Snowflake returns escaped values. - Escape
Unenclosed stringField - Single character string used as the escape character for unenclosed field values only. Use
NONEto specify no escape character. NOTE: This value may be not imported properly from Snowflake. Snowflake returns escaped values. - Field
Delimiter string - One or more singlebyte or multibyte characters that separate fields in an input file. Use
NONEto specify no delimiter. - Field
Optionally stringEnclosed By - Character used to enclose strings. Use
NONEto specify no enclosure character. - File
Extension string - Specifies the extension for files unloaded to a stage.
- Fully
Qualified stringName - Fully qualified name of the resource. For more information, see object name resolution.
- Multi
Line string - (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (
default)) Boolean that specifies whether to parse CSV files containing multiple records on a single line. 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. - 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 []string - String used to convert to and from SQL NULL.
- Parse
Header string - (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (
default)) Boolean that specifies whether to use the first row headers in the data files to determine column names. 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. - Record
Delimiter string - One or more singlebyte or multibyte characters that separate records in an input file. Use
NONEto specify no delimiter. - Replace
Invalid stringCharacters - (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 []FileFormat Csv Show Output Args - Outputs the result of
SHOW FILE FORMATSfor this file format. - Skip
Blank stringLines - (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (
default)) Boolean that specifies to skip any blank lines encountered in the data files. 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. - Skip
Byte stringOrder Mark - (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (
default)) Boolean that specifies whether to skip the BOM (byte order mark) if present in a data file. 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. - Skip
Header int - (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (
-1)) Number of lines at the start of the file to skip. - Time
Format string - Defines the format of time values in the data files. Use
AUTOto have Snowflake auto-detect the format. - Timestamp
Format string - Defines the format of timestamp values in the data files. Use
AUTOto have Snowflake auto-detect the 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.
- binary_
format string - Defines the encoding format for binary input or output. Valid values:
HEX|BASE64|UTF8. - comment string
- Specifies a comment for the file format.
- compression string
- Specifies the compression format. Valid values:
AUTO|GZIP|BZ2|BROTLI|ZSTD|DEFLATE|RAW_DEFLATE|NONE. - database string
- The database in which to create the file format. Due to technical limitations (read more here), avoid using the following characters:
|,.,". - date_
format string - Defines the format of date values in the data files. Use
AUTOto have Snowflake auto-detect the format. - describe_
outputs list(object) - Outputs the result of
DESCRIBE FILE FORMATfor this file format. - empty_
field_ stringas_ null - (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (
default)) Boolean that specifies whether to insert SQL NULL for empty fields in an input file. 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. - encoding string
- Specifies the character set of the source data when loading data into a table. Valid values:
BIG5|EUCJP|EUCKR|GB18030|IBM420|IBM424|ISO2022CN|ISO2022JP|ISO2022KR|ISO88591|ISO88592|ISO88595|ISO88596|ISO88597|ISO88598|ISO88599|ISO885915|KOI8R|SHIFTJIS|UTF8|UTF16|UTF16BE|UTF16LE|UTF32|UTF32BE|UTF32LE|WINDOWS1250|WINDOWS1251|WINDOWS1252|WINDOWS1253|WINDOWS1254|WINDOWS1255|WINDOWS1256. - error_
on_ stringcolumn_ count_ mismatch - (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (
default)) Boolean that specifies whether to generate a parsing error if the number of delimited columns in an input file does not match the number of columns in the corresponding table. 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. - escape string
- Single character string used as the escape character for field values. Use
NONEto specify no escape character. NOTE: This value may be not imported properly from Snowflake. Snowflake returns escaped values. - escape_
unenclosed_ stringfield - Single character string used as the escape character for unenclosed field values only. Use
NONEto specify no escape character. NOTE: This value may be not imported properly from Snowflake. Snowflake returns escaped values. - field_
delimiter string - One or more singlebyte or multibyte characters that separate fields in an input file. Use
NONEto specify no delimiter. - field_
optionally_ stringenclosed_ by - Character used to enclose strings. Use
NONEto specify no enclosure character. - file_
extension string - Specifies the extension for files unloaded to a stage.
- fully_
qualified_ stringname - Fully qualified name of the resource. For more information, see object name resolution.
- multi_
line string - (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (
default)) Boolean that specifies whether to parse CSV files containing multiple records on a single line. 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. - 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.
- parse_
header string - (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (
default)) Boolean that specifies whether to use the first row headers in the data files to determine column names. 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. - record_
delimiter string - One or more singlebyte or multibyte characters that separate records in an input file. Use
NONEto specify no delimiter. - replace_
invalid_ stringcharacters - (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 FORMATSfor this file format. - skip_
blank_ stringlines - (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (
default)) Boolean that specifies to skip any blank lines encountered in the data files. 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. - skip_
byte_ stringorder_ mark - (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (
default)) Boolean that specifies whether to skip the BOM (byte order mark) if present in a data file. 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. - skip_
header number - (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (
-1)) Number of lines at the start of the file to skip. - time_
format string - Defines the format of time values in the data files. Use
AUTOto have Snowflake auto-detect the format. - timestamp_
format string - Defines the format of timestamp values in the data files. Use
AUTOto have Snowflake auto-detect the 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.
- binary
Format String - Defines the encoding format for binary input or output. Valid values:
HEX|BASE64|UTF8. - comment String
- Specifies a comment for the file format.
- compression String
- Specifies the compression format. Valid values:
AUTO|GZIP|BZ2|BROTLI|ZSTD|DEFLATE|RAW_DEFLATE|NONE. - database String
- The database in which to create the file format. Due to technical limitations (read more here), avoid using the following characters:
|,.,". - date
Format String - Defines the format of date values in the data files. Use
AUTOto have Snowflake auto-detect the format. - describe
Outputs List<FileFormat Csv Describe Output> - Outputs the result of
DESCRIBE FILE FORMATfor this file format. - empty
Field StringAs Null - (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (
default)) Boolean that specifies whether to insert SQL NULL for empty fields in an input file. 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. - encoding String
- Specifies the character set of the source data when loading data into a table. Valid values:
BIG5|EUCJP|EUCKR|GB18030|IBM420|IBM424|ISO2022CN|ISO2022JP|ISO2022KR|ISO88591|ISO88592|ISO88595|ISO88596|ISO88597|ISO88598|ISO88599|ISO885915|KOI8R|SHIFTJIS|UTF8|UTF16|UTF16BE|UTF16LE|UTF32|UTF32BE|UTF32LE|WINDOWS1250|WINDOWS1251|WINDOWS1252|WINDOWS1253|WINDOWS1254|WINDOWS1255|WINDOWS1256. - error
On StringColumn Count Mismatch - (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (
default)) Boolean that specifies whether to generate a parsing error if the number of delimited columns in an input file does not match the number of columns in the corresponding table. 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. - escape String
- Single character string used as the escape character for field values. Use
NONEto specify no escape character. NOTE: This value may be not imported properly from Snowflake. Snowflake returns escaped values. - escape
Unenclosed StringField - Single character string used as the escape character for unenclosed field values only. Use
NONEto specify no escape character. NOTE: This value may be not imported properly from Snowflake. Snowflake returns escaped values. - field
Delimiter String - One or more singlebyte or multibyte characters that separate fields in an input file. Use
NONEto specify no delimiter. - field
Optionally StringEnclosed By - Character used to enclose strings. Use
NONEto specify no enclosure character. - file
Extension String - Specifies the extension for files unloaded to a stage.
- fully
Qualified StringName - Fully qualified name of the resource. For more information, see object name resolution.
- multi
Line String - (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (
default)) Boolean that specifies whether to parse CSV files containing multiple records on a single line. 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. - 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.
- parse
Header String - (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (
default)) Boolean that specifies whether to use the first row headers in the data files to determine column names. 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. - record
Delimiter String - One or more singlebyte or multibyte characters that separate records in an input file. Use
NONEto specify no delimiter. - replace
Invalid StringCharacters - (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<FileFormat Csv Show Output> - Outputs the result of
SHOW FILE FORMATSfor this file format. - skip
Blank StringLines - (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (
default)) Boolean that specifies to skip any blank lines encountered in the data files. 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. - skip
Byte StringOrder Mark - (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (
default)) Boolean that specifies whether to skip the BOM (byte order mark) if present in a data file. 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. - skip
Header Integer - (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (
-1)) Number of lines at the start of the file to skip. - time
Format String - Defines the format of time values in the data files. Use
AUTOto have Snowflake auto-detect the format. - timestamp
Format String - Defines the format of timestamp values in the data files. Use
AUTOto have Snowflake auto-detect the 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.
- binary
Format string - Defines the encoding format for binary input or output. Valid values:
HEX|BASE64|UTF8. - comment string
- Specifies a comment for the file format.
- compression string
- Specifies the compression format. Valid values:
AUTO|GZIP|BZ2|BROTLI|ZSTD|DEFLATE|RAW_DEFLATE|NONE. - database string
- The database in which to create the file format. Due to technical limitations (read more here), avoid using the following characters:
|,.,". - date
Format string - Defines the format of date values in the data files. Use
AUTOto have Snowflake auto-detect the format. - describe
Outputs FileFormat Csv Describe Output[] - Outputs the result of
DESCRIBE FILE FORMATfor this file format. - empty
Field stringAs Null - (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (
default)) Boolean that specifies whether to insert SQL NULL for empty fields in an input file. 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. - encoding string
- Specifies the character set of the source data when loading data into a table. Valid values:
BIG5|EUCJP|EUCKR|GB18030|IBM420|IBM424|ISO2022CN|ISO2022JP|ISO2022KR|ISO88591|ISO88592|ISO88595|ISO88596|ISO88597|ISO88598|ISO88599|ISO885915|KOI8R|SHIFTJIS|UTF8|UTF16|UTF16BE|UTF16LE|UTF32|UTF32BE|UTF32LE|WINDOWS1250|WINDOWS1251|WINDOWS1252|WINDOWS1253|WINDOWS1254|WINDOWS1255|WINDOWS1256. - error
On stringColumn Count Mismatch - (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (
default)) Boolean that specifies whether to generate a parsing error if the number of delimited columns in an input file does not match the number of columns in the corresponding table. 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. - escape string
- Single character string used as the escape character for field values. Use
NONEto specify no escape character. NOTE: This value may be not imported properly from Snowflake. Snowflake returns escaped values. - escape
Unenclosed stringField - Single character string used as the escape character for unenclosed field values only. Use
NONEto specify no escape character. NOTE: This value may be not imported properly from Snowflake. Snowflake returns escaped values. - field
Delimiter string - One or more singlebyte or multibyte characters that separate fields in an input file. Use
NONEto specify no delimiter. - field
Optionally stringEnclosed By - Character used to enclose strings. Use
NONEto specify no enclosure character. - file
Extension string - Specifies the extension for files unloaded to a stage.
- fully
Qualified stringName - Fully qualified name of the resource. For more information, see object name resolution.
- multi
Line string - (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (
default)) Boolean that specifies whether to parse CSV files containing multiple records on a single line. 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. - 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 string[] - String used to convert to and from SQL NULL.
- parse
Header string - (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (
default)) Boolean that specifies whether to use the first row headers in the data files to determine column names. 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. - record
Delimiter string - One or more singlebyte or multibyte characters that separate records in an input file. Use
NONEto specify no delimiter. - replace
Invalid stringCharacters - (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 FileFormat Csv Show Output[] - Outputs the result of
SHOW FILE FORMATSfor this file format. - skip
Blank stringLines - (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (
default)) Boolean that specifies to skip any blank lines encountered in the data files. 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. - skip
Byte stringOrder Mark - (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (
default)) Boolean that specifies whether to skip the BOM (byte order mark) if present in a data file. 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. - skip
Header number - (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (
-1)) Number of lines at the start of the file to skip. - time
Format string - Defines the format of time values in the data files. Use
AUTOto have Snowflake auto-detect the format. - timestamp
Format string - Defines the format of timestamp values in the data files. Use
AUTOto have Snowflake auto-detect the 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.
- binary_
format str - Defines the encoding format for binary input or output. Valid values:
HEX|BASE64|UTF8. - comment str
- Specifies a comment for the file format.
- compression str
- Specifies the compression format. Valid values:
AUTO|GZIP|BZ2|BROTLI|ZSTD|DEFLATE|RAW_DEFLATE|NONE. - database str
- The database in which to create the file format. Due to technical limitations (read more here), avoid using the following characters:
|,.,". - date_
format str - Defines the format of date values in the data files. Use
AUTOto have Snowflake auto-detect the format. - describe_
outputs Sequence[FileFormat Csv Describe Output Args] - Outputs the result of
DESCRIBE FILE FORMATfor this file format. - empty_
field_ stras_ null - (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (
default)) Boolean that specifies whether to insert SQL NULL for empty fields in an input file. 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. - encoding str
- Specifies the character set of the source data when loading data into a table. Valid values:
BIG5|EUCJP|EUCKR|GB18030|IBM420|IBM424|ISO2022CN|ISO2022JP|ISO2022KR|ISO88591|ISO88592|ISO88595|ISO88596|ISO88597|ISO88598|ISO88599|ISO885915|KOI8R|SHIFTJIS|UTF8|UTF16|UTF16BE|UTF16LE|UTF32|UTF32BE|UTF32LE|WINDOWS1250|WINDOWS1251|WINDOWS1252|WINDOWS1253|WINDOWS1254|WINDOWS1255|WINDOWS1256. - error_
on_ strcolumn_ count_ mismatch - (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (
default)) Boolean that specifies whether to generate a parsing error if the number of delimited columns in an input file does not match the number of columns in the corresponding table. 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. - escape str
- Single character string used as the escape character for field values. Use
NONEto specify no escape character. NOTE: This value may be not imported properly from Snowflake. Snowflake returns escaped values. - escape_
unenclosed_ strfield - Single character string used as the escape character for unenclosed field values only. Use
NONEto specify no escape character. NOTE: This value may be not imported properly from Snowflake. Snowflake returns escaped values. - field_
delimiter str - One or more singlebyte or multibyte characters that separate fields in an input file. Use
NONEto specify no delimiter. - field_
optionally_ strenclosed_ by - Character used to enclose strings. Use
NONEto specify no enclosure character. - file_
extension str - Specifies the extension for files unloaded to a stage.
- fully_
qualified_ strname - Fully qualified name of the resource. For more information, see object name resolution.
- multi_
line str - (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (
default)) Boolean that specifies whether to parse CSV files containing multiple records on a single line. 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. - 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.
- parse_
header str - (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (
default)) Boolean that specifies whether to use the first row headers in the data files to determine column names. 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. - record_
delimiter str - One or more singlebyte or multibyte characters that separate records in an input file. Use
NONEto specify no delimiter. - replace_
invalid_ strcharacters - (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[FileFormat Csv Show Output Args] - Outputs the result of
SHOW FILE FORMATSfor this file format. - skip_
blank_ strlines - (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (
default)) Boolean that specifies to skip any blank lines encountered in the data files. 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. - skip_
byte_ strorder_ mark - (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (
default)) Boolean that specifies whether to skip the BOM (byte order mark) if present in a data file. 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. - skip_
header int - (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (
-1)) Number of lines at the start of the file to skip. - time_
format str - Defines the format of time values in the data files. Use
AUTOto have Snowflake auto-detect the format. - timestamp_
format str - Defines the format of timestamp values in the data files. Use
AUTOto have Snowflake auto-detect the 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.
- binary
Format String - Defines the encoding format for binary input or output. Valid values:
HEX|BASE64|UTF8. - comment String
- Specifies a comment for the file format.
- compression String
- Specifies the compression format. Valid values:
AUTO|GZIP|BZ2|BROTLI|ZSTD|DEFLATE|RAW_DEFLATE|NONE. - database String
- The database in which to create the file format. Due to technical limitations (read more here), avoid using the following characters:
|,.,". - date
Format String - Defines the format of date values in the data files. Use
AUTOto have Snowflake auto-detect the format. - describe
Outputs List<Property Map> - Outputs the result of
DESCRIBE FILE FORMATfor this file format. - empty
Field StringAs Null - (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (
default)) Boolean that specifies whether to insert SQL NULL for empty fields in an input file. 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. - encoding String
- Specifies the character set of the source data when loading data into a table. Valid values:
BIG5|EUCJP|EUCKR|GB18030|IBM420|IBM424|ISO2022CN|ISO2022JP|ISO2022KR|ISO88591|ISO88592|ISO88595|ISO88596|ISO88597|ISO88598|ISO88599|ISO885915|KOI8R|SHIFTJIS|UTF8|UTF16|UTF16BE|UTF16LE|UTF32|UTF32BE|UTF32LE|WINDOWS1250|WINDOWS1251|WINDOWS1252|WINDOWS1253|WINDOWS1254|WINDOWS1255|WINDOWS1256. - error
On StringColumn Count Mismatch - (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (
default)) Boolean that specifies whether to generate a parsing error if the number of delimited columns in an input file does not match the number of columns in the corresponding table. 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. - escape String
- Single character string used as the escape character for field values. Use
NONEto specify no escape character. NOTE: This value may be not imported properly from Snowflake. Snowflake returns escaped values. - escape
Unenclosed StringField - Single character string used as the escape character for unenclosed field values only. Use
NONEto specify no escape character. NOTE: This value may be not imported properly from Snowflake. Snowflake returns escaped values. - field
Delimiter String - One or more singlebyte or multibyte characters that separate fields in an input file. Use
NONEto specify no delimiter. - field
Optionally StringEnclosed By - Character used to enclose strings. Use
NONEto specify no enclosure character. - file
Extension String - Specifies the extension for files unloaded to a stage.
- fully
Qualified StringName - Fully qualified name of the resource. For more information, see object name resolution.
- multi
Line String - (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (
default)) Boolean that specifies whether to parse CSV files containing multiple records on a single line. 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. - 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.
- parse
Header String - (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (
default)) Boolean that specifies whether to use the first row headers in the data files to determine column names. 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. - record
Delimiter String - One or more singlebyte or multibyte characters that separate records in an input file. Use
NONEto specify no delimiter. - replace
Invalid StringCharacters - (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<Property Map> - Outputs the result of
SHOW FILE FORMATSfor this file format. - skip
Blank StringLines - (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (
default)) Boolean that specifies to skip any blank lines encountered in the data files. 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. - skip
Byte StringOrder Mark - (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (
default)) Boolean that specifies whether to skip the BOM (byte order mark) if present in a data file. 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. - skip
Header Number - (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (
-1)) Number of lines at the start of the file to skip. - time
Format String - Defines the format of time values in the data files. Use
AUTOto have Snowflake auto-detect the format. - timestamp
Format String - Defines the format of timestamp values in the data files. Use
AUTOto have Snowflake auto-detect the 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.
Supporting Types
FileFormatCsvDescribeOutput, FileFormatCsvDescribeOutputArgs
- Binary
Format string - Compression string
- Date
Format string - Empty
Field boolAs Null - Encoding string
- Error
On boolColumn Count Mismatch - Escape string
- Escape
Unenclosed stringField - Field
Delimiter string - Field
Optionally stringEnclosed By - File
Extension string - Id string
- Multi
Line bool - Null
Ifs List<string> - Parse
Header bool - Record
Delimiter string - Replace
Invalid boolCharacters - Skip
Blank boolLines - Skip
Byte boolOrder Mark - Skip
Header int - Time
Format string - Timestamp
Format string - Trim
Space bool - Type string
- Validate
Utf8 bool
- Binary
Format string - Compression string
- Date
Format string - Empty
Field boolAs Null - Encoding string
- Error
On boolColumn Count Mismatch - Escape string
- Escape
Unenclosed stringField - Field
Delimiter string - Field
Optionally stringEnclosed By - File
Extension string - Id string
- Multi
Line bool - Null
Ifs []string - Parse
Header bool - Record
Delimiter string - Replace
Invalid boolCharacters - Skip
Blank boolLines - Skip
Byte boolOrder Mark - Skip
Header int - Time
Format string - Timestamp
Format string - Trim
Space bool - Type string
- Validate
Utf8 bool
- binary_
format string - compression string
- date_
format string - empty_
field_ boolas_ null - encoding string
- error_
on_ boolcolumn_ count_ mismatch - escape string
- escape_
unenclosed_ stringfield - field_
delimiter string - field_
optionally_ stringenclosed_ by - file_
extension string - id string
- multi_
line bool - null_
ifs list(string) - parse_
header bool - record_
delimiter string - replace_
invalid_ boolcharacters - skip_
blank_ boollines - skip_
byte_ boolorder_ mark - skip_
header number - time_
format string - timestamp_
format string - trim_
space bool - type string
- validate_
utf8 bool
- binary
Format String - compression String
- date
Format String - empty
Field BooleanAs Null - encoding String
- error
On BooleanColumn Count Mismatch - escape String
- escape
Unenclosed StringField - field
Delimiter String - field
Optionally StringEnclosed By - file
Extension String - id String
- multi
Line Boolean - null
Ifs List<String> - parse
Header Boolean - record
Delimiter String - replace
Invalid BooleanCharacters - skip
Blank BooleanLines - skip
Byte BooleanOrder Mark - skip
Header Integer - time
Format String - timestamp
Format String - trim
Space Boolean - type String
- validate
Utf8 Boolean
- binary
Format string - compression string
- date
Format string - empty
Field booleanAs Null - encoding string
- error
On booleanColumn Count Mismatch - escape string
- escape
Unenclosed stringField - field
Delimiter string - field
Optionally stringEnclosed By - file
Extension string - id string
- multi
Line boolean - null
Ifs string[] - parse
Header boolean - record
Delimiter string - replace
Invalid booleanCharacters - skip
Blank booleanLines - skip
Byte booleanOrder Mark - skip
Header number - time
Format string - timestamp
Format string - trim
Space boolean - type string
- validate
Utf8 boolean
- binary_
format str - compression str
- date_
format str - empty_
field_ boolas_ null - encoding str
- error_
on_ boolcolumn_ count_ mismatch - escape str
- escape_
unenclosed_ strfield - field_
delimiter str - field_
optionally_ strenclosed_ by - file_
extension str - id str
- multi_
line bool - null_
ifs Sequence[str] - parse_
header bool - record_
delimiter str - replace_
invalid_ boolcharacters - skip_
blank_ boollines - skip_
byte_ boolorder_ mark - skip_
header int - time_
format str - timestamp_
format str - trim_
space bool - type str
- validate_
utf8 bool
- binary
Format String - compression String
- date
Format String - empty
Field BooleanAs Null - encoding String
- error
On BooleanColumn Count Mismatch - escape String
- escape
Unenclosed StringField - field
Delimiter String - field
Optionally StringEnclosed By - file
Extension String - id String
- multi
Line Boolean - null
Ifs List<String> - parse
Header Boolean - record
Delimiter String - replace
Invalid BooleanCharacters - skip
Blank BooleanLines - skip
Byte BooleanOrder Mark - skip
Header Number - time
Format String - timestamp
Format String - trim
Space Boolean - type String
- validate
Utf8 Boolean
FileFormatCsvShowOutput, FileFormatCsvShowOutputArgs
- Comment string
- Created
On string - Database
Name string - Format
Options string - Name string
- Owner string
- Owner
Role stringType - Schema
Name string - Type string
- Comment string
- Created
On string - Database
Name string - Format
Options string - Name string
- Owner string
- Owner
Role stringType - Schema
Name string - Type string
- comment string
- created_
on string - database_
name string - format_
options string - name string
- owner string
- owner_
role_ stringtype - schema_
name string - type string
- comment String
- created
On String - database
Name String - format
Options String - name String
- owner String
- owner
Role StringType - schema
Name String - type String
- comment string
- created
On string - database
Name string - format
Options string - name string
- owner string
- owner
Role stringType - schema
Name string - type string
- comment str
- created_
on str - database_
name str - format_
options str - name str
- owner str
- owner_
role_ strtype - schema_
name str - type str
- comment String
- created
On String - database
Name String - format
Options String - name String
- owner String
- owner
Role StringType - schema
Name String - type String
Import
$ pulumi import snowflake:index/fileFormatCsv:FileFormatCsv 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
snowflakeTerraform Provider.
published on Friday, Jul 31, 2026 by Pulumi