Creates a named file format that can be used for bulk loading data into (and unloading data out of) Snowflake tables. This format can then be used in other components to simplify the component’s options and use the custom file format.
Create: The default option. Creates a new file format. This will generate an error if a file format with the same name already exists, but will never destroy existing data.
Create if not exists: This will only create a new format if one of the same name does not already exist.
Drop: Drop the file format of the given name. This is useful for deleting file formats. This will fail if a file format of the given name does not exist.
Drop if exists: Drop the file format of the given name. This is useful for deleting file formats. This will succeed even if a file format of the given name does not exist.
Replace: Creates a new format and replaces any format of the same name, overwriting it.
The Snowflake database that the newly created file format will be stored in. The special value [Environment Default] uses the schema defined in the environment. Read Database, Schema, and Share DDL to learn more.
The Snowflake schema that the newly created file format will be stored in. The special value [Environment Default] uses the schema defined in the environment. Read Database, Schema, and Share DDL to learn more.
The type of file the format applies to. Available options are: AVRO, CSV, JSON, ORC, PARQUET, and XML.The properties below change depending on the option selected here.
The delimiter to be used that separates records (rows) in the file. Defaults to newline. \n can also signify a newline. \r can signify a carriage return.
By default, blank lines encountered in data files produce an end-of-record error. Set this property to True to skip blank lines without producing an error.
Single character string used as the escape character for any field values. Accepts common escape sequences, octal values, or hex values. Also accepts a value of NONE (default).
Single character string used as the escape character for unenclosed field values. Accepts common escape sequences, octal values, or hex values. Also accepts a value of NONE (default). If a character is specified in the Escape field, it will override this field.
A character that is used to enclose strings. Can be single quote (’) or double quote (”) or NONE. The default is NONE. Note that the character chosen can be escaped by that same character.
If True, generate an error if the number of delimited columns in the input does not match that of the table. If False, extra columns are not loaded into the table and missing columns are recorded as NULL in the table.
If True, will replace invalid UTF-8 characters with the Unicode replacement character.If False (the default), the load operation produces an error when invalid UTF-8 character encoding is detected.
