package protocol.sdk.kv.rangescan
Get desktop application:
View/edit binary Protocol Buffers messages
Moved to new message containing from and to
Used in:
optional from = 1
optional to = 2
Used in:
oneof range
Only one of these will be passed. If your SDK isn't planning to support doc_id_prefix we will disable those tests through caps or some other method
from_to = 1
string doc_id_prefix = 2
This was created and named before it became "a first class part of the API". Rather than break existing implementations this will remain the same, but now represents the PrefixScan ScanType
Used in:
uint64 limit = 1
optional uint64 seed = 2
A Scan will result in the performer sending back a stream of (in the golden path): (1) A stream.Created result with type STREAM_KV_RANGE_SCAN, followed by (2) Zero or more ScanResult results (and/or streams.Error), followed by (1) A stream.Complete result. A streams.CancelRequest from the driver should be handled per the RFC - with a range scan cancellation sent to KV on each vbucket stream.
Used in:
optional collection = 1
optional scan_type = 2
optional options = 3
optional stream_config = 4
Not sent on to the SDK - instead specifies how the performer should handle the streaming.
optional content_as = 5
Controls how all ScanResult.contentAs() calls are done by the SDK for this scan. If not specified, the performer should not do contentAs. If there is any error from result.contentAs(), each error needs to raise a streams.Error, instead of the normal ScanResult.
Used in:
optional bool ids_only = 1
Renamed in the RFC. Used to be "without_content" and will need changing in performers
optional consistent_with = 2
optional ScanSort sort = 3
Sorting is not supported for RangeScans anymore.
optional transcoder = 4
optional int32 timeout_msecs = 5
optional string parent_span_id = 6
As usual, parent_span_id will only be sent if the performer declares support for Caps.OBSERVABILITY_1
optional uint32 batch_byte_limit = 7
optional uint32 batch_item_limit = 8
optional uint32 batch_time_limit = 9
Since this isn't going to be present in all sdks then the logic to not use it will be on the test-driver side with @ignoreWhen
optional uint32 concurrency = 10
Since all SDKs do not support this option the logic to not use it will be on the driver side with @ignoreWhen
Used in:
string id = 1
optional content = 2
Following three fields shouldn't be present if withoutContent was set.
This field should also be empty if the test did not set ContentAs in the Scan message
optional int64 expiry_time = 3
Represented as the number of seconds since January 1, 1970 (e.g. what the server returns)
optional int64 cas = 4
string stream_id = 5
Not part of the SDK response - identifies what stream this is from.
bool id_only = 6
Returns the value of idsOnly from the scan associated with the result
Sorting is not supported for RangeScans anymore.
Used in:
KV_RANGE_SCAN_SORT_NONE = 0
KV_RANGE_SCAN_SORT_ASCENDING = 1
Used in:
oneof term
This is now stored as a string and the user can only pass a string. Deprecating the bytes method but not removing for the same reasons as below
string as_string = 1
bytes as_bytes = 2
optional bool exclusive = 3
If exclusive is set to false then the SDK should explicitly set it to false not leave it as default
Used in:
oneof choice
bool minimum = 1
These options are deprecated as they were removed from the RFC. I have not removed them as it breaks compilation on existing uses which will slow down this work. Please remove when you can
bool maximum = 2
term = 3
bool default = 4
Since the behaviour if a term is not supplied is to use min for from and max for to then this option is to represent the user not supplying any term
Used in:
oneof type
range = 1
sampling = 2