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 JSON 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.FileFormatJson("basic", {
database: "database_name",
schema: "schema_name",
name: "file_format_name",
});
//# Complete (with every optional set)
const complete = new snowflake.FileFormatJson("complete", {
database: "database_name",
schema: "schema_name",
name: "file_format_name",
compression: "GZIP",
dateFormat: "YYYY-MM-DD",
timeFormat: "HH24:MI:SS",
timestampFormat: "YYYY-MM-DD HH24:MI:SS.FF3",
binaryFormat: "BASE64",
trimSpace: "true",
multiLine: "true",
nullIfs: [
"NULL",
"",
],
fileExtension: ".json",
enableOctal: "false",
allowDuplicate: "false",
stripOuterArray: "true",
stripNullValues: "false",
replaceInvalidCharacters: "false",
ignoreUtf8Errors: "false",
skipByteOrderMark: "true",
comment: "My JSON file format",
});
import pulumi
import pulumi_snowflake as snowflake
## Minimal
basic = snowflake.FileFormatJson("basic",
database="database_name",
schema="schema_name",
name="file_format_name")
## Complete (with every optional set)
complete = snowflake.FileFormatJson("complete",
database="database_name",
schema="schema_name",
name="file_format_name",
compression="GZIP",
date_format="YYYY-MM-DD",
time_format="HH24:MI:SS",
timestamp_format="YYYY-MM-DD HH24:MI:SS.FF3",
binary_format="BASE64",
trim_space="true",
multi_line="true",
null_ifs=[
"NULL",
"",
],
file_extension=".json",
enable_octal="false",
allow_duplicate="false",
strip_outer_array="true",
strip_null_values="false",
replace_invalid_characters="false",
ignore_utf8_errors="false",
skip_byte_order_mark="true",
comment="My JSON 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.NewFileFormatJson(ctx, "basic", &snowflake.FileFormatJsonArgs{
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.NewFileFormatJson(ctx, "complete", &snowflake.FileFormatJsonArgs{
Database: pulumi.String("database_name"),
Schema: pulumi.String("schema_name"),
Name: pulumi.String("file_format_name"),
Compression: pulumi.String("GZIP"),
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"),
TrimSpace: pulumi.String("true"),
MultiLine: pulumi.String("true"),
NullIfs: pulumi.StringArray{
pulumi.String("NULL"),
pulumi.String(""),
},
FileExtension: pulumi.String(".json"),
EnableOctal: pulumi.String("false"),
AllowDuplicate: pulumi.String("false"),
StripOuterArray: pulumi.String("true"),
StripNullValues: pulumi.String("false"),
ReplaceInvalidCharacters: pulumi.String("false"),
IgnoreUtf8Errors: pulumi.String("false"),
SkipByteOrderMark: pulumi.String("true"),
Comment: pulumi.String("My JSON 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.FileFormatJson("basic", new()
{
Database = "database_name",
Schema = "schema_name",
Name = "file_format_name",
});
//# Complete (with every optional set)
var complete = new Snowflake.FileFormatJson("complete", new()
{
Database = "database_name",
Schema = "schema_name",
Name = "file_format_name",
Compression = "GZIP",
DateFormat = "YYYY-MM-DD",
TimeFormat = "HH24:MI:SS",
TimestampFormat = "YYYY-MM-DD HH24:MI:SS.FF3",
BinaryFormat = "BASE64",
TrimSpace = "true",
MultiLine = "true",
NullIfs = new[]
{
"NULL",
"",
},
FileExtension = ".json",
EnableOctal = "false",
AllowDuplicate = "false",
StripOuterArray = "true",
StripNullValues = "false",
ReplaceInvalidCharacters = "false",
IgnoreUtf8Errors = "false",
SkipByteOrderMark = "true",
Comment = "My JSON file format",
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.snowflake.FileFormatJson;
import com.pulumi.snowflake.FileFormatJsonArgs;
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 FileFormatJson("basic", FileFormatJsonArgs.builder()
.database("database_name")
.schema("schema_name")
.name("file_format_name")
.build());
//# Complete (with every optional set)
var complete = new FileFormatJson("complete", FileFormatJsonArgs.builder()
.database("database_name")
.schema("schema_name")
.name("file_format_name")
.compression("GZIP")
.dateFormat("YYYY-MM-DD")
.timeFormat("HH24:MI:SS")
.timestampFormat("YYYY-MM-DD HH24:MI:SS.FF3")
.binaryFormat("BASE64")
.trimSpace("true")
.multiLine("true")
.nullIfs(
"NULL",
"")
.fileExtension(".json")
.enableOctal("false")
.allowDuplicate("false")
.stripOuterArray("true")
.stripNullValues("false")
.replaceInvalidCharacters("false")
.ignoreUtf8Errors("false")
.skipByteOrderMark("true")
.comment("My JSON file format")
.build());
}
}
resources:
## Minimal
basic:
type: snowflake:FileFormatJson
properties:
database: database_name
schema: schema_name
name: file_format_name
## Complete (with every optional set)
complete:
type: snowflake:FileFormatJson
properties:
database: database_name
schema: schema_name
name: file_format_name
compression: GZIP
dateFormat: YYYY-MM-DD
timeFormat: HH24:MI:SS
timestampFormat: YYYY-MM-DD HH24:MI:SS.FF3
binaryFormat: BASE64
trimSpace: 'true'
multiLine: 'true'
nullIfs:
- NULL
- ""
fileExtension: .json
enableOctal: 'false'
allowDuplicate: 'false'
stripOuterArray: 'true'
stripNullValues: 'false'
replaceInvalidCharacters: 'false'
ignoreUtf8Errors: 'false'
skipByteOrderMark: 'true'
comment: My JSON file format
pulumi {
required_providers {
snowflake = {
source = "pulumi/snowflake"
}
}
}
## Minimal
resource "snowflake_fileformatjson" "basic" {
database = "database_name"
schema = "schema_name"
name = "file_format_name"
}
## Complete (with every optional set)
resource "snowflake_fileformatjson" "complete" {
database = "database_name"
schema = "schema_name"
name = "file_format_name"
compression = "GZIP"
date_format = "YYYY-MM-DD"
time_format = "HH24:MI:SS"
timestamp_format = "YYYY-MM-DD HH24:MI:SS.FF3"
binary_format = "BASE64"
trim_space = "true"
multi_line = "true"
null_ifs = ["NULL", ""]
file_extension = ".json"
enable_octal = "false"
allow_duplicate = "false"
strip_outer_array = "true"
strip_null_values = "false"
replace_invalid_characters = "false"
ignore_utf8_errors = "false"
skip_byte_order_mark = "true"
comment = "My JSON file format"
}
Note If a field has a default value, it is shown next to the type in the schema.
Create FileFormatJson Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new FileFormatJson(name: string, args: FileFormatJsonArgs, opts?: CustomResourceOptions);@overload
def FileFormatJson(resource_name: str,
args: FileFormatJsonArgs,
opts: Optional[ResourceOptions] = None)
@overload
def FileFormatJson(resource_name: str,
opts: Optional[ResourceOptions] = None,
database: Optional[str] = None,
schema: Optional[str] = None,
name: Optional[str] = None,
null_ifs: Optional[Sequence[str]] = None,
comment: Optional[str] = None,
date_format: Optional[str] = None,
enable_octal: Optional[str] = None,
file_extension: Optional[str] = None,
ignore_utf8_errors: Optional[str] = None,
multi_line: Optional[str] = None,
allow_duplicate: Optional[str] = None,
compression: Optional[str] = None,
replace_invalid_characters: Optional[str] = None,
binary_format: Optional[str] = None,
skip_byte_order_mark: Optional[str] = None,
strip_null_values: Optional[str] = None,
strip_outer_array: Optional[str] = None,
time_format: Optional[str] = None,
timestamp_format: Optional[str] = None,
trim_space: Optional[str] = None)func NewFileFormatJson(ctx *Context, name string, args FileFormatJsonArgs, opts ...ResourceOption) (*FileFormatJson, error)public FileFormatJson(string name, FileFormatJsonArgs args, CustomResourceOptions? opts = null)
public FileFormatJson(String name, FileFormatJsonArgs args)
public FileFormatJson(String name, FileFormatJsonArgs args, CustomResourceOptions options)
type: snowflake:FileFormatJson
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
resource "snowflake_file_format_json" "name" {
# resource properties
}Parameters
- name string
- The unique name of the resource.
- args FileFormatJsonArgs
- 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 FileFormatJsonArgs
- 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 FileFormatJsonArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args FileFormatJsonArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args FileFormatJsonArgs
- 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 fileFormatJsonResource = new Snowflake.FileFormatJson("fileFormatJsonResource", new()
{
Database = "string",
Schema = "string",
Name = "string",
NullIfs = new[]
{
"string",
},
Comment = "string",
DateFormat = "string",
EnableOctal = "string",
FileExtension = "string",
IgnoreUtf8Errors = "string",
MultiLine = "string",
AllowDuplicate = "string",
Compression = "string",
ReplaceInvalidCharacters = "string",
BinaryFormat = "string",
SkipByteOrderMark = "string",
StripNullValues = "string",
StripOuterArray = "string",
TimeFormat = "string",
TimestampFormat = "string",
TrimSpace = "string",
});
example, err := snowflake.NewFileFormatJson(ctx, "fileFormatJsonResource", &snowflake.FileFormatJsonArgs{
Database: pulumi.String("string"),
Schema: pulumi.String("string"),
Name: pulumi.String("string"),
NullIfs: pulumi.StringArray{
pulumi.String("string"),
},
Comment: pulumi.String("string"),
DateFormat: pulumi.String("string"),
EnableOctal: pulumi.String("string"),
FileExtension: pulumi.String("string"),
IgnoreUtf8Errors: pulumi.String("string"),
MultiLine: pulumi.String("string"),
AllowDuplicate: pulumi.String("string"),
Compression: pulumi.String("string"),
ReplaceInvalidCharacters: pulumi.String("string"),
BinaryFormat: pulumi.String("string"),
SkipByteOrderMark: pulumi.String("string"),
StripNullValues: pulumi.String("string"),
StripOuterArray: pulumi.String("string"),
TimeFormat: pulumi.String("string"),
TimestampFormat: pulumi.String("string"),
TrimSpace: pulumi.String("string"),
})
resource "snowflake_file_format_json" "fileFormatJsonResource" {
lifecycle {
create_before_destroy = true
}
database = "string"
schema = "string"
name = "string"
null_ifs = ["string"]
comment = "string"
date_format = "string"
enable_octal = "string"
file_extension = "string"
ignore_utf8_errors = "string"
multi_line = "string"
allow_duplicate = "string"
compression = "string"
replace_invalid_characters = "string"
binary_format = "string"
skip_byte_order_mark = "string"
strip_null_values = "string"
strip_outer_array = "string"
time_format = "string"
timestamp_format = "string"
trim_space = "string"
}
var fileFormatJsonResource = new FileFormatJson("fileFormatJsonResource", FileFormatJsonArgs.builder()
.database("string")
.schema("string")
.name("string")
.nullIfs("string")
.comment("string")
.dateFormat("string")
.enableOctal("string")
.fileExtension("string")
.ignoreUtf8Errors("string")
.multiLine("string")
.allowDuplicate("string")
.compression("string")
.replaceInvalidCharacters("string")
.binaryFormat("string")
.skipByteOrderMark("string")
.stripNullValues("string")
.stripOuterArray("string")
.timeFormat("string")
.timestampFormat("string")
.trimSpace("string")
.build());
file_format_json_resource = snowflake.FileFormatJson("fileFormatJsonResource",
database="string",
schema="string",
name="string",
null_ifs=["string"],
comment="string",
date_format="string",
enable_octal="string",
file_extension="string",
ignore_utf8_errors="string",
multi_line="string",
allow_duplicate="string",
compression="string",
replace_invalid_characters="string",
binary_format="string",
skip_byte_order_mark="string",
strip_null_values="string",
strip_outer_array="string",
time_format="string",
timestamp_format="string",
trim_space="string")
const fileFormatJsonResource = new snowflake.FileFormatJson("fileFormatJsonResource", {
database: "string",
schema: "string",
name: "string",
nullIfs: ["string"],
comment: "string",
dateFormat: "string",
enableOctal: "string",
fileExtension: "string",
ignoreUtf8Errors: "string",
multiLine: "string",
allowDuplicate: "string",
compression: "string",
replaceInvalidCharacters: "string",
binaryFormat: "string",
skipByteOrderMark: "string",
stripNullValues: "string",
stripOuterArray: "string",
timeFormat: "string",
timestampFormat: "string",
trimSpace: "string",
});
type: snowflake:FileFormatJson
properties:
allowDuplicate: string
binaryFormat: string
comment: string
compression: string
database: string
dateFormat: string
enableOctal: string
fileExtension: string
ignoreUtf8Errors: string
multiLine: string
name: string
nullIfs:
- string
replaceInvalidCharacters: string
schema: string
skipByteOrderMark: string
stripNullValues: string
stripOuterArray: string
timeFormat: string
timestampFormat: string
trimSpace: string
FileFormatJson 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 FileFormatJson 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:
|,.,". - Allow
Duplicate string - (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (
default)) Boolean that specifies whether to allow duplicate object field names (only the last one will be preserved). 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. - 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. - Enable
Octal string - (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (
default)) Boolean that enables parsing of octal numbers. 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. - File
Extension string - Specifies the extension for files unloaded to a stage.
- Ignore
Utf8Errors string - (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (
default)) Boolean that specifies whether UTF-8 encoding errors produce error conditions. 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. - 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 allow 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.
- 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
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. - Strip
Null stringValues - (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (
default)) Boolean that instructs the JSON parser to remove object fields or array elements containing null values. 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. - Strip
Outer stringArray - (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (
default)) Boolean that instructs the JSON parser to remove outer brackets. 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. - 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:
|,.,". - Allow
Duplicate string - (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (
default)) Boolean that specifies whether to allow duplicate object field names (only the last one will be preserved). 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. - 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. - Enable
Octal string - (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (
default)) Boolean that enables parsing of octal numbers. 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. - File
Extension string - Specifies the extension for files unloaded to a stage.
- Ignore
Utf8Errors string - (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (
default)) Boolean that specifies whether UTF-8 encoding errors produce error conditions. 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. - 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 allow 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.
- 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
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. - Strip
Null stringValues - (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (
default)) Boolean that instructs the JSON parser to remove object fields or array elements containing null values. 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. - Strip
Outer stringArray - (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (
default)) Boolean that instructs the JSON parser to remove outer brackets. 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. - 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:
|,.,". - allow_
duplicate string - (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (
default)) Boolean that specifies whether to allow duplicate object field names (only the last one will be preserved). 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. - 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. - enable_
octal string - (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (
default)) Boolean that enables parsing of octal numbers. 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. - file_
extension string - Specifies the extension for files unloaded to a stage.
- ignore_
utf8_ stringerrors - (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (
default)) Boolean that specifies whether UTF-8 encoding errors produce error conditions. 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. - 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 allow 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.
- 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_
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. - strip_
null_ stringvalues - (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (
default)) Boolean that instructs the JSON parser to remove object fields or array elements containing null values. 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. - strip_
outer_ stringarray - (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (
default)) Boolean that instructs the JSON parser to remove outer brackets. 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. - 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:
|,.,". - allow
Duplicate String - (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (
default)) Boolean that specifies whether to allow duplicate object field names (only the last one will be preserved). 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. - 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. - enable
Octal String - (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (
default)) Boolean that enables parsing of octal numbers. 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. - file
Extension String - Specifies the extension for files unloaded to a stage.
- ignore
Utf8Errors String - (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (
default)) Boolean that specifies whether UTF-8 encoding errors produce error conditions. 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. - 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 allow 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.
- 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
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. - strip
Null StringValues - (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (
default)) Boolean that instructs the JSON parser to remove object fields or array elements containing null values. 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. - strip
Outer StringArray - (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (
default)) Boolean that instructs the JSON parser to remove outer brackets. 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. - 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:
|,.,". - allow
Duplicate string - (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (
default)) Boolean that specifies whether to allow duplicate object field names (only the last one will be preserved). 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. - 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. - enable
Octal string - (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (
default)) Boolean that enables parsing of octal numbers. 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. - file
Extension string - Specifies the extension for files unloaded to a stage.
- ignore
Utf8Errors string - (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (
default)) Boolean that specifies whether UTF-8 encoding errors produce error conditions. 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. - 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 allow 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.
- 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
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. - strip
Null stringValues - (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (
default)) Boolean that instructs the JSON parser to remove object fields or array elements containing null values. 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. - strip
Outer stringArray - (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (
default)) Boolean that instructs the JSON parser to remove outer brackets. 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. - 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:
|,.,". - allow_
duplicate str - (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (
default)) Boolean that specifies whether to allow duplicate object field names (only the last one will be preserved). 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. - 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. - enable_
octal str - (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (
default)) Boolean that enables parsing of octal numbers. 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. - file_
extension str - Specifies the extension for files unloaded to a stage.
- ignore_
utf8_ strerrors - (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (
default)) Boolean that specifies whether UTF-8 encoding errors produce error conditions. 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. - 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 allow 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.
- 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_
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. - strip_
null_ strvalues - (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (
default)) Boolean that instructs the JSON parser to remove object fields or array elements containing null values. 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. - strip_
outer_ strarray - (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (
default)) Boolean that instructs the JSON parser to remove outer brackets. 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. - 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:
|,.,". - allow
Duplicate String - (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (
default)) Boolean that specifies whether to allow duplicate object field names (only the last one will be preserved). 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. - 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. - enable
Octal String - (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (
default)) Boolean that enables parsing of octal numbers. 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. - file
Extension String - Specifies the extension for files unloaded to a stage.
- ignore
Utf8Errors String - (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (
default)) Boolean that specifies whether UTF-8 encoding errors produce error conditions. 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. - 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 allow 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.
- 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
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. - strip
Null StringValues - (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (
default)) Boolean that instructs the JSON parser to remove object fields or array elements containing null values. 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. - strip
Outer StringArray - (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (
default)) Boolean that instructs the JSON parser to remove outer brackets. 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. - 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 FileFormatJson resource produces the following output properties:
- Describe
Outputs List<FileFormat Json 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 Json 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 Json 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 Json 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 Json 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 Json 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 Json 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 Json 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 Json 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 Json 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 FileFormatJson Resource
Get an existing FileFormatJson 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?: FileFormatJsonState, opts?: CustomResourceOptions): FileFormatJson@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
allow_duplicate: Optional[str] = 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[FileFormatJsonDescribeOutputArgs]] = None,
enable_octal: Optional[str] = None,
file_extension: Optional[str] = None,
fully_qualified_name: Optional[str] = None,
ignore_utf8_errors: Optional[str] = None,
multi_line: Optional[str] = None,
name: Optional[str] = None,
null_ifs: Optional[Sequence[str]] = None,
replace_invalid_characters: Optional[str] = None,
schema: Optional[str] = None,
show_outputs: Optional[Sequence[FileFormatJsonShowOutputArgs]] = None,
skip_byte_order_mark: Optional[str] = None,
strip_null_values: Optional[str] = None,
strip_outer_array: Optional[str] = None,
time_format: Optional[str] = None,
timestamp_format: Optional[str] = None,
trim_space: Optional[str] = None,
type: Optional[str] = None) -> FileFormatJsonfunc GetFileFormatJson(ctx *Context, name string, id IDInput, state *FileFormatJsonState, opts ...ResourceOption) (*FileFormatJson, error)public static FileFormatJson Get(string name, Input<string> id, FileFormatJsonState? state, CustomResourceOptions? opts = null)public static FileFormatJson get(String name, Output<String> id, FileFormatJsonState state, CustomResourceOptions options)resources: _: type: snowflake:FileFormatJson get: id: ${id}import {
to = snowflake_file_format_json.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.
- Allow
Duplicate string - (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (
default)) Boolean that specifies whether to allow duplicate object field names (only the last one will be preserved). 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. - 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 Json Describe Output> - Outputs the result of
DESCRIBE FILE FORMATfor this file format. - Enable
Octal string - (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (
default)) Boolean that enables parsing of octal numbers. 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. - 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.
- Ignore
Utf8Errors string - (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (
default)) Boolean that specifies whether UTF-8 encoding errors produce error conditions. 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. - 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 allow 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.
- 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 Json Show Output> - Outputs the result of
SHOW FILE FORMATSfor this file format. - 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. - Strip
Null stringValues - (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (
default)) Boolean that instructs the JSON parser to remove object fields or array elements containing null values. 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. - Strip
Outer stringArray - (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (
default)) Boolean that instructs the JSON parser to remove outer brackets. 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. - 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.
- Allow
Duplicate string - (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (
default)) Boolean that specifies whether to allow duplicate object field names (only the last one will be preserved). 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. - 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 Json Describe Output Args - Outputs the result of
DESCRIBE FILE FORMATfor this file format. - Enable
Octal string - (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (
default)) Boolean that enables parsing of octal numbers. 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. - 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.
- Ignore
Utf8Errors string - (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (
default)) Boolean that specifies whether UTF-8 encoding errors produce error conditions. 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. - 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 allow 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.
- 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 Json Show Output Args - Outputs the result of
SHOW FILE FORMATSfor this file format. - 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. - Strip
Null stringValues - (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (
default)) Boolean that instructs the JSON parser to remove object fields or array elements containing null values. 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. - Strip
Outer stringArray - (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (
default)) Boolean that instructs the JSON parser to remove outer brackets. 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. - 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.
- allow_
duplicate string - (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (
default)) Boolean that specifies whether to allow duplicate object field names (only the last one will be preserved). 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. - 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. - enable_
octal string - (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (
default)) Boolean that enables parsing of octal numbers. 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. - 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.
- ignore_
utf8_ stringerrors - (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (
default)) Boolean that specifies whether UTF-8 encoding errors produce error conditions. 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. - 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 allow 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.
- 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_
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. - strip_
null_ stringvalues - (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (
default)) Boolean that instructs the JSON parser to remove object fields or array elements containing null values. 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. - strip_
outer_ stringarray - (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (
default)) Boolean that instructs the JSON parser to remove outer brackets. 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. - 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.
- allow
Duplicate String - (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (
default)) Boolean that specifies whether to allow duplicate object field names (only the last one will be preserved). 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. - 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 Json Describe Output> - Outputs the result of
DESCRIBE FILE FORMATfor this file format. - enable
Octal String - (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (
default)) Boolean that enables parsing of octal numbers. 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. - 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.
- ignore
Utf8Errors String - (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (
default)) Boolean that specifies whether UTF-8 encoding errors produce error conditions. 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. - 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 allow 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.
- 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 Json Show Output> - Outputs the result of
SHOW FILE FORMATSfor this file format. - 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. - strip
Null StringValues - (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (
default)) Boolean that instructs the JSON parser to remove object fields or array elements containing null values. 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. - strip
Outer StringArray - (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (
default)) Boolean that instructs the JSON parser to remove outer brackets. 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. - 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.
- allow
Duplicate string - (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (
default)) Boolean that specifies whether to allow duplicate object field names (only the last one will be preserved). 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. - 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 Json Describe Output[] - Outputs the result of
DESCRIBE FILE FORMATfor this file format. - enable
Octal string - (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (
default)) Boolean that enables parsing of octal numbers. 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. - 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.
- ignore
Utf8Errors string - (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (
default)) Boolean that specifies whether UTF-8 encoding errors produce error conditions. 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. - 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 allow 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.
- 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 Json Show Output[] - Outputs the result of
SHOW FILE FORMATSfor this file format. - 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. - strip
Null stringValues - (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (
default)) Boolean that instructs the JSON parser to remove object fields or array elements containing null values. 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. - strip
Outer stringArray - (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (
default)) Boolean that instructs the JSON parser to remove outer brackets. 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. - 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.
- allow_
duplicate str - (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (
default)) Boolean that specifies whether to allow duplicate object field names (only the last one will be preserved). 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. - 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 Json Describe Output Args] - Outputs the result of
DESCRIBE FILE FORMATfor this file format. - enable_
octal str - (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (
default)) Boolean that enables parsing of octal numbers. 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. - 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.
- ignore_
utf8_ strerrors - (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (
default)) Boolean that specifies whether UTF-8 encoding errors produce error conditions. 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. - 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 allow 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.
- 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 Json Show Output Args] - Outputs the result of
SHOW FILE FORMATSfor this file format. - 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. - strip_
null_ strvalues - (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (
default)) Boolean that instructs the JSON parser to remove object fields or array elements containing null values. 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. - strip_
outer_ strarray - (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (
default)) Boolean that instructs the JSON parser to remove outer brackets. 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. - 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.
- allow
Duplicate String - (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (
default)) Boolean that specifies whether to allow duplicate object field names (only the last one will be preserved). 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. - 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. - enable
Octal String - (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (
default)) Boolean that enables parsing of octal numbers. 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. - 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.
- ignore
Utf8Errors String - (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (
default)) Boolean that specifies whether UTF-8 encoding errors produce error conditions. 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. - 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 allow 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.
- 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
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. - strip
Null StringValues - (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (
default)) Boolean that instructs the JSON parser to remove object fields or array elements containing null values. 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. - strip
Outer StringArray - (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (
default)) Boolean that instructs the JSON parser to remove outer brackets. 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. - 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
FileFormatJsonDescribeOutput, FileFormatJsonDescribeOutputArgs
- Allow
Duplicate bool - Binary
Format string - Compression string
- Date
Format string - Enable
Octal bool - File
Extension string - Id string
- Ignore
Utf8Errors bool - Multi
Line bool - Null
Ifs List<string> - Replace
Invalid boolCharacters - Skip
Byte boolOrder Mark - Strip
Null boolValues - Strip
Outer boolArray - Time
Format string - Timestamp
Format string - Trim
Space bool - Type string
- Allow
Duplicate bool - Binary
Format string - Compression string
- Date
Format string - Enable
Octal bool - File
Extension string - Id string
- Ignore
Utf8Errors bool - Multi
Line bool - Null
Ifs []string - Replace
Invalid boolCharacters - Skip
Byte boolOrder Mark - Strip
Null boolValues - Strip
Outer boolArray - Time
Format string - Timestamp
Format string - Trim
Space bool - Type string
- allow_
duplicate bool - binary_
format string - compression string
- date_
format string - enable_
octal bool - file_
extension string - id string
- ignore_
utf8_ boolerrors - multi_
line bool - null_
ifs list(string) - replace_
invalid_ boolcharacters - skip_
byte_ boolorder_ mark - strip_
null_ boolvalues - strip_
outer_ boolarray - time_
format string - timestamp_
format string - trim_
space bool - type string
- allow
Duplicate Boolean - binary
Format String - compression String
- date
Format String - enable
Octal Boolean - file
Extension String - id String
- ignore
Utf8Errors Boolean - multi
Line Boolean - null
Ifs List<String> - replace
Invalid BooleanCharacters - skip
Byte BooleanOrder Mark - strip
Null BooleanValues - strip
Outer BooleanArray - time
Format String - timestamp
Format String - trim
Space Boolean - type String
- allow
Duplicate boolean - binary
Format string - compression string
- date
Format string - enable
Octal boolean - file
Extension string - id string
- ignore
Utf8Errors boolean - multi
Line boolean - null
Ifs string[] - replace
Invalid booleanCharacters - skip
Byte booleanOrder Mark - strip
Null booleanValues - strip
Outer booleanArray - time
Format string - timestamp
Format string - trim
Space boolean - type string
- allow_
duplicate bool - binary_
format str - compression str
- date_
format str - enable_
octal bool - file_
extension str - id str
- ignore_
utf8_ boolerrors - multi_
line bool - null_
ifs Sequence[str] - replace_
invalid_ boolcharacters - skip_
byte_ boolorder_ mark - strip_
null_ boolvalues - strip_
outer_ boolarray - time_
format str - timestamp_
format str - trim_
space bool - type str
- allow
Duplicate Boolean - binary
Format String - compression String
- date
Format String - enable
Octal Boolean - file
Extension String - id String
- ignore
Utf8Errors Boolean - multi
Line Boolean - null
Ifs List<String> - replace
Invalid BooleanCharacters - skip
Byte BooleanOrder Mark - strip
Null BooleanValues - strip
Outer BooleanArray - time
Format String - timestamp
Format String - trim
Space Boolean - type String
FileFormatJsonShowOutput, FileFormatJsonShowOutputArgs
- 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/fileFormatJson:FileFormatJson 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