DESCRIBE STAGE

Descreve os valores especificados para as propriedades em um estágio (formato de arquivo, cópia e local), assim como os valores padrão para cada propriedade.

DESCRIBE pode ser abreviado como DESC.

Consulte também:

DROP STAGE , ALTER STAGE , CREATE STAGE , SHOW STAGES

Sintaxe

DESC[RIBE] STAGE <name>
Copy

Parâmetros

name

Especifica o identificador para o estágio a ser descrito. Se o identificador contiver espaços ou caracteres especiais, toda a cadeia de caracteres deverá ser delimitada por aspas duplas. Os identificadores delimitados por aspas duplas também diferenciam letras maiúsculas de minúsculas.

Notas de uso

  • Para pós-processar a saída deste comando, você pode usar a função RESULT_SCAN, que trata a saída como uma tabela que pode ser consultada.

Saída

A saída do comando fornece propriedades de estágio e metadados nas colunas a seguir.

Coluna

Descrição

parent_property

A propriedade pai à qual cada propriedade de estágio pertence. Os valores possíveis incluem STAGE_FILE_FORMAT, STAGE_COPY_OPTIONS, STAGE_LOCATION, STAGE_CREDENTIALS e DIRECTORY.

property

O nome da propriedade. Para descrições de propriedades, consulte CREATE STAGE.

property_type

O tipo de propriedade.

property_value

O valor atribuído à propriedade.

property_default

O valor da propriedade padrão.

Nota

Para estágios com uma tabela de diretórios, a saída inclui uma propriedade chamada LAST_REFRESHED_ON do tipo TIMESTAMP. LAST_REFRESHED_ON indica quando os metadados da tabela de diretórios foram sincronizados pela última vez com os arquivos associados no estágio, manualmente ou automaticamente.

Exemplos

Descrever um estágio interno chamado my_s3_stage:

DESC STAGE my_s3_stage;
+--------------------+--------------------------------+---------------+-------------------------------------------------------+------------------+
| parent_property    | property                       | property_type | property_value                                        | property_default |
|--------------------+--------------------------------+---------------+-------------------------------------------------------+------------------|
| STAGE_FILE_FORMAT  | TYPE                           | String        | CSV                                                   | CSV              |
| STAGE_FILE_FORMAT  | RECORD_DELIMITER               | String        | \n                                                    | \n               |
| STAGE_FILE_FORMAT  | FIELD_DELIMITER                | String        | ,                                                     | ,                |
| STAGE_FILE_FORMAT  | FILE_EXTENSION                 | String        |                                                       |                  |
| STAGE_FILE_FORMAT  | SKIP_HEADER                    | Integer       | 0                                                     | 0                |
| STAGE_FILE_FORMAT  | DATE_FORMAT                    | String        | AUTO                                                  | AUTO             |
| STAGE_FILE_FORMAT  | TIME_FORMAT                    | String        | AUTO                                                  | AUTO             |
| STAGE_FILE_FORMAT  | TIMESTAMP_FORMAT               | String        | AUTO                                                  | AUTO             |
| STAGE_FILE_FORMAT  | BINARY_FORMAT                  | String        | HEX                                                   | HEX              |
| STAGE_FILE_FORMAT  | ESCAPE                         | String        | NONE                                                  | NONE             |
| STAGE_FILE_FORMAT  | ESCAPE_UNENCLOSED_FIELD        | String        | \\                                                    | \\               |
| STAGE_FILE_FORMAT  | TRIM_SPACE                     | Boolean       | false                                                 | false            |
| STAGE_FILE_FORMAT  | FIELD_OPTIONALLY_ENCLOSED_BY   | String        | NONE                                                  | NONE             |
| STAGE_FILE_FORMAT  | NULL_IF                        | List          | [\\N]                                                 | [\\N]            |
| STAGE_FILE_FORMAT  | COMPRESSION                    | String        | AUTO                                                  | AUTO             |
| STAGE_FILE_FORMAT  | ERROR_ON_COLUMN_COUNT_MISMATCH | Boolean       | true                                                  | true             |
| STAGE_FILE_FORMAT  | VALIDATE_UTF8                  | Boolean       | true                                                  | true             |
| STAGE_FILE_FORMAT  | SKIP_BLANK_LINES               | Boolean       | false                                                 | false            |
| STAGE_FILE_FORMAT  | REPLACE_INVALID_CHARACTERS     | Boolean       | false                                                 | false            |
| STAGE_FILE_FORMAT  | EMPTY_FIELD_AS_NULL            | Boolean       | true                                                  | true             |
| STAGE_FILE_FORMAT  | SKIP_BYTE_ORDER_MARK           | Boolean       | true                                                  | true             |
| STAGE_FILE_FORMAT  | ENCODING                       | String        | UTF8                                                  | UTF8             |
| STAGE_COPY_OPTIONS | ON_ERROR                       | String        | ABORT_STATEMENT                                       | ABORT_STATEMENT  |
| STAGE_COPY_OPTIONS | SIZE_LIMIT                     | Long          |                                                       |                  |
| STAGE_COPY_OPTIONS | PURGE                          | Boolean       | false                                                 | false            |
| STAGE_COPY_OPTIONS | RETURN_FAILED_ONLY             | Boolean       | false                                                 | false            |
| STAGE_COPY_OPTIONS | ENFORCE_LENGTH                 | Boolean       | true                                                  | true             |
| STAGE_COPY_OPTIONS | TRUNCATECOLUMNS                | Boolean       | false                                                 | false            |
| STAGE_COPY_OPTIONS | FORCE                          | Boolean       | false                                                 | false            |
| STAGE_LOCATION     | URL                            | String        | ["s3://EXAMPLE-S3-PATH/my-csvfiles/"] |                  |
| STAGE_CREDENTIALS  | AWS_KEY_ID                     | String        |                                                       |                  |
| DIRECTORY          | LAST_REFRESHED_ON              | Timestamp     | 2023-05-03 12:50:28.000 -0700                         |                  |
| DIRECTORY          | ENABLE                         | Boolean       | true                                                  | false            |
| DIRECTORY          | AUTO_REFRESH                   | Boolean       | false                                                 | false            |
+--------------------+--------------------------------+---------------+-------------------------------------------------------+------------------+
Copy