snowflake.FileFormat
Explore with Pulumi AI
Import
format is database name | schema name | file format name
$ pulumi import snowflake:index/fileFormat:FileFormat example 'dbName|schemaName|fileFormatName'
Example Usage
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Snowflake = Pulumi.Snowflake;
return await Deployment.RunAsync(() =>
{
var exampleFileFormat = new Snowflake.FileFormat("exampleFileFormat", new()
{
Database = "EXAMPLE_DB",
FormatType = "CSV",
Schema = "EXAMPLE_SCHEMA",
});
});
package main
import (
"github.com/pulumi/pulumi-snowflake/sdk/go/snowflake"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := snowflake.NewFileFormat(ctx, "exampleFileFormat", &snowflake.FileFormatArgs{
Database: pulumi.String("EXAMPLE_DB"),
FormatType: pulumi.String("CSV"),
Schema: pulumi.String("EXAMPLE_SCHEMA"),
})
if err != nil {
return err
}
return nil
})
}
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.snowflake.FileFormat;
import com.pulumi.snowflake.FileFormatArgs;
import java.util.List;
import java.util.ArrayList;
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) {
var exampleFileFormat = new FileFormat("exampleFileFormat", FileFormatArgs.builder()
.database("EXAMPLE_DB")
.formatType("CSV")
.schema("EXAMPLE_SCHEMA")
.build());
}
}
import pulumi
import pulumi_snowflake as snowflake
example_file_format = snowflake.FileFormat("exampleFileFormat",
database="EXAMPLE_DB",
format_type="CSV",
schema="EXAMPLE_SCHEMA")
import * as pulumi from "@pulumi/pulumi";
import * as snowflake from "@pulumi/snowflake";
const exampleFileFormat = new snowflake.FileFormat("exampleFileFormat", {
database: "EXAMPLE_DB",
formatType: "CSV",
schema: "EXAMPLE_SCHEMA",
});
resources:
exampleFileFormat:
type: snowflake:FileFormat
properties:
database: EXAMPLE_DB
formatType: CSV
schema: EXAMPLE_SCHEMA
Create FileFormat Resource
new FileFormat(name: string, args: FileFormatArgs, opts?: CustomResourceOptions);
@overload
def FileFormat(resource_name: str,
opts: Optional[ResourceOptions] = None,
allow_duplicate: Optional[bool] = None,
binary_as_text: Optional[bool] = None,
binary_format: Optional[str] = None,
comment: Optional[str] = None,
compression: Optional[str] = None,
database: Optional[str] = None,
date_format: Optional[str] = None,
disable_auto_convert: Optional[bool] = None,
disable_snowflake_data: Optional[bool] = None,
empty_field_as_null: Optional[bool] = None,
enable_octal: Optional[bool] = None,
encoding: Optional[str] = None,
error_on_column_count_mismatch: Optional[bool] = None,
escape: Optional[str] = None,
escape_unenclosed_field: Optional[str] = None,
field_delimiter: Optional[str] = None,
field_optionally_enclosed_by: Optional[str] = None,
file_extension: Optional[str] = None,
format_type: Optional[str] = None,
ignore_utf8_errors: Optional[bool] = None,
name: Optional[str] = None,
null_ifs: Optional[Sequence[str]] = None,
preserve_space: Optional[bool] = None,
record_delimiter: Optional[str] = None,
replace_invalid_characters: Optional[bool] = None,
schema: Optional[str] = None,
skip_blank_lines: Optional[bool] = None,
skip_byte_order_mark: Optional[bool] = None,
skip_header: Optional[int] = None,
strip_null_values: Optional[bool] = None,
strip_outer_array: Optional[bool] = None,
strip_outer_element: Optional[bool] = None,
time_format: Optional[str] = None,
timestamp_format: Optional[str] = None,
trim_space: Optional[bool] = None)
@overload
def FileFormat(resource_name: str,
args: FileFormatArgs,
opts: Optional[ResourceOptions] = None)
func NewFileFormat(ctx *Context, name string, args FileFormatArgs, opts ...ResourceOption) (*FileFormat, error)
public FileFormat(string name, FileFormatArgs args, CustomResourceOptions? opts = null)
public FileFormat(String name, FileFormatArgs args)
public FileFormat(String name, FileFormatArgs args, CustomResourceOptions options)
type: snowflake:FileFormat
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args FileFormatArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resource.
- args FileFormatArgs
- The arguments to resource properties.
- opts ResourceOptions
- Bag of options to control resource's behavior.
- ctx Context
- Context object for the current deployment.
- name string
- The unique name of the resource.
- args FileFormatArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args FileFormatArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args FileFormatArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
FileFormat Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
The FileFormat resource accepts the following input properties:
- Database string
The database in which to create the file format.
- Format
Type string Specifies the format of the input files (for data loading) or output files (for data unloading).
- Schema string
The schema in which to create the file format.
- Allow
Duplicate bool Boolean that specifies to allow duplicate object field names (only the last one will be preserved).
- Binary
As boolText Boolean that specifies whether to interpret columns with no defined logical data type as UTF-8 text.
- Binary
Format string Defines the encoding format for binary input or output.
- Comment string
Specifies a comment for the file format.
- Compression string
Specifies the current compression algorithm for the data file.
- Date
Format string Defines the format of date values in the data files (data loading) or table (data unloading).
- Disable
Auto boolConvert Boolean that specifies whether the XML parser disables automatic conversion of numeric and Boolean values from text to native representation.
- Disable
Snowflake boolData Boolean that specifies whether the XML parser disables recognition of Snowflake semi-structured data tags.
- Empty
Field boolAs Null Specifies whether to insert SQL NULL for empty fields in an input file, which are represented by two successive delimiters.
- Enable
Octal bool Boolean that enables parsing of octal numbers.
- Encoding string
String (constant) that specifies the character set of the source data when loading data into a table.
- Error
On boolColumn Count Mismatch Boolean that specifies whether to generate a parsing error if the number of delimited columns (i.e. fields) in an input file does not match the number of columns in the corresponding table.
- Escape string
Single character string used as the escape character for field values.
- Escape
Unenclosed stringField Single character string used as the escape character for unenclosed field values only.
- Field
Delimiter string Specifies one or more singlebyte or multibyte characters that separate fields in an input file (data loading) or unloaded file (data unloading).
- Field
Optionally stringEnclosed By Character used to enclose strings.
- File
Extension string Specifies the extension for files unloaded to a stage.
- Ignore
Utf8Errors bool Boolean that specifies whether UTF-8 encoding errors produce error conditions.
- Name string
Specifies the identifier for the file format; must be unique for the database and schema in which the file format is created.
- Null
Ifs List<string> String used to convert to and from SQL NULL.
- Preserve
Space bool Boolean that specifies whether the XML parser preserves leading and trailing spaces in element content.
- Record
Delimiter string Specifies one or more singlebyte or multibyte characters that separate records in an input file (data loading) or unloaded file (data unloading).
- Replace
Invalid boolCharacters Boolean that specifies whether to replace invalid UTF-8 characters with the Unicode replacement character (�).
- Skip
Blank boolLines Boolean that specifies to skip any blank lines encountered in the data files.
- Skip
Byte boolOrder Mark Boolean that specifies whether to skip the BOM (byte order mark), if present in a data file.
- Skip
Header int Number of lines at the start of the file to skip.
- Strip
Null boolValues Boolean that instructs the JSON parser to remove object fields or array elements containing null values.
- Strip
Outer boolArray Boolean that instructs the JSON parser to remove outer brackets.
- Strip
Outer boolElement Boolean that specifies whether the XML parser strips out the outer XML element, exposing 2nd level elements as separate documents.
- Time
Format string Defines the format of time values in the data files (data loading) or table (data unloading).
- Timestamp
Format string Defines the format of timestamp values in the data files (data loading) or table (data unloading).
- Trim
Space bool Boolean that specifies whether to remove white space from fields.
- Database string
The database in which to create the file format.
- Format
Type string Specifies the format of the input files (for data loading) or output files (for data unloading).
- Schema string
The schema in which to create the file format.
- Allow
Duplicate bool Boolean that specifies to allow duplicate object field names (only the last one will be preserved).
- Binary
As boolText Boolean that specifies whether to interpret columns with no defined logical data type as UTF-8 text.
- Binary
Format string Defines the encoding format for binary input or output.
- Comment string
Specifies a comment for the file format.
- Compression string
Specifies the current compression algorithm for the data file.
- Date
Format string Defines the format of date values in the data files (data loading) or table (data unloading).
- Disable
Auto boolConvert Boolean that specifies whether the XML parser disables automatic conversion of numeric and Boolean values from text to native representation.
- Disable
Snowflake boolData Boolean that specifies whether the XML parser disables recognition of Snowflake semi-structured data tags.
- Empty
Field boolAs Null Specifies whether to insert SQL NULL for empty fields in an input file, which are represented by two successive delimiters.
- Enable
Octal bool Boolean that enables parsing of octal numbers.
- Encoding string
String (constant) that specifies the character set of the source data when loading data into a table.
- Error
On boolColumn Count Mismatch Boolean that specifies whether to generate a parsing error if the number of delimited columns (i.e. fields) in an input file does not match the number of columns in the corresponding table.
- Escape string
Single character string used as the escape character for field values.
- Escape
Unenclosed stringField Single character string used as the escape character for unenclosed field values only.
- Field
Delimiter string Specifies one or more singlebyte or multibyte characters that separate fields in an input file (data loading) or unloaded file (data unloading).
- Field
Optionally stringEnclosed By Character used to enclose strings.
- File
Extension string Specifies the extension for files unloaded to a stage.
- Ignore
Utf8Errors bool Boolean that specifies whether UTF-8 encoding errors produce error conditions.
- Name string
Specifies the identifier for the file format; must be unique for the database and schema in which the file format is created.
- Null
Ifs []string String used to convert to and from SQL NULL.
- Preserve
Space bool Boolean that specifies whether the XML parser preserves leading and trailing spaces in element content.
- Record
Delimiter string Specifies one or more singlebyte or multibyte characters that separate records in an input file (data loading) or unloaded file (data unloading).
- Replace
Invalid boolCharacters Boolean that specifies whether to replace invalid UTF-8 characters with the Unicode replacement character (�).
- Skip
Blank boolLines Boolean that specifies to skip any blank lines encountered in the data files.
- Skip
Byte boolOrder Mark Boolean that specifies whether to skip the BOM (byte order mark), if present in a data file.
- Skip
Header int Number of lines at the start of the file to skip.
- Strip
Null boolValues Boolean that instructs the JSON parser to remove object fields or array elements containing null values.
- Strip
Outer boolArray Boolean that instructs the JSON parser to remove outer brackets.
- Strip
Outer boolElement Boolean that specifies whether the XML parser strips out the outer XML element, exposing 2nd level elements as separate documents.
- Time
Format string Defines the format of time values in the data files (data loading) or table (data unloading).
- Timestamp
Format string Defines the format of timestamp values in the data files (data loading) or table (data unloading).
- Trim
Space bool Boolean that specifies whether to remove white space from fields.
- database String
The database in which to create the file format.
- format
Type String Specifies the format of the input files (for data loading) or output files (for data unloading).
- schema String
The schema in which to create the file format.
- allow
Duplicate Boolean Boolean that specifies to allow duplicate object field names (only the last one will be preserved).
- binary
As BooleanText Boolean that specifies whether to interpret columns with no defined logical data type as UTF-8 text.
- binary
Format String Defines the encoding format for binary input or output.
- comment String
Specifies a comment for the file format.
- compression String
Specifies the current compression algorithm for the data file.
- date
Format String Defines the format of date values in the data files (data loading) or table (data unloading).
- disable
Auto BooleanConvert Boolean that specifies whether the XML parser disables automatic conversion of numeric and Boolean values from text to native representation.
- disable
Snowflake BooleanData Boolean that specifies whether the XML parser disables recognition of Snowflake semi-structured data tags.
- empty
Field BooleanAs Null Specifies whether to insert SQL NULL for empty fields in an input file, which are represented by two successive delimiters.
- enable
Octal Boolean Boolean that enables parsing of octal numbers.
- encoding String
String (constant) that specifies the character set of the source data when loading data into a table.
- error
On BooleanColumn Count Mismatch Boolean that specifies whether to generate a parsing error if the number of delimited columns (i.e. fields) in an input file does not match the number of columns in the corresponding table.
- escape String
Single character string used as the escape character for field values.
- escape
Unenclosed StringField Single character string used as the escape character for unenclosed field values only.
- field
Delimiter String Specifies one or more singlebyte or multibyte characters that separate fields in an input file (data loading) or unloaded file (data unloading).
- field
Optionally StringEnclosed By Character used to enclose strings.
- file
Extension String Specifies the extension for files unloaded to a stage.
- ignore
Utf8Errors Boolean Boolean that specifies whether UTF-8 encoding errors produce error conditions.
- name String
Specifies the identifier for the file format; must be unique for the database and schema in which the file format is created.
- null
Ifs List<String> String used to convert to and from SQL NULL.
- preserve
Space Boolean Boolean that specifies whether the XML parser preserves leading and trailing spaces in element content.
- record
Delimiter String Specifies one or more singlebyte or multibyte characters that separate records in an input file (data loading) or unloaded file (data unloading).
- replace
Invalid BooleanCharacters Boolean that specifies whether to replace invalid UTF-8 characters with the Unicode replacement character (�).
- skip
Blank BooleanLines Boolean that specifies to skip any blank lines encountered in the data files.
- skip
Byte BooleanOrder Mark Boolean that specifies whether to skip the BOM (byte order mark), if present in a data file.
- skip
Header Integer Number of lines at the start of the file to skip.
- strip
Null BooleanValues Boolean that instructs the JSON parser to remove object fields or array elements containing null values.
- strip
Outer BooleanArray Boolean that instructs the JSON parser to remove outer brackets.
- strip
Outer BooleanElement Boolean that specifies whether the XML parser strips out the outer XML element, exposing 2nd level elements as separate documents.
- time
Format String Defines the format of time values in the data files (data loading) or table (data unloading).
- timestamp
Format String Defines the format of timestamp values in the data files (data loading) or table (data unloading).
- trim
Space Boolean Boolean that specifies whether to remove white space from fields.
- database string
The database in which to create the file format.
- format
Type string Specifies the format of the input files (for data loading) or output files (for data unloading).
- schema string
The schema in which to create the file format.
- allow
Duplicate boolean Boolean that specifies to allow duplicate object field names (only the last one will be preserved).
- binary
As booleanText Boolean that specifies whether to interpret columns with no defined logical data type as UTF-8 text.
- binary
Format string Defines the encoding format for binary input or output.
- comment string
Specifies a comment for the file format.
- compression string
Specifies the current compression algorithm for the data file.
- date
Format string Defines the format of date values in the data files (data loading) or table (data unloading).
- disable
Auto booleanConvert Boolean that specifies whether the XML parser disables automatic conversion of numeric and Boolean values from text to native representation.
- disable
Snowflake booleanData Boolean that specifies whether the XML parser disables recognition of Snowflake semi-structured data tags.
- empty
Field booleanAs Null Specifies whether to insert SQL NULL for empty fields in an input file, which are represented by two successive delimiters.
- enable
Octal boolean Boolean that enables parsing of octal numbers.
- encoding string
String (constant) that specifies the character set of the source data when loading data into a table.
- error
On booleanColumn Count Mismatch Boolean that specifies whether to generate a parsing error if the number of delimited columns (i.e. fields) in an input file does not match the number of columns in the corresponding table.
- escape string
Single character string used as the escape character for field values.
- escape
Unenclosed stringField Single character string used as the escape character for unenclosed field values only.
- field
Delimiter string Specifies one or more singlebyte or multibyte characters that separate fields in an input file (data loading) or unloaded file (data unloading).
- field
Optionally stringEnclosed By Character used to enclose strings.
- file
Extension string Specifies the extension for files unloaded to a stage.
- ignore
Utf8Errors boolean Boolean that specifies whether UTF-8 encoding errors produce error conditions.
- name string
Specifies the identifier for the file format; must be unique for the database and schema in which the file format is created.
- null
Ifs string[] String used to convert to and from SQL NULL.
- preserve
Space boolean Boolean that specifies whether the XML parser preserves leading and trailing spaces in element content.
- record
Delimiter string Specifies one or more singlebyte or multibyte characters that separate records in an input file (data loading) or unloaded file (data unloading).
- replace
Invalid booleanCharacters Boolean that specifies whether to replace invalid UTF-8 characters with the Unicode replacement character (�).
- skip
Blank booleanLines Boolean that specifies to skip any blank lines encountered in the data files.
- skip
Byte booleanOrder Mark Boolean that specifies whether to skip the BOM (byte order mark), if present in a data file.
- skip
Header number Number of lines at the start of the file to skip.
- strip
Null booleanValues Boolean that instructs the JSON parser to remove object fields or array elements containing null values.
- strip
Outer booleanArray Boolean that instructs the JSON parser to remove outer brackets.
- strip
Outer booleanElement Boolean that specifies whether the XML parser strips out the outer XML element, exposing 2nd level elements as separate documents.
- time
Format string Defines the format of time values in the data files (data loading) or table (data unloading).
- timestamp
Format string Defines the format of timestamp values in the data files (data loading) or table (data unloading).
- trim
Space boolean Boolean that specifies whether to remove white space from fields.
- database str
The database in which to create the file format.
- format_
type str Specifies the format of the input files (for data loading) or output files (for data unloading).
- schema str
The schema in which to create the file format.
- allow_
duplicate bool Boolean that specifies to allow duplicate object field names (only the last one will be preserved).
- binary_
as_ booltext Boolean that specifies whether to interpret columns with no defined logical data type as UTF-8 text.
- binary_
format str Defines the encoding format for binary input or output.
- comment str
Specifies a comment for the file format.
- compression str
Specifies the current compression algorithm for the data file.
- date_
format str Defines the format of date values in the data files (data loading) or table (data unloading).
- disable_
auto_ boolconvert Boolean that specifies whether the XML parser disables automatic conversion of numeric and Boolean values from text to native representation.
- disable_
snowflake_ booldata Boolean that specifies whether the XML parser disables recognition of Snowflake semi-structured data tags.
- empty_
field_ boolas_ null Specifies whether to insert SQL NULL for empty fields in an input file, which are represented by two successive delimiters.
- enable_
octal bool Boolean that enables parsing of octal numbers.
- encoding str
String (constant) that specifies the character set of the source data when loading data into a table.
- error_
on_ boolcolumn_ count_ mismatch Boolean that specifies whether to generate a parsing error if the number of delimited columns (i.e. fields) in an input file does not match the number of columns in the corresponding table.
- escape str
Single character string used as the escape character for field values.
- escape_
unenclosed_ strfield Single character string used as the escape character for unenclosed field values only.
- field_
delimiter str Specifies one or more singlebyte or multibyte characters that separate fields in an input file (data loading) or unloaded file (data unloading).
- field_
optionally_ strenclosed_ by Character used to enclose strings.
- file_
extension str Specifies the extension for files unloaded to a stage.
- ignore_
utf8_ boolerrors Boolean that specifies whether UTF-8 encoding errors produce error conditions.
- name str
Specifies the identifier for the file format; must be unique for the database and schema in which the file format is created.
- null_
ifs Sequence[str] String used to convert to and from SQL NULL.
- preserve_
space bool Boolean that specifies whether the XML parser preserves leading and trailing spaces in element content.
- record_
delimiter str Specifies one or more singlebyte or multibyte characters that separate records in an input file (data loading) or unloaded file (data unloading).
- replace_
invalid_ boolcharacters Boolean that specifies whether to replace invalid UTF-8 characters with the Unicode replacement character (�).
- skip_
blank_ boollines Boolean that specifies to skip any blank lines encountered in the data files.
- skip_
byte_ boolorder_ mark Boolean that specifies whether to skip the BOM (byte order mark), if present in a data file.
- skip_
header int Number of lines at the start of the file to skip.
- strip_
null_ boolvalues Boolean that instructs the JSON parser to remove object fields or array elements containing null values.
- strip_
outer_ boolarray Boolean that instructs the JSON parser to remove outer brackets.
- strip_
outer_ boolelement Boolean that specifies whether the XML parser strips out the outer XML element, exposing 2nd level elements as separate documents.
- time_
format str Defines the format of time values in the data files (data loading) or table (data unloading).
- timestamp_
format str Defines the format of timestamp values in the data files (data loading) or table (data unloading).
- trim_
space bool Boolean that specifies whether to remove white space from fields.
- database String
The database in which to create the file format.
- format
Type String Specifies the format of the input files (for data loading) or output files (for data unloading).
- schema String
The schema in which to create the file format.
- allow
Duplicate Boolean Boolean that specifies to allow duplicate object field names (only the last one will be preserved).
- binary
As BooleanText Boolean that specifies whether to interpret columns with no defined logical data type as UTF-8 text.
- binary
Format String Defines the encoding format for binary input or output.
- comment String
Specifies a comment for the file format.
- compression String
Specifies the current compression algorithm for the data file.
- date
Format String Defines the format of date values in the data files (data loading) or table (data unloading).
- disable
Auto BooleanConvert Boolean that specifies whether the XML parser disables automatic conversion of numeric and Boolean values from text to native representation.
- disable
Snowflake BooleanData Boolean that specifies whether the XML parser disables recognition of Snowflake semi-structured data tags.
- empty
Field BooleanAs Null Specifies whether to insert SQL NULL for empty fields in an input file, which are represented by two successive delimiters.
- enable
Octal Boolean Boolean that enables parsing of octal numbers.
- encoding String
String (constant) that specifies the character set of the source data when loading data into a table.
- error
On BooleanColumn Count Mismatch Boolean that specifies whether to generate a parsing error if the number of delimited columns (i.e. fields) in an input file does not match the number of columns in the corresponding table.
- escape String
Single character string used as the escape character for field values.
- escape
Unenclosed StringField Single character string used as the escape character for unenclosed field values only.
- field
Delimiter String Specifies one or more singlebyte or multibyte characters that separate fields in an input file (data loading) or unloaded file (data unloading).
- field
Optionally StringEnclosed By Character used to enclose strings.
- file
Extension String Specifies the extension for files unloaded to a stage.
- ignore
Utf8Errors Boolean Boolean that specifies whether UTF-8 encoding errors produce error conditions.
- name String
Specifies the identifier for the file format; must be unique for the database and schema in which the file format is created.
- null
Ifs List<String> String used to convert to and from SQL NULL.
- preserve
Space Boolean Boolean that specifies whether the XML parser preserves leading and trailing spaces in element content.
- record
Delimiter String Specifies one or more singlebyte or multibyte characters that separate records in an input file (data loading) or unloaded file (data unloading).
- replace
Invalid BooleanCharacters Boolean that specifies whether to replace invalid UTF-8 characters with the Unicode replacement character (�).
- skip
Blank BooleanLines Boolean that specifies to skip any blank lines encountered in the data files.
- skip
Byte BooleanOrder Mark Boolean that specifies whether to skip the BOM (byte order mark), if present in a data file.
- skip
Header Number Number of lines at the start of the file to skip.
- strip
Null BooleanValues Boolean that instructs the JSON parser to remove object fields or array elements containing null values.
- strip
Outer BooleanArray Boolean that instructs the JSON parser to remove outer brackets.
- strip
Outer BooleanElement Boolean that specifies whether the XML parser strips out the outer XML element, exposing 2nd level elements as separate documents.
- time
Format String Defines the format of time values in the data files (data loading) or table (data unloading).
- timestamp
Format String Defines the format of timestamp values in the data files (data loading) or table (data unloading).
- trim
Space Boolean Boolean that specifies whether to remove white space from fields.
Outputs
All input properties are implicitly available as output properties. Additionally, the FileFormat resource produces the following output properties:
- Id string
The provider-assigned unique ID for this managed resource.
- Id string
The provider-assigned unique ID for this managed resource.
- id String
The provider-assigned unique ID for this managed resource.
- id string
The provider-assigned unique ID for this managed resource.
- id str
The provider-assigned unique ID for this managed resource.
- id String
The provider-assigned unique ID for this managed resource.
Look up Existing FileFormat Resource
Get an existing FileFormat resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.
public static get(name: string, id: Input<ID>, state?: FileFormatState, opts?: CustomResourceOptions): FileFormat
@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
allow_duplicate: Optional[bool] = None,
binary_as_text: Optional[bool] = None,
binary_format: Optional[str] = None,
comment: Optional[str] = None,
compression: Optional[str] = None,
database: Optional[str] = None,
date_format: Optional[str] = None,
disable_auto_convert: Optional[bool] = None,
disable_snowflake_data: Optional[bool] = None,
empty_field_as_null: Optional[bool] = None,
enable_octal: Optional[bool] = None,
encoding: Optional[str] = None,
error_on_column_count_mismatch: Optional[bool] = None,
escape: Optional[str] = None,
escape_unenclosed_field: Optional[str] = None,
field_delimiter: Optional[str] = None,
field_optionally_enclosed_by: Optional[str] = None,
file_extension: Optional[str] = None,
format_type: Optional[str] = None,
ignore_utf8_errors: Optional[bool] = None,
name: Optional[str] = None,
null_ifs: Optional[Sequence[str]] = None,
preserve_space: Optional[bool] = None,
record_delimiter: Optional[str] = None,
replace_invalid_characters: Optional[bool] = None,
schema: Optional[str] = None,
skip_blank_lines: Optional[bool] = None,
skip_byte_order_mark: Optional[bool] = None,
skip_header: Optional[int] = None,
strip_null_values: Optional[bool] = None,
strip_outer_array: Optional[bool] = None,
strip_outer_element: Optional[bool] = None,
time_format: Optional[str] = None,
timestamp_format: Optional[str] = None,
trim_space: Optional[bool] = None) -> FileFormat
func GetFileFormat(ctx *Context, name string, id IDInput, state *FileFormatState, opts ...ResourceOption) (*FileFormat, error)
public static FileFormat Get(string name, Input<string> id, FileFormatState? state, CustomResourceOptions? opts = null)
public static FileFormat get(String name, Output<String> id, FileFormatState state, CustomResourceOptions options)
Resource lookup is not supported in YAML
- 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.
- Allow
Duplicate bool Boolean that specifies to allow duplicate object field names (only the last one will be preserved).
- Binary
As boolText Boolean that specifies whether to interpret columns with no defined logical data type as UTF-8 text.
- Binary
Format string Defines the encoding format for binary input or output.
- Comment string
Specifies a comment for the file format.
- Compression string
Specifies the current compression algorithm for the data file.
- Database string
The database in which to create the file format.
- Date
Format string Defines the format of date values in the data files (data loading) or table (data unloading).
- Disable
Auto boolConvert Boolean that specifies whether the XML parser disables automatic conversion of numeric and Boolean values from text to native representation.
- Disable
Snowflake boolData Boolean that specifies whether the XML parser disables recognition of Snowflake semi-structured data tags.
- Empty
Field boolAs Null Specifies whether to insert SQL NULL for empty fields in an input file, which are represented by two successive delimiters.
- Enable
Octal bool Boolean that enables parsing of octal numbers.
- Encoding string
String (constant) that specifies the character set of the source data when loading data into a table.
- Error
On boolColumn Count Mismatch Boolean that specifies whether to generate a parsing error if the number of delimited columns (i.e. fields) in an input file does not match the number of columns in the corresponding table.
- Escape string
Single character string used as the escape character for field values.
- Escape
Unenclosed stringField Single character string used as the escape character for unenclosed field values only.
- Field
Delimiter string Specifies one or more singlebyte or multibyte characters that separate fields in an input file (data loading) or unloaded file (data unloading).
- Field
Optionally stringEnclosed By Character used to enclose strings.
- File
Extension string Specifies the extension for files unloaded to a stage.
- Format
Type string Specifies the format of the input files (for data loading) or output files (for data unloading).
- Ignore
Utf8Errors bool Boolean that specifies whether UTF-8 encoding errors produce error conditions.
- Name string
Specifies the identifier for the file format; must be unique for the database and schema in which the file format is created.
- Null
Ifs List<string> String used to convert to and from SQL NULL.
- Preserve
Space bool Boolean that specifies whether the XML parser preserves leading and trailing spaces in element content.
- Record
Delimiter string Specifies one or more singlebyte or multibyte characters that separate records in an input file (data loading) or unloaded file (data unloading).
- Replace
Invalid boolCharacters Boolean that specifies whether to replace invalid UTF-8 characters with the Unicode replacement character (�).
- Schema string
The schema in which to create the file format.
- Skip
Blank boolLines Boolean that specifies to skip any blank lines encountered in the data files.
- Skip
Byte boolOrder Mark Boolean that specifies whether to skip the BOM (byte order mark), if present in a data file.
- Skip
Header int Number of lines at the start of the file to skip.
- Strip
Null boolValues Boolean that instructs the JSON parser to remove object fields or array elements containing null values.
- Strip
Outer boolArray Boolean that instructs the JSON parser to remove outer brackets.
- Strip
Outer boolElement Boolean that specifies whether the XML parser strips out the outer XML element, exposing 2nd level elements as separate documents.
- Time
Format string Defines the format of time values in the data files (data loading) or table (data unloading).
- Timestamp
Format string Defines the format of timestamp values in the data files (data loading) or table (data unloading).
- Trim
Space bool Boolean that specifies whether to remove white space from fields.
- Allow
Duplicate bool Boolean that specifies to allow duplicate object field names (only the last one will be preserved).
- Binary
As boolText Boolean that specifies whether to interpret columns with no defined logical data type as UTF-8 text.
- Binary
Format string Defines the encoding format for binary input or output.
- Comment string
Specifies a comment for the file format.
- Compression string
Specifies the current compression algorithm for the data file.
- Database string
The database in which to create the file format.
- Date
Format string Defines the format of date values in the data files (data loading) or table (data unloading).
- Disable
Auto boolConvert Boolean that specifies whether the XML parser disables automatic conversion of numeric and Boolean values from text to native representation.
- Disable
Snowflake boolData Boolean that specifies whether the XML parser disables recognition of Snowflake semi-structured data tags.
- Empty
Field boolAs Null Specifies whether to insert SQL NULL for empty fields in an input file, which are represented by two successive delimiters.
- Enable
Octal bool Boolean that enables parsing of octal numbers.
- Encoding string
String (constant) that specifies the character set of the source data when loading data into a table.
- Error
On boolColumn Count Mismatch Boolean that specifies whether to generate a parsing error if the number of delimited columns (i.e. fields) in an input file does not match the number of columns in the corresponding table.
- Escape string
Single character string used as the escape character for field values.
- Escape
Unenclosed stringField Single character string used as the escape character for unenclosed field values only.
- Field
Delimiter string Specifies one or more singlebyte or multibyte characters that separate fields in an input file (data loading) or unloaded file (data unloading).
- Field
Optionally stringEnclosed By Character used to enclose strings.
- File
Extension string Specifies the extension for files unloaded to a stage.
- Format
Type string Specifies the format of the input files (for data loading) or output files (for data unloading).
- Ignore
Utf8Errors bool Boolean that specifies whether UTF-8 encoding errors produce error conditions.
- Name string
Specifies the identifier for the file format; must be unique for the database and schema in which the file format is created.
- Null
Ifs []string String used to convert to and from SQL NULL.
- Preserve
Space bool Boolean that specifies whether the XML parser preserves leading and trailing spaces in element content.
- Record
Delimiter string Specifies one or more singlebyte or multibyte characters that separate records in an input file (data loading) or unloaded file (data unloading).
- Replace
Invalid boolCharacters Boolean that specifies whether to replace invalid UTF-8 characters with the Unicode replacement character (�).
- Schema string
The schema in which to create the file format.
- Skip
Blank boolLines Boolean that specifies to skip any blank lines encountered in the data files.
- Skip
Byte boolOrder Mark Boolean that specifies whether to skip the BOM (byte order mark), if present in a data file.
- Skip
Header int Number of lines at the start of the file to skip.
- Strip
Null boolValues Boolean that instructs the JSON parser to remove object fields or array elements containing null values.
- Strip
Outer boolArray Boolean that instructs the JSON parser to remove outer brackets.
- Strip
Outer boolElement Boolean that specifies whether the XML parser strips out the outer XML element, exposing 2nd level elements as separate documents.
- Time
Format string Defines the format of time values in the data files (data loading) or table (data unloading).
- Timestamp
Format string Defines the format of timestamp values in the data files (data loading) or table (data unloading).
- Trim
Space bool Boolean that specifies whether to remove white space from fields.
- allow
Duplicate Boolean Boolean that specifies to allow duplicate object field names (only the last one will be preserved).
- binary
As BooleanText Boolean that specifies whether to interpret columns with no defined logical data type as UTF-8 text.
- binary
Format String Defines the encoding format for binary input or output.
- comment String
Specifies a comment for the file format.
- compression String
Specifies the current compression algorithm for the data file.
- database String
The database in which to create the file format.
- date
Format String Defines the format of date values in the data files (data loading) or table (data unloading).
- disable
Auto BooleanConvert Boolean that specifies whether the XML parser disables automatic conversion of numeric and Boolean values from text to native representation.
- disable
Snowflake BooleanData Boolean that specifies whether the XML parser disables recognition of Snowflake semi-structured data tags.
- empty
Field BooleanAs Null Specifies whether to insert SQL NULL for empty fields in an input file, which are represented by two successive delimiters.
- enable
Octal Boolean Boolean that enables parsing of octal numbers.
- encoding String
String (constant) that specifies the character set of the source data when loading data into a table.
- error
On BooleanColumn Count Mismatch Boolean that specifies whether to generate a parsing error if the number of delimited columns (i.e. fields) in an input file does not match the number of columns in the corresponding table.
- escape String
Single character string used as the escape character for field values.
- escape
Unenclosed StringField Single character string used as the escape character for unenclosed field values only.
- field
Delimiter String Specifies one or more singlebyte or multibyte characters that separate fields in an input file (data loading) or unloaded file (data unloading).
- field
Optionally StringEnclosed By Character used to enclose strings.
- file
Extension String Specifies the extension for files unloaded to a stage.
- format
Type String Specifies the format of the input files (for data loading) or output files (for data unloading).
- ignore
Utf8Errors Boolean Boolean that specifies whether UTF-8 encoding errors produce error conditions.
- name String
Specifies the identifier for the file format; must be unique for the database and schema in which the file format is created.
- null
Ifs List<String> String used to convert to and from SQL NULL.
- preserve
Space Boolean Boolean that specifies whether the XML parser preserves leading and trailing spaces in element content.
- record
Delimiter String Specifies one or more singlebyte or multibyte characters that separate records in an input file (data loading) or unloaded file (data unloading).
- replace
Invalid BooleanCharacters Boolean that specifies whether to replace invalid UTF-8 characters with the Unicode replacement character (�).
- schema String
The schema in which to create the file format.
- skip
Blank BooleanLines Boolean that specifies to skip any blank lines encountered in the data files.
- skip
Byte BooleanOrder Mark Boolean that specifies whether to skip the BOM (byte order mark), if present in a data file.
- skip
Header Integer Number of lines at the start of the file to skip.
- strip
Null BooleanValues Boolean that instructs the JSON parser to remove object fields or array elements containing null values.
- strip
Outer BooleanArray Boolean that instructs the JSON parser to remove outer brackets.
- strip
Outer BooleanElement Boolean that specifies whether the XML parser strips out the outer XML element, exposing 2nd level elements as separate documents.
- time
Format String Defines the format of time values in the data files (data loading) or table (data unloading).
- timestamp
Format String Defines the format of timestamp values in the data files (data loading) or table (data unloading).
- trim
Space Boolean Boolean that specifies whether to remove white space from fields.
- allow
Duplicate boolean Boolean that specifies to allow duplicate object field names (only the last one will be preserved).
- binary
As booleanText Boolean that specifies whether to interpret columns with no defined logical data type as UTF-8 text.
- binary
Format string Defines the encoding format for binary input or output.
- comment string
Specifies a comment for the file format.
- compression string
Specifies the current compression algorithm for the data file.
- database string
The database in which to create the file format.
- date
Format string Defines the format of date values in the data files (data loading) or table (data unloading).
- disable
Auto booleanConvert Boolean that specifies whether the XML parser disables automatic conversion of numeric and Boolean values from text to native representation.
- disable
Snowflake booleanData Boolean that specifies whether the XML parser disables recognition of Snowflake semi-structured data tags.
- empty
Field booleanAs Null Specifies whether to insert SQL NULL for empty fields in an input file, which are represented by two successive delimiters.
- enable
Octal boolean Boolean that enables parsing of octal numbers.
- encoding string
String (constant) that specifies the character set of the source data when loading data into a table.
- error
On booleanColumn Count Mismatch Boolean that specifies whether to generate a parsing error if the number of delimited columns (i.e. fields) in an input file does not match the number of columns in the corresponding table.
- escape string
Single character string used as the escape character for field values.
- escape
Unenclosed stringField Single character string used as the escape character for unenclosed field values only.
- field
Delimiter string Specifies one or more singlebyte or multibyte characters that separate fields in an input file (data loading) or unloaded file (data unloading).
- field
Optionally stringEnclosed By Character used to enclose strings.
- file
Extension string Specifies the extension for files unloaded to a stage.
- format
Type string Specifies the format of the input files (for data loading) or output files (for data unloading).
- ignore
Utf8Errors boolean Boolean that specifies whether UTF-8 encoding errors produce error conditions.
- name string
Specifies the identifier for the file format; must be unique for the database and schema in which the file format is created.
- null
Ifs string[] String used to convert to and from SQL NULL.
- preserve
Space boolean Boolean that specifies whether the XML parser preserves leading and trailing spaces in element content.
- record
Delimiter string Specifies one or more singlebyte or multibyte characters that separate records in an input file (data loading) or unloaded file (data unloading).
- replace
Invalid booleanCharacters Boolean that specifies whether to replace invalid UTF-8 characters with the Unicode replacement character (�).
- schema string
The schema in which to create the file format.
- skip
Blank booleanLines Boolean that specifies to skip any blank lines encountered in the data files.
- skip
Byte booleanOrder Mark Boolean that specifies whether to skip the BOM (byte order mark), if present in a data file.
- skip
Header number Number of lines at the start of the file to skip.
- strip
Null booleanValues Boolean that instructs the JSON parser to remove object fields or array elements containing null values.
- strip
Outer booleanArray Boolean that instructs the JSON parser to remove outer brackets.
- strip
Outer booleanElement Boolean that specifies whether the XML parser strips out the outer XML element, exposing 2nd level elements as separate documents.
- time
Format string Defines the format of time values in the data files (data loading) or table (data unloading).
- timestamp
Format string Defines the format of timestamp values in the data files (data loading) or table (data unloading).
- trim
Space boolean Boolean that specifies whether to remove white space from fields.
- allow_
duplicate bool Boolean that specifies to allow duplicate object field names (only the last one will be preserved).
- binary_
as_ booltext Boolean that specifies whether to interpret columns with no defined logical data type as UTF-8 text.
- binary_
format str Defines the encoding format for binary input or output.
- comment str
Specifies a comment for the file format.
- compression str
Specifies the current compression algorithm for the data file.
- database str
The database in which to create the file format.
- date_
format str Defines the format of date values in the data files (data loading) or table (data unloading).
- disable_
auto_ boolconvert Boolean that specifies whether the XML parser disables automatic conversion of numeric and Boolean values from text to native representation.
- disable_
snowflake_ booldata Boolean that specifies whether the XML parser disables recognition of Snowflake semi-structured data tags.
- empty_
field_ boolas_ null Specifies whether to insert SQL NULL for empty fields in an input file, which are represented by two successive delimiters.
- enable_
octal bool Boolean that enables parsing of octal numbers.
- encoding str
String (constant) that specifies the character set of the source data when loading data into a table.
- error_
on_ boolcolumn_ count_ mismatch Boolean that specifies whether to generate a parsing error if the number of delimited columns (i.e. fields) in an input file does not match the number of columns in the corresponding table.
- escape str
Single character string used as the escape character for field values.
- escape_
unenclosed_ strfield Single character string used as the escape character for unenclosed field values only.
- field_
delimiter str Specifies one or more singlebyte or multibyte characters that separate fields in an input file (data loading) or unloaded file (data unloading).
- field_
optionally_ strenclosed_ by Character used to enclose strings.
- file_
extension str Specifies the extension for files unloaded to a stage.
- format_
type str Specifies the format of the input files (for data loading) or output files (for data unloading).
- ignore_
utf8_ boolerrors Boolean that specifies whether UTF-8 encoding errors produce error conditions.
- name str
Specifies the identifier for the file format; must be unique for the database and schema in which the file format is created.
- null_
ifs Sequence[str] String used to convert to and from SQL NULL.
- preserve_
space bool Boolean that specifies whether the XML parser preserves leading and trailing spaces in element content.
- record_
delimiter str Specifies one or more singlebyte or multibyte characters that separate records in an input file (data loading) or unloaded file (data unloading).
- replace_
invalid_ boolcharacters Boolean that specifies whether to replace invalid UTF-8 characters with the Unicode replacement character (�).
- schema str
The schema in which to create the file format.
- skip_
blank_ boollines Boolean that specifies to skip any blank lines encountered in the data files.
- skip_
byte_ boolorder_ mark Boolean that specifies whether to skip the BOM (byte order mark), if present in a data file.
- skip_
header int Number of lines at the start of the file to skip.
- strip_
null_ boolvalues Boolean that instructs the JSON parser to remove object fields or array elements containing null values.
- strip_
outer_ boolarray Boolean that instructs the JSON parser to remove outer brackets.
- strip_
outer_ boolelement Boolean that specifies whether the XML parser strips out the outer XML element, exposing 2nd level elements as separate documents.
- time_
format str Defines the format of time values in the data files (data loading) or table (data unloading).
- timestamp_
format str Defines the format of timestamp values in the data files (data loading) or table (data unloading).
- trim_
space bool Boolean that specifies whether to remove white space from fields.
- allow
Duplicate Boolean Boolean that specifies to allow duplicate object field names (only the last one will be preserved).
- binary
As BooleanText Boolean that specifies whether to interpret columns with no defined logical data type as UTF-8 text.
- binary
Format String Defines the encoding format for binary input or output.
- comment String
Specifies a comment for the file format.
- compression String
Specifies the current compression algorithm for the data file.
- database String
The database in which to create the file format.
- date
Format String Defines the format of date values in the data files (data loading) or table (data unloading).
- disable
Auto BooleanConvert Boolean that specifies whether the XML parser disables automatic conversion of numeric and Boolean values from text to native representation.
- disable
Snowflake BooleanData Boolean that specifies whether the XML parser disables recognition of Snowflake semi-structured data tags.
- empty
Field BooleanAs Null Specifies whether to insert SQL NULL for empty fields in an input file, which are represented by two successive delimiters.
- enable
Octal Boolean Boolean that enables parsing of octal numbers.
- encoding String
String (constant) that specifies the character set of the source data when loading data into a table.
- error
On BooleanColumn Count Mismatch Boolean that specifies whether to generate a parsing error if the number of delimited columns (i.e. fields) in an input file does not match the number of columns in the corresponding table.
- escape String
Single character string used as the escape character for field values.
- escape
Unenclosed StringField Single character string used as the escape character for unenclosed field values only.
- field
Delimiter String Specifies one or more singlebyte or multibyte characters that separate fields in an input file (data loading) or unloaded file (data unloading).
- field
Optionally StringEnclosed By Character used to enclose strings.
- file
Extension String Specifies the extension for files unloaded to a stage.
- format
Type String Specifies the format of the input files (for data loading) or output files (for data unloading).
- ignore
Utf8Errors Boolean Boolean that specifies whether UTF-8 encoding errors produce error conditions.
- name String
Specifies the identifier for the file format; must be unique for the database and schema in which the file format is created.
- null
Ifs List<String> String used to convert to and from SQL NULL.
- preserve
Space Boolean Boolean that specifies whether the XML parser preserves leading and trailing spaces in element content.
- record
Delimiter String Specifies one or more singlebyte or multibyte characters that separate records in an input file (data loading) or unloaded file (data unloading).
- replace
Invalid BooleanCharacters Boolean that specifies whether to replace invalid UTF-8 characters with the Unicode replacement character (�).
- schema String
The schema in which to create the file format.
- skip
Blank BooleanLines Boolean that specifies to skip any blank lines encountered in the data files.
- skip
Byte BooleanOrder Mark Boolean that specifies whether to skip the BOM (byte order mark), if present in a data file.
- skip
Header Number Number of lines at the start of the file to skip.
- strip
Null BooleanValues Boolean that instructs the JSON parser to remove object fields or array elements containing null values.
- strip
Outer BooleanArray Boolean that instructs the JSON parser to remove outer brackets.
- strip
Outer BooleanElement Boolean that specifies whether the XML parser strips out the outer XML element, exposing 2nd level elements as separate documents.
- time
Format String Defines the format of time values in the data files (data loading) or table (data unloading).
- timestamp
Format String Defines the format of timestamp values in the data files (data loading) or table (data unloading).
- trim
Space Boolean Boolean that specifies whether to remove white space from fields.
Package Details
- Repository
- Snowflake pulumi/pulumi-snowflake
- License
- Apache-2.0
- Notes
This Pulumi package is based on the
snowflake
Terraform Provider.