DESCRIBE SEARCH INDEX

指定した検索インデックスの定義をXML形式で示します。

制約事項: DSE Searchノードでのみ使用できるコマンドです。大きなデータセットに対して検索インデックスの管理コマンドを実行すると、CQLSHのデフォルトで指定された10分のタイムアウトよりも長くかかることがあります。必要に応じて、CQLSHクライアント・タイムアウトの値を引き上げてください。

構文

DESCRIBE (PENDING|ACTIVE) SEARCH INDEX (SCHEMA|CONFIG)
ON [keyspace_name.]table_name

表 1. 凡例
構文規則	説明
大文字	リテラル・キーワード。
小文字	リテラル以外。
`イタリック体`	変数値。ユーザー定義値と置き換えます。
`[]`	任意。角かっこ（ `[]` ）で任意指定のコマンド引数を囲みます。角かっこは入力しないでください。
`( )`	グループ。丸かっこ（`( )`）は、選択肢を含むグループを示します。丸かっこは入力しないでください。
`\|`	または。縦棒（ `\|` ）で代替要素を区切ります。要素のいずれかを入力してください。縦棒は入力しないでください。
`...`	繰り返し可能。省略記号（`...`）は、構文要素を必要な回数だけ繰り返すことができることを示します。
`'Literal string'`	単一引用符（ `'` ）でCQL文内のリテラル文字を囲みます。大文字を維持するには、単一引用符を使用します。
`{ key : value }`	マップ・コレクション。中かっこ（ `{ }` ）でマップ・コレクションまたはキーと値のペアを囲みます。コロンでキーと値を区切ります。
`<datatype1,datatype2>`	セット、リスト、マップ、またはタプル。山かっこ（`< >`）で、セット、リスト、マップまたはタプル内のデータ型を囲みます。データ型はコンマで区切ります。
`cql_statement;`	CQL文の終了。セミコロン（ `;` ）ですべてのCQL文を終了します。
`[--]`	コマンドライン・オプションとコマンド引数は、2つのハイフン（`--`）で区切ります。この構文は、引数がコマンドライン・オプションと間違われる可能性がある場合に役立ちます。
`' <schema> ...</schema> '`	検索CQLのみ：単一引用符（ `'` ）でXMLスキーマ宣言全体を囲みます。
`@xml_entity='xml_entity_type'`	検索CQLのみ：スキーマ・ファイルおよびsolrConfigファイル内のXML要素を上書きするための実体とリテラル値を示します。

EBNF

EBNF構文：

describeSearchIndex ::= 'DESCRIBE' ('PENDING' | 'ACTIVE') 'SEARCH' 'INDEX'
                        'ON' tableName
tableName           ::= (keyspace '.')? テーブル

レールロード・ダイアグラム：

ACTIVE: 現在適用されているインデックス構成リソース。
PENDING: 保留中でまだ適用されていないインデックス構成リソース。
SCHEMA: Solr内でインデックスを作成するフィールドと、それらのフィールドに関連付けられている型を記述します。これらのフィールドはデータベース・カラムにマップされます。
CONFIG: インデックスの構成情報を記述します。

例

wiki.solrのアクティブなインデックス構成を示します。

cqlsh> DESCRIBE ACTIVE SEARCH INDEX CONFIG ON wiki.solr;

結果はXML形式で以下のように表示されます。

/*
<field indexed="true" multiValued="false" name="b" stored="true" type="TextField"/>
<field docValues="false" indexed="true" multiValued="false" name="b_s" stored="false" type="StrField"/>
<copyField dest="b_s" source="b"/>
*/

wiki.solrの保留中のインデックス・スキーマを示します。

DESCRIBE PENDING SEARCH INDEX SCHEMA ON wiki.solr;