kv_multi_get_iterator()

#include <kvstore.h>

kv_error_tkv_multi_get_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_enumdepth,kv_direction_enum direction,
                      int batch_size,
                      kv_consistency_t *consistency,
                      kv_timeout_t timeout_ms) 

parent_keyに関連付けられた子孫key/valueペアの順序付けされたトラバースを許可するイテレータを返します。予想される結果セットが大きすぎてメモリーに収まらない場合に便利です。結果は非トランザクションであり、操作は読取りがコミットされた分離を効果的に指定することに注意してください。この実装は、イテレータ内のkey/valueペアのフェッチをバッチ処理し、使用可能な帯域幅を独占することなく、ネットワーク往復を最小限にします。

この関数では、parent_keyがNULLでなく、完全なメジャー・キー・パスを持つことが必要です。NULLキーまたは部分的なメジャー・キー・パスを持つキーに基づいてイテレータを取得する場合は、kv_store_iterator()をかわりに使用します。

パラメータ

• store

  storeパラメータは、イテレータが必要なストアへのハンドルです。

• parent_key

  parent_keyパラメータは、子レコードを取得する親キーです。NULLにはできません。メジャー・キー・パスは完全である必要があります。マイナー・キー・パスは省略しても部分パスでもかまいません。

• 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_FORWARDおよびkv_direction_enum.KV_DIRECTION_REVERSEのみがサポートされています。

• 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()を使用して設定されます。

関連項目

• データ操作および関連関数