kv_store_iterator()
#include <kvstore.h>
kv_error_t
kv_store_iterator(kv_store_t *store,
const kv_key_t *parent_key,
kv_iterator_t **return_iterator,
const kv_key_range_t *sub_range,
kv_depth_enum depth,
kv_direction_enum direction,
int batch_size,
kv_consistency_t *consistency,
kv_timeout_t timeout_ms)
すべてのkey/valueペアを未ソートの順序で反復処理するイテレータを作成します。結果は非トランザクションであり、操作は読取りがコミットされた分離性を効果的に実現します。この実装は、イテレータ内のkey/valueペアのフェッチをバッチ処理し、使用可能な帯域幅を独占することなく、ネットワーク往復を最小限にします。
この関数はkv_multi_get_iterator()とは異なり、parent_keyをNULLにでき、部分的なメジャー・キー・パスのみを持ちます。
パラメータ
-
store
storeパラメータは、イテレータが必要なストアへのハンドルです。
-
parent_key
parent_keyパラメータは、子レコードを取得する親キーです。
-
return_iterator
return_iteratorパラメータは、結果セットのコピー先となるメモリーを参照します。kv_release_iterator()を使用して、このイテレータによって使用されるリソースを解放します。
-
sub_range
sub_rangeパラメータは、parent_keyの下位の範囲を、このキー範囲のマイナー・パス・コンポーネントにまで、さらに制限します。NULLである可能性があります。
キー範囲は、kv_init_key_range()を使用して構築します。
-
depth
depthパラメータは、取得が可能な深さを指定します。子のみ、親とすべての子、すべての子孫などの取得を許可できます。すべての深さオプションについては、kv_depth_enumを参照してください。
-
direction
directionパラメータは、イテレータによってレコードが返される順序を指定します。この関数では、
kv_direction_enum.KV_DIRECTION_UNORDERED
のみがサポートされています。 -
batch_size
batch_sizeパラメータは、各ネットワーク・ラウンド・トリップ中にフェッチするレコードの推奨数を提供します。最初または最後のkey/valueペアのみが必要な場合は、値1を渡すことをお薦めします。ゼロの場合は、内部で決定されたデフォルトが使用されます。
-
consistency
consistencyパラメータは、この読取り操作で使用する一貫性ポリシーを識別します。一貫性ポリシーは、kv_create_simple_consistency()、kv_create_time_consistency()またはkv_create_version_consistency()を使用して作成されます。
-
timeout_ms
timeout_msパラメータは、操作を処理するための時間間隔の上限を指定します。指定された限度を超えないよう最善が尽くされます。ゼロの場合は、デフォルトの要求タイムアウトが使用されます。デフォルトの要求タイムアウトは、kv_config_set_timeouts()を使用して設定されます。
関連項目