DESCRIBE INDEX文

describe index文は、表の指定された索引の定義を提供します。

構文

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

セマンティクス

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

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

出力をJSON形式にする場合、AS JSONを指定できます。

例8-11 Describe Index

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

DESCRIBE INDEX idx1 on users2;
 
 +--------+------+-----------+----------+--------+--------------+-------------+
 | table  | name |   type    | multiKey | fields | declaredType | description |
 +--------+------+-----------+----------+--------+--------------+-------------+
 | Users2 | idx1 | SECONDARY | N        | income |              |             |
 +--------+------+-----------+----------+--------+--------------+-------------+

例8-12 Describe Index

次の文は、users2表の索引idx1に関する情報をJSON形式で提供します。

DESCRIBE AS JSON INDEX idx1 on users2;
 
{
  "name" : "idx1",
  "table" : "Users2",
  "type" : "secondary",
  "fields" : [ "income" ]
}