Describes the property type (for example, String or Integer), the defined value of the property, and the default value for each property in a file format object definition. For more information about available properties for each file type, see “Format type options” in CREATE FILE FORMAT.
DESCRIBE can be abbreviated to DESC.
DROP FILE FORMAT , ALTER FILE FORMAT , CREATE FILE FORMAT , SHOW FILE FORMATS
DESC[RIBE] FILE FORMAT <name>
Copy
Parameters¶name
Specifies the identifier for the file format to describe. If the identifier contains spaces or special characters, the entire string must be enclosed in double quotes. Identifiers enclosed in double quotes are also case-sensitive.
To post-process the output of this command, you can use the pipe operator (->>) or the RESULT_SCAN function. Both constructs treat the output as a result set that you can query.
The output column names for this command are generated in lowercase. If you consume a result set from this command with the pipe operator or the RESULT_SCAN function, use double-quoted identifiers for the column names in the query to ensure that they match the column names in the output that was scanned. For example, if the name of an output column is type, then specify "type" for the identifier.
Describe the file format object named my_csv_format:
DESC FILE FORMAT my_csv_format;Copy
Output:
+--------------------------------+---------------+----------------+------------------+ | property | property_type | property_value | property_default | +--------------------------------+---------------+----------------+------------------+ | TYPE | String | csv | CSV | | RECORD_DELIMITER | String | \n | \n | | FIELD_DELIMITER | String | , | , | | FILE_EXTENSION | String | | | | SKIP_HEADER | Integer | 0 | 0 | | PARSE_HEADER | Boolean | FALSE | FALSE | | DATE_FORMAT | String | AUTO | AUTO | | TIME_FORMAT | String | AUTO | AUTO | | TIMESTAMP_FORMAT | String | AUTO | AUTO | | BINARY_FORMAT | String | HEX | HEX | | ESCAPE | String | NONE | NONE | | ESCAPE_UNENCLOSED_FIELD | String | \\ | \\ | | TRIM_SPACE | Boolean | FALSE | FALSE | | FIELD_OPTIONALLY_ENCLOSED_BY | String | NONE | NONE | | NULL_IF | List | [\\N] | [\\N] | | COMPRESSION | String | AUTO | AUTO | | ERROR_ON_COLUMN_COUNT_MISMATCH | Boolean | TRUE | TRUE | | VALIDATE_UTF8 | Boolean | TRUE | TRUE | | SKIP_BLANK_LINES | Boolean | FALSE | FALSE | | REPLACE_INVALID_CHARACTERS | Boolean | FALSE | FALSE | | EMPTY_FIELD_AS_NULL | Boolean | TRUE | TRUE | | SKIP_BYTE_ORDER_MARK | Boolean | TRUE | TRUE | | ENCODING | String | UTF8 | UTF8 | +--------------------------------+---------------+----------------+------------------+
Describe the file format object named my_json_format:
DESC FILE FORMAT `my_json_format`;Copy
Output:
+----------------------------+---------------+----------------+------------------+ | property | property_type | property_value | property_default | +----------------------------+---------------+----------------+------------------+ | TYPE | String | JSON | CSV | | FILE_EXTENSION | String | | | | DATE_FORMAT | String | AUTO | AUTO | | TIME_FORMAT | String | AUTO | AUTO | | TIMESTAMP_FORMAT | String | AUTO | AUTO | | BINARY_FORMAT | String | HEX | HEX | | TRIM_SPACE | Boolean | FALSE | FALSE | | NULL_IF | List | [] | [\\N] | | COMPRESSION | String | AUTO | AUTO | | ENABLE_OCTAL | Boolean | FALSE | FALSE | | ALLOW_DUPLICATE | Boolean | FALSE | FALSE | | STRIP_OUTER_ARRAY | Boolean | FALSE | FALSE | | STRIP_NULL_VALUES | Boolean | FALSE | FALSE | | IGNORE_UTF8_ERRORS | Boolean | FALSE | FALSE | | REPLACE_INVALID_CHARACTERS | Boolean | FALSE | FALSE | | SKIP_BYTE_ORDER_MARK | Boolean | TRUE | TRUE | +----------------------------+---------------+----------------+------------------+
Describe the file format object named my_parquet_format:
DESC FILE FORMAT `my_parquet_format`;Copy
Output:
+----------------+---------------+----------------+------------------+ | property | property_type | property_value | property_default | +----------------+---------------+----------------+------------------+ | TYPE | String | PARQUET | CSV | | TRIM_SPACE | Boolean | FALSE | FALSE | | NULL_IF | List | [] | [\\N] | | COMPRESSION | String | SNAPPY | AUTO | | BINARY_AS_TEXT | Boolean | TRUE | TRUE | +----------------+---------------+----------------+------------------+
RetroSearch is an open source project built by @garambo | Open a GitHub Issue
Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo
HTML:
3.2
| Encoding:
UTF-8
| Version:
0.7.4