Diese Seite wurde mit KI-Unterstützung aus dem Englischen übersetzt. Bei Abweichungen ist die englische Version maßgeblich.
DESCRIBE
Beschreibt eine Ressource oder eine bestimmte Methode einer Ressource.
Siehe auch: [ StackQL-Ressourcenhierarchie ]
Syntax
describeStatement::=
DESCRIBE [ METHOD ] [ EXTENDED ] <multipartIdentifier> ;
DESC [ EXTENDED ] <multipartIdentifier> ;
DESC wird beim Beschreiben einer Ressource als Alias für DESCRIBE akzeptiert; DESCRIBE METHOD erfordert das vollständige Schlüsselwort.
Antwort
- DESCRIBE
- DESCRIBE METHOD
| Spalte | Beschreibung |
|---|---|
name | Feldname |
type | Datentyp (string, integer, boolean, number, object, array) |
description | Feldbeschreibung (wenn EXTENDED angegeben ist) |
| Spalte | Beschreibung |
|---|---|
name | Feldname |
type | Datentyp (string, integer, boolean, number, object, array) |
param_type | input_required, input_optional oder output |
shape | JSON-Schema-Teilmenge für Objekt- und Array-Felder; leer bei Skalaren. Enthält verschachtelte properties, items, required, enum, default, description und optional boolesche Angaben, sofern der Provider sie bereitstellt (readOnly, writeOnly, deprecated) |
description | Feldbeschreibung (wenn EXTENDED angegeben ist) |
Beispiele
Einfache DESCRIBE-Anweisung
Führen Sie eine einfache DESCRIBE-Anweisung aus, um die Felder einer Ressource aus einer authentifizierten Sitzung aufzulisten.
-- Show the available fields in a Compute Engine resource
DESCRIBE google.compute.instances;
Erweiterte DESCRIBE-Anweisung
Führen Sie eine erweiterte DESCRIBE-Anweisung aus, um die Felder einer Ressource und ihre Beschreibungen aus einer authentifizierten Sitzung aufzulisten.
-- Show the available fields in a Compute Engine resource
DESCRIBE EXTENDED google.compute.instances;
DESC-Alias
DESC ist die Kurzform von DESCRIBE für eine Ressource, mit oder ohne EXTENDED. Sie wird überall dort als reine Leseanweisung behandelt, wo DESCRIBE es wird, einschließlich des Tools run_select_query des MCP-Servers in den Modi read_only und safe.
-- Same result as DESCRIBE EXTENDED google.compute.instances
DESC EXTENDED google.compute.instances;
Einfache DESCRIBE METHOD-Anweisung
Inspizieren Sie eine einzelne Methode einer Ressource. Das Ergebnis enthält Eingabeparameter und Antwortfelder; die verschachtelte Struktur wird in der Spalte shape dargestellt.
-- Show the inputs and outputs for the buckets.get method
DESCRIBE METHOD google.storage.buckets.get;
Erweiterte DESCRIBE METHOD-Anweisung
Führen Sie eine erweiterte DESCRIBE METHOD-Anweisung aus, um zusätzlich zur Struktur die Beschreibungen der einzelnen Felder einzuschließen.
-- Show inputs, outputs, and descriptions for the buckets.insert method
DESCRIBE METHOD EXTENDED google.storage.buckets.insert;
Eine INSERT-Payload ermitteln
DESCRIBE METHOD ist der kanonische Weg, um zu ermitteln, welche Felder ein INSERT (oder jede andere verändernde Methode) akzeptiert. Die Spalte shape enthält die verschachtelte Struktur, mit der Agenten und Menschen eine Payload in einer einzigen Abfrage erstellen können.
-- See what google.compute.instances.insert requires
DESCRIBE METHOD EXTENDED google.compute.instances.insert;