Pular para o conteúdo principal
Página traduzida

Esta página foi traduzida do inglês com assistência de IA. Se houver diferenças entre as duas, a versão em inglês é a referência.

DESCRIBE

Descreve um recurso ou um método específico de um recurso.

Veja também: [ Hierarquia de recursos do StackQL ]


Sintaxe​

describeStatement::=

DESCRIBEMETHODEXTENDEDmultipartIdentifier';'

   

DESCRIBE [ METHOD ] [ EXTENDED ] <multipartIdentifier> ;
DESC [ EXTENDED ] <multipartIdentifier> ;

DESC é aceito como alias de DESCRIBE ao descrever um recurso; DESCRIBE METHOD exige a palavra-chave completa.

Resposta​

ColunaDescrição
nameNome do campo
typeTipo de dados (string, integer, boolean, number, object, array)
descriptionDescrição do campo (se EXTENDED for informado)

Exemplos​

Instrução DESCRIBE básica​

Execute uma instrução DESCRIBE básica para listar os campos de um recurso a partir de uma sessão autenticada.

-- Show the available fields in a Compute Engine resource
DESCRIBE google.compute.instances;

Instrução DESCRIBE estendida​

Execute uma instrução DESCRIBE estendida para listar os campos de um recurso e suas descrições a partir de uma sessão autenticada.

-- Show the available fields in a Compute Engine resource
DESCRIBE EXTENDED google.compute.instances;

Alias DESC​

DESC é a forma abreviada de DESCRIBE para um recurso, com ou sem EXTENDED. Ele é tratado como uma instrução somente leitura em todos os lugares em que DESCRIBE é, incluindo a ferramenta run_select_query do servidor MCP nos modos read_only e safe.

-- Same result as DESCRIBE EXTENDED google.compute.instances
DESC EXTENDED google.compute.instances;

Instrução DESCRIBE METHOD básica​

Inspecione um único método de um recurso. O resultado inclui os parâmetros de entrada e os campos da resposta, com a estrutura aninhada representada na coluna shape.

-- Show the inputs and outputs for the buckets.get method
DESCRIBE METHOD google.storage.buckets.get;

Instrução DESCRIBE METHOD estendida​

Execute uma instrução DESCRIBE METHOD estendida para incluir as descrições de cada campo junto com o formato.

-- Show inputs, outputs, and descriptions for the buckets.insert method
DESCRIBE METHOD EXTENDED google.storage.buckets.insert;

Descobrir o payload de um INSERT​

DESCRIBE METHOD é a forma canônica de descobrir quais campos um INSERT (ou qualquer método de mutação) aceita. A coluna shape traz a estrutura aninhada que agentes e pessoas podem usar para montar um payload em uma única consulta.

-- See what google.compute.instances.insert requires
DESCRIBE METHOD EXTENDED google.compute.instances.insert;