DESCRIBE

Describe un recurso o un método concreto de un recurso.

Consulte también: [ Jerarquía de recursos de StackQL ]

---

Sintaxis

describeStatement::=

   

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

DESC se acepta como alias de DESCRIBE al describir un recurso; DESCRIBE METHOD requiere la palabra clave completa.

Respuesta

DESCRIBE

Columna	Descripción
name	Nombre del campo
type	Tipo de datos (string, integer, boolean, number, object, array)
description	Descripción del campo (si se especifica EXTENDED)

DESCRIBE METHOD

Columna	Descripción
name	Nombre del campo
type	Tipo de datos (string, integer, boolean, number, object, array)
param_type	input_required, input_optional u output
shape	Subconjunto de JSON Schema para los campos de tipo objeto y array; vacío para los escalares. Incluye los elementos anidados properties, items, required, enum, default, description y, opcionalmente, booleanos si el provider los proporciona (readOnly, writeOnly, deprecated)
description	Descripción del campo (si se especifica EXTENDED)

---

Ejemplos

Instrucción DESCRIBE básica

Ejecute una instrucción DESCRIBE básica para enumerar los campos de un recurso desde una sesión autenticada.

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

Instrucción DESCRIBE extendida

Ejecute una instrucción DESCRIBE extendida para enumerar los campos de un recurso y sus descripciones desde una sesión autenticada.

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

Alias DESC

DESC es la forma abreviada de DESCRIBE sobre un recurso, con o sin EXTENDED. Se trata como una instrucción de solo lectura en todos los lugares donde DESCRIBE lo es, incluida la herramienta run_select_query del servidor MCP en los modos read_only y safe.

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

Instrucción DESCRIBE METHOD básica

Inspeccione un único método de un recurso. El resultado incluye los parámetros de entrada y los campos de la respuesta, con la estructura anidada representada en la columna shape.

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

Instrucción DESCRIBE METHOD extendida

Ejecute una instrucción DESCRIBE METHOD extendida para incluir las descripciones de cada campo junto con la forma.

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

Descubrir la carga útil de un INSERT

DESCRIBE METHOD es la forma canónica de descubrir qué campos acepta un INSERT (o cualquier método de mutación). La columna shape contiene la estructura anidada que los agentes y las personas pueden usar para construir una carga útil con una sola consulta.

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