DESCRIBE INDEX文

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

構文

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

セマンティクス

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

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

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

例8-17

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

DESCRIBE AS JSON INDEX idx_income1 ON UserInfo

出力:

{  
   "name" : "idx_income1",
   "type" : "secondary", 
   "fields" : ["info.income"],  
   "types" : ["ANY_ATOMIC"],  
   "withNoNulls" : false,  
   "withUniqueKeysPerRow" : false
}

例8-18

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

DESCRIBE AS JSON INDEX idx_phones ON UserInfo

出力:

{
  "name" : "idx_phones", 
  "type" : "secondary",  
  "fields" : ["info.phones[].number"],  
  "types" :  ["INTEGER"], 
  "withNoNulls" : false,  
  "withUniqueKeysPerRow" : true
}

例8-19

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

 DESCRIBE AS JSON INDEX idx_modtime ON users

出力:

{
  "name" : "idx_modtime",
  "type" : "secondary",
  "fields" : ["modification_time#"],
  "withNoNulls" : false,
  "withUniqueKeysPerRow" : false
}

例8-20

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

 DESCRIBE AS JSON INDEX idx_showid_year_month ON stream_acct

出力:

{
  "name" : "idx_showid_year_month",
  "type" : "secondary",
  "fields" : ["acct_data.contentStreamed[].showId", "substring#acct_data.contentStreamed[].seriesInfo[].episodes[].date@,0,4", "substring#acct_data.contentStreamed[].seriesInfo[].episodes[].date@,5,2"],
  "types" : ["INTEGER", "STRING", "STRING"],
  "withNoNulls" : false,
  "withUniqueKeysPerRow" : false
}