NAME
Etcd3::Range
DESCRIPTION
Range gets the keys in the range from the key-value store.
endpoint
key
key is the first key for the range. If range_end is not given, the request only looks up key. the key is encoded with base64. type bytes
range_end
range_end is the upper bound on the requested range [key, range_end). If range_end is '\0', the range is all keys >= key. If the range_end is one bit larger than the given key, then the range requests get the all keys with the prefix (the given key). If both key and range_end are '\0', then range requests returns all keys. the key is encoded with base64. type bytes. NOTE: If range_end is not given, the request only looks up key.
limit
limit is a limit on the number of keys returned for the request. type int64
revision
revision is the point-in-time of the key-value store to use for the range. If revision is less or equal to zero, the range is over the newest key-value store. If the revision has been compacted, ErrCompaction is returned as a response. type int64
sort_order
sort_order is the order for returned sorted results.
sort_target
sort_target is the key-value field to use for sorting.
serializable
serializable sets the range request to use serializable member-local reads. Range requests are linearizable by default; linearizable requests have higher latency and lower throughput than serializable requests but reflect the current consensus of the cluster. For better performance, in exchange for possible stale reads, a serializable range request is served locally without needing to reach consensus with other nodes in the cluster.
keys_only
keys_only when set returns only the keys and not the values.
count_only
count_only when set returns only the count of the keys in the range.
min_mod_revision
min_mod_revision is the lower bound for returned key mod revisions; all keys with lesser mod revisions will be filtered away.
max_mod_revision
max_mod_revision is the upper bound for returned key mod revisions; all keys with greater mod revisions will be filtered away.
min_create_revision
min_create_revision is the lower bound for returned key create revisions; all keys with lesser create revisions will be filtered away.
max_create_revision
max_create_revision is the upper bound for returned key create revisions; all keys with greater create revisions will be filtered away.
json_args
arguments that will be sent to the api