DESCRIBE INDEX文

DESCRIBE INDEX文は、表の指定された索引を定義します。

構文

describe_index_statement ::=
    (DESCRIBE | DESC) [AS JSON] INDEX index_name ON table_name

セマンティクス

出力をJSON形式にする場合、オプションのAS JSONを指定できます。

索引の説明には、次の情報が含まれます。

• 索引が定義される表の名前。
• 索引の名前。
• 索引のタイプ。索引が主索引であるか2次索引であるか。
• 索引が複数キーかどうか。索引が複数キーの場合は、「Y」が表示されます。それ以外の場合は、「N」が表示されます。
• 索引が定義されるフィールドのリスト。
• 索引の宣言された型。
• 索引の説明。

例8-14 Describe Index

次の文は、UserInfo表の索引indexdemo1に関する情報を提供します。

DESCRIBE AS JSON INDEX indexdemo1 ON UserInfo;
{
  "name" : "indexdemo1",
  "type" : "secondary",
  "fields" : ["info.age"],
  "types" : ["ANYATOMIC"]
}