dsetool create_core

ローカル・ノードに検索インデックス・テーブルを作成します。

ローカル・ノードに検索インデックス・テーブルを作成します。[-l username -p password]のDSE認証をサポートしています。

検索インデックスを作成するためのCQLコマンドはCREATE SEARCH INDEXです。

制約事項: コマンドは、DSE Searchワークロードを持つノードでのみサポートされます。
自動生成されたスキーマでは、デフォルトのDocValuesが有効になっています。docValuesの詳細については、「デフォルト値を使用した検索インデックスの作成」を参照してください。
注: 1つ以上のノードで分散操作のコアの作成に失敗すると、失敗しているノード(単数または複数)がエラー・メッセージに示されます。すぐにコアの作成に失敗した場合は、createをもう一度発行します。いくつかのノードで作成に失敗した場合は、それらのノードに対してreloadを発行して、新たに作成されたコアを読み込みます。

構文

dsetool create_core keyspace_name.table_name 
[coreOptions=yamlFile | coreOptionsInline=key1:value1#key2:value2#...]
[distributed=true|false]
[generateResources=true|false]
[schema=path]
[solrconfig=path]
1. 凡例
構文規則 説明
大文字 リテラル・キーワード。
小文字 リテラル以外。
Italics 変数値。有効なオプションまたはユーザー定義値と置き換えます。
[ ] 任意。角かっこ( [] )で任意のコマンド引数を囲みます。角かっこは入力しないでください。
( ) グループ。丸かっこ(( ))は、選択肢を含むグループを示します。丸かっこは入力しないでください。
| または。縦棒(|)で代替要素を区切ります。要素のいずれかを入力してください。縦棒は入力しないでください。
... 繰り返し可能。省略記号(...)は、構文要素を必要な回数だけ繰り返すことができることを示します。
'Literal string' 単一引用符( ' )でCQL文内のリテラル文字を囲みます。大文字を維持するには、単一引用符を使用します。
{ key:value } マップ・コレクション。中かっこ( { } )でマップ・コレクションまたはキーと値のペアを囲みます。コロンでキーと値を区切ります。
<datatype1,datatype2> セット、リスト、マップ、またはタプル。山かっこ(< >)で、セット、リスト、マップまたはタプル内のデータ型を囲みます。データ型をカンマで区切ります。
cql_statement; CQL文の終了。セミコロン( ; )ですべてのCQL文を終了します。
[ -- ] コマンドライン・オプションとコマンド引数は、2つのハイフン(--)で区切ります。この構文は、引数がコマンドライン・オプションと間違われる可能性がある場合に役立ちます。
' <schema> ...</schema> ' 検索CQLのみ:単一引用符( ' )でXMLスキーマ宣言全体を囲みます。
@xml_entity='xml_entity_type' 検索CQLのみ:スキーマ・ファイルおよびsolrconfigファイル内のXML要素を上書きする実体とリテラル値を示します。
keyspace_name.table_name
必須。検索インデックスのキースペース名とテーブル名。キースペース名とテーブル名の大文字と小文字は区別されます。大文字を含む名前は二重引用符で囲みます。
coreOptions=yamlFile
generateResources=trueの場合は、オプションのカスタマイズされたYAML形式のファイルを指定します。ファイルの内容は、coreOptionsInlineで指定できる同じオプションです。自動生成の検索インデックスの設定の変更」を参照してください。
coreOptionsInline=key1:value1#key2:value2#...
このキーと値のペアの構文key1:value1#key2:value2#を使用して、以下の設定の値を指定します。「自動生成の検索インデックスの設定の変更」を参照してください。
auto_soft_commit_max_time:ms
最大自動ソフト・コミット時間(ミリ秒)。
default_query_field:field
クエリーでフィールドが指定されていないときに使用するクエリー・フィールド。
enable_string_copy_fields:( true | false )
true | false - 非キー・テキスト・フィールドの非格納の文字列のコピーを生成します。テキスト・データはトークンが付いている場合も付いていない場合もあります。trueにすると、格納されずトークンも付いていないコピー・フィールドを作成するので、両方の方法でテキストを所有できます。デフォルト:false。
exclude_columns: col1, col2, col3, ...
除外するカラムのコンマ区切り(CSV)リスト。
generate_DocValues_for_fields: ( * | field1, field2, ...
生成された検索インデックス・スキーマでDocValuesを自動的に構成するためのフィールドを指定します。可能なフィールドをすべて追加するには、'*'を指定します。
generate_DocValues_for_fields: '*' 
または、フィールドのコンマ区切りリストを指定します。例を以下に示します。
generate_DocValues_for_fields: uuidfield, bigintfield
注: Solrは、ブーリアン・フィールドではDocValueをサポートしていません。
distributed=true | false
ローカル・データ・センター内のすべてのノードに操作を配布して適用するかどうかを指定します。
  • trueの場合、ローカル・データ・センターのすべてのノードに操作を適用します。
  • Falseを指定すると、操作は送信先のノードのみに適用されます。falseが機能するのはrecovery=trueの場合のみです。

デフォルト:true

警告: 再作成したインデックスをデータ・センター全体に配布すると、そのデータ・センターのパフォーマンスが大きく低下します。
generateResources=true | false
既存のCQLテーブル・メタデータに基づき、検索インデックス・リソースを自動的に生成するかどうかを指定します。schema=およびsolrconfig=とともに使用することはできません。
有効な値:
  • true - リソースが存在しない場合、検索インデックス・スキーマと構成リソースを自動的に生成します。
  • false - デフォルト。検索インデックス・リソースは自動的に生成されません。
include_columns
含めるカラムのコンマ区切り(CSV)リスト。空の場合は、すべてのカラムが含まれます。
index_merge_factor
1つのセグメントにマージする前に作成できる同等サイズのセグメントの数。
index_ram_buffer_size
インデックスRAMバッファー・サイズ(MB)。
lenient
サポートされていない型のカラムが検出されても、エラーで終了せず、そのカラムを無視して引き続きリソースを生成します。デフォルト:false
resource_generation_profiles
インデックスのサイズを最小化するには、リソースの生成時に適用するプロファイルのCSVリストを指定します。
2. リソース生成プロファイル
プロファイル名 説明
spaceSavingAll spaceSavingNoJoinおよびspaceSavingSlowTriePrecisionプロファイルを適用します。
spaceSavingNoJoin 非表示のプライマリ・キー・フィールドのインデックスを作成しません。コア全体での結合を防ぎます。
spaceSavingSlowTriePrecision トライ・フィールドprecisionStepを「0」に設定すると、領域を大幅に節約できますがクエリーの速度は低下します。
注: spaceSavingsプロファイルを使用すると、DocValuesの自動生成が無効になります。
例を次に示します。
resource_generation_profiles: spaceSavingNoJoin, spaceSavingSlowTriePrecision
rt
インデックス作成のスループットを高めるためにライブ・インデックス作成を有効にします。クラスターごとに1つの検索インデックスでのみライブ・インデックス作成を有効にします。
rt=true
recovery=( true | false )
破損していて検索インデックスを読み込めない場合に削除してから再作成するかどうかを指定します。有効な値:
  • true - 検索インデックスを読み込めない場合、削除してから再作成してインデックスを復元します。
  • false - デフォルト。再作成しません。
reindex=( true | false )
generateResources=trueで検索インデックスを自動生成する場合にデータのインデックスを再作成するかどうかを指定します。インデックスの再作成は、データ・センター(DC)レベルで行われます。インデックスの再作成は、検索が有効なDCごとに1回だけ行われます。必要に応じて、その他のデータ・センターでreindexコマンドを繰り返します。
有効な値:
  • true - デフォルト。データのインデックスが再作成されます。新しいインデックスの作成中に読み取りを受け入れて現在の検索インデックスを保持します。
  • false - データのインデックスは再作成されません。インデックスを作成する前に検索インデックス・リソースを確認してカスタマイズできます。
schema=path
UTF-8でエンコードされた検索インデックス・スキーマ・ファイルのパス。generateResources=trueの場合は指定できません。
solrconfig=path
UTF-8でエンコードされた検索インデックス構成ファイルのパス。generateResources=trueの場合は指定できません。

デモ・キースペースでhealth_dataテーブルの検索インデックスを自動的に生成する

dsetool create_core demo.health_data generateResources=true

デフォルトをオーバーライドして既存のデータのインデックスを再作成し、reindex=trueオプションを指定する

dsetool create_core demo.health_data generateResources=true reindex=true

generateResources=trueオプションは、solr_resourcesテーブルにリソースが存在しない場合にのみリソースを生成します。

YAML形式のファイルでオプションを使用する

リアルタイム(RT)インデックス作成としても知られるライブ・インデックス作成をオンにする場合、rt.yamlの内容はrt: trueです。

dsetool create_core udt_ks.users generateResources=true reindex=true coreOptions=rt.yaml

インライン・オプションを使用して暗号化を有効にする

directoryFactoryのクラスをsolr.EncryptedFSDirectoryFactoryに指定します。
dsetool create_core keyspace_name.table_name generateResources=true coreOptionsInline="directory_factory_class:solr.EncryptedFSDirectoryFactory"
dsetool create_core demo.health_data generateResources=true coreOptionsInline="directory_factory_class:solr.EncryptedFSDirectoryFactory"