概要
config 句は、クエリのリアルタイム設定に使用されるクエリステートメントの必須部分です。たとえば、config 句を使用して、オフセット、返されるレコード数、クエリ結果の形式、クエリのタイムアウト期間を指定できます。
構文
config=key1:value1,key2:value2...
key1 と key2 は以下の表に記載されているパラメータに、value1 と value2 はパラメータの有効な値に置き換えることができます。
パラメータ | 有効な値 | デフォルト値 | 説明 |
start | NUMBER | 0 | 結果セット内でシステムがドキュメントの返却を開始するオフセット値。 |
hit | NUMBER | 10 | 各結果セット内のドキュメントの最大数。 |
format | json, xml | xml | クエリ結果の形式。 |
rank_trace | FATAL, ERROR, INFO, DEBUG, WARN, TRACE1, TRACE2, TRACE3 | なし | フロントエンドにおけるドキュメントのスコアリングプロセスに関する出力情報。 |
default_index | string | "" | このクエリで使用されるデフォルトインデックス。デフォルトインデックスは、クラスタ構成ファイルの query_config 構成項目で指定されたインデックスと同じです。クエリで指定したインデックスがデフォルトインデックスとして使用されます。クエリでインデックスを指定しない場合は、query_config 構成項目で指定されたインデックスが使用されます。 |
default_operator | AND, OR | "" | クエリで使用されるデフォルト演算子。デフォルト演算子は、クラスタ構成ファイルの query_config 構成項目で指定された演算子と同じです。クエリで演算子を指定した場合、クエリで指定された演算子が優先的にデフォルト演算子として使用されます。クエリで演算子を指定しない場合は、query_config 構成項目で指定された演算子が使用されます。 |
timeout | NUMBER | 0 | クエリのタイムアウト期間。単位：ミリ秒。値は負の数にすることはできません。 |
seek_timeout | NUMBER | 0 | クエリシークフェーズのタイムアウト期間。単位：ミリ秒。デフォルト値：0。デフォルトでは、指定されたタイムアウト期間に 0.7 を乗算した値がシークタイムアウト期間として使用されます。 |
no_summary | no, yes | no | このパラメータが yes に設定されている場合、第1フェーズのクエリのみが実行され、サマリーはクエリされません。 |
dedup | no, yes | yes | このパラメータが yes に設定されている場合、プライマリキーに基づいて重複が結果から自動的に削除されます。このパラメータが no に設定されている場合、重複は結果から削除されません。 |
searcher_return_hits | NUMBER | 0 | サーチャーによって返されるレコードの数。値が 0 の場合、レコードは start パラメータと hit パラメータの値に基づいて返されます。searcher_return_hits パラメータの値は 5000 を超えることはできません。 |
actual_hits_limit | NUMBER | 0 | totalhits パラメータの値が実際の値か推定値かを指定します。返されたレコードの実際の数が actual_hits_limit パラメータの値より小さい場合は、実際の値が返されます。返されたレコードの実際の数が actual_hits_limit パラメータの値より大きい場合は、推定値が返されます。返されたレコードの実際の数が 0 の場合は、推定値が返されます。numeric_limits<uint32_t>::max() 条件が満たされた場合は、実際の値が返されます。 |
sourceid | string | なし | オンラインインデックスには複数のレプリカを使用できます。レプリカに sourceid パラメータを設定しない場合、クエリごとにレプリカがランダムに選択されます。インデックスがインクリメンタルに更新されると、更新されたデータがすべてのレプリカに同期されない場合があります。その結果、最新のクエリ結果が返されない可能性があります。sourceid パラメータの値を指定すると、sourceid パラメータのハッシュ値に基づいてクエリ用のレプリカが選択されます。この場合、同じ sourceid パラメータ値を使用するユーザーは最新のデータをクエリできます。sourceid パラメータの値は文字列型です。 |
rerank_hint | BOOL | false | クエリに対して2回目のスコアリングプロセスを実行するかどうかを指定します。 |
rank_size | NUMBER | 0 | 大まかにソートされるドキュメントの数、または rank_size パラメータに基づいて動的に切り捨てられるドキュメントの数。このパラメータの値が 0 の場合、構成ファイルの値が使用されます。 |
rerank_size | NUMBER | 0 | 最初のスコアリングプロセスで細かくソートされるドキュメントの数。このパラメータの値が 0 の場合、構成ファイルの値が使用されます。 |
total_rank_size | NUMBER | 0 | すべてのパーティションで大まかにソートされるドキュメントの合計、または動的インデックスに基づいて切り捨てられるドキュメントの数。このパラメータの値が no の場合、構成ファイルの値が使用されます。 |
total_rerank_size | NUMBER | 0 | 各パーティションの最初のスコアリングプロセスで細かくソートされるドキュメントの合計。このパラメータの値が 0 の場合、構成ファイルの値が使用されます。 |
fetch_summary_type | docid, pk, rawpk | docid | サマリーを取得するために使用されるメソッド。デフォルトでは、サマリーは docid に基づいて取得されます。プライマリキーのハッシュ値または元の値に基づいてサマリーを取得するように指定することもできます。プライマリキーのハッシュ値または元の値に基づいてサマリーを取得することをお勧めします。 |
research_threshold | NUMBER | 0 | レコード数がこのパラメータの値より少ない場合、クエリが再実行されます。 |
例
config 句を使用してページングを設定します。この例では、返される結果の各ページに 20 件のドキュメントが表示されます。
# 最初のページの config 句。
config=start:0, hit:20, format:xml
# 2 番目のページの config 句。
config=start:20, hit:20, format:xml詳細ソート式でソートされるドキュメントの数を 1000 に設定します。
config=start:0, hit:20, rerank_size:1000使用上の注意
各パラメータのキーと値をコロン (:) で区切ります。
start パラメータと hit パラメータの値の合計が 5,000 を超えないようにしてください。超えるとエラーが発生し、結果は返されません。