DESCRIBE FILE FORMAT¶

プロパティの型（例: 文字列 や 整数）、プロパティの定義値、およびファイル形式オブジェクト定義の各プロパティのデフォルト値を説明します。各ファイル型で利用可能なプロパティの情報については、 CREATE FILE FORMAT の「形式型オプション」をご参照ください。

DESCRIBE は DESC に短縮できます。

こちらもご参照ください。: DROP FILE FORMAT、 ALTER FILE FORMAT、 CREATE FILE FORMAT、 SHOW FILE FORMATS

構文¶

DESC[RIBE] FILE FORMAT <name>

Copy

パラメーター¶

name: 記述するファイル形式の識別子を指定します。識別子にスペースまたは特殊文字が含まれる場合、文字列全体を二重引用符で囲む必要があります。二重引用符で囲まれた識別子も大文字と小文字が区別されます。

使用上の注意¶

このコマンドの出力を後処理するには、 RESULT_SCAN 関数を使用できます。この関数は、出力をクエリ可能なテーブルとして扱います。

例¶

my_csv_format という名前のファイル形式オブジェクトを説明します。

DESC FILE FORMAT my_csv_format;

Copy

出力:

+--------------------------------+---------------+----------------+------------------+
| 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             |
+--------------------------------+---------------+----------------+------------------+

my_json_format という名前のファイル形式オブジェクトを説明します。

DESC FILE FORMAT `my_json_format`;

Copy

出力:

+----------------------------+---------------+----------------+------------------+
| 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             |
+----------------------------+---------------+----------------+------------------+

my_parquet_format という名前のファイル形式オブジェクトを説明します。

DESC FILE FORMAT `my_parquet_format`;

Copy

出力:

+----------------+---------------+----------------+------------------+
| 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             |
+----------------+---------------+----------------+------------------+