DESCRIBE EXTERNAL VOLUME

Descreve as propriedades de um volume externo.

DESCRIBE pode ser abreviado como DESC.

Consulte também:

ALTER EXTERNAL VOLUME , CREATE EXTERNAL VOLUME , DROP EXTERNAL VOLUME , SHOW EXTERNAL VOLUMES

Sintaxe

DESC[RIBE] EXTERNAL VOLUME <name>
Copy

Parâmetros

name

Especifica o identificador do volume externo a ser descrito. Se o identificador contiver espaços ou caracteres especiais, toda a cadeia de caracteres deverá ser delimitada por aspas duplas (por exemplo, "My object"). Os identificadores delimitados por aspas duplas também diferenciam letras maiúsculas de minúsculas.

Saída

A saída do comando inclui as seguintes colunas, que descrevem as propriedades e metadados do objeto:

Coluna

Descrição

parent_property

A propriedade pai. Esta coluna inclui a propriedade STORAGE_LOCATIONS, que contém um conjunto de locais de armazenamento em nuvem nomeados.

property

O nome da propriedade. Esta coluna pode incluir as propriedades listadas na tabela a seguir.

property_type

O tipo de propriedade.

property_value

O valor atribuído à propriedade.

property_default

O valor da propriedade padrão.

A coluna property pode incluir as seguintes propriedades de um objeto de volume externo:

Propriedade

Descrição

comment

O comentário definido para o volume externo, se houver.

allow_writes

Especifica se operações de gravação são permitidas para o volume externo.

storage_location_n

Detalhes para um local de armazenamento em nuvem associado ao volume externo, onde n é um número único que distingue o local dos demais na lista STORAGE_LOCATIONS; por exemplo, storage_location_1.

Para obter mais informações sobre propriedades do local de armazenamento, consulte CREATE EXTERNAL VOLUME.

active

O nome do local de armazenamento ativo para o volume externo.

Requisitos de controle de acesso

A função usada para executar essa operação deve ter, no mínimo, os seguintes privilégios:

Privilégio

Objeto

Notas

USAGE

Volume externo

Para instruções sobre como criar uma função personalizada com um conjunto específico de privilégios, consulte Criação de funções personalizadas.

Para informações gerais sobre concessões de funções e privilégios para executar ações de SQL em objetos protegíveis, consulte Visão geral do controle de acesso.

Notas de uso

  • Para pós-processar a saída deste comando, você pode usar o operador de canal (->>) ou a função RESULT_SCAN. Ambos os constructos tratam a saída como um conjunto de resultados que você pode consultar.

    Os nomes das colunas de saída para este comando são gerados em minúsculas. Se você consumir um conjunto de resultados deste comando com o operador de canal ou a função RESULT_SCAN, use identificadores entre aspas duplas para os nomes das colunas na consulta para garantir que eles correspondam aos nomes das colunas na saída que foi verificada. Por exemplo, se o nome de uma coluna de saída for type, especifique "type" para o identificador.

Exemplos

Descreva um volume externo:

DESC EXTERNAL VOLUME my_external_volume;
Copy

A seguir é mostrada a saída de DESCRIBE EXTERNAL VOLUME para um volume externo com um local de armazenamento. O valor da propriedade para STORAGE_LOCATION_1 é abreviado para fins de exibição.

+-------------------+--------------------+---------------+-------------------------------------------------------------------------------------------+------------------+
| parent_property   | property           | property_type | property_value                                                                            | property_default |
|-------------------+--------------------+---------------+-------------------------------------------------------------------------------------------+------------------|
|                   | ALLOW_WRITES       | Boolean       | true                                                                                      | true             |
| STORAGE_LOCATIONS | STORAGE_LOCATION_1 | String        | {"NAME":"my_storage_us_west","STORAGE_PROVIDER":"S3","STORAGE_BASE_URL":"s3://...", ...}  |                  |
| STORAGE_LOCATIONS | ACTIVE             | String        | my_storage_us_west                                                                        |                  |
+-------------------+--------------------+---------------+-------------------------------------------------------------------------------------------+------------------+
Linguagem: Português