跳至主要內容
翻譯頁面

本頁面由英文在 AI 協助下翻譯而成。若兩者有出入,請以英文版本為準。

DESCRIBE

描述資源或資源上的特定方法。

另請參閱: [ StackQL 資源階層 ]


語法​

describeStatement::=

DESCRIBEMETHODEXTENDEDmultipartIdentifier';'

   

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

描述資源時,DESC 可作為 DESCRIBE 的別名;DESCRIBE METHOD 則必須使用完整關鍵字。

回應​

資料行描述
name欄位名稱
type資料型別(string、integer、boolean、number、object、array)
description欄位描述(若提供 EXTENDED)

範例​

基本 DESCRIBE 陳述式​

從已驗證的工作階段執行基本 DESCRIBE 陳述式,以列出資源中的欄位。

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

延伸 DESCRIBE 陳述式​

從已驗證的工作階段執行延伸 DESCRIBE 陳述式,以列出資源中的欄位及其描述。

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

DESC 別名​

DESC 是對資源使用 DESCRIBE 時的簡寫,可搭配或不搭配 EXTENDED。凡是 DESCRIBE 被視為唯讀陳述式之處,它也同樣被視為唯讀陳述式,包括 read_only 和 safe 模式下 MCP 伺服器的 run_select_query 工具。

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

基本 DESCRIBE METHOD 陳述式​

檢查資源上的單一方法。結果包含輸入參數和回應欄位,巢狀結構則呈現在 shape 資料行中。

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

延伸 DESCRIBE METHOD 陳述式​

執行延伸 DESCRIBE METHOD 陳述式,除了 shape 之外,也包含每個欄位的描述。

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

探索 INSERT 承載​

DESCRIBE METHOD 是探索 INSERT(或任何變更方法)接受哪些欄位的標準方式。shape 資料行帶有巢狀結構,代理程式和人員都能用它在一次查詢中建構承載。

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