Package com.couchbase.client.core.kv

Class RangeScanOrchestrator

java.lang.Object

com.couchbase.client.core.kv.RangeScanOrchestrator

@Internal
public class RangeScanOrchestrator
extends Object

Main entry point from higher level languages to perform KV range scans.

This class is meant as a low-level abstraction which is to be consumed from the higher level language bindings and not directly by the user. See the respective documentation for each language binding (java, scala, kotlin) for example usage.

Field Summary

Fields

Modifier and Type	Field	Description
static final int	RANGE_SCAN_DEFAULT_BATCH_BYTE_LIMIT
static final int	RANGE_SCAN_DEFAULT_BATCH_ITEM_LIMIT

Constructor Summary

Constructors

Constructor	Description
RangeScanOrchestrator(Core core, CollectionIdentifier collectionIdentifier)	Creates a new RangeScanOrchestrator which can be shared across calls.

Method Summary

Modifier and Type	Method	Description
Flux<CoreRangeScanItem>	rangeScan(CoreRangeScan rangeScan, CoreScanOptions options)	Performs a range scan between a start and an end term (reactive).
Flux<CoreRangeScanItem>	samplingScan(CoreSamplingScan samplingScan, CoreScanOptions options)	Performs a sampling scan (reactive).

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

RANGE_SCAN_DEFAULT_BATCH_BYTE_LIMIT

public static final int RANGE_SCAN_DEFAULT_BATCH_BYTE_LIMIT

See Also:

• Constant Field Values

RANGE_SCAN_DEFAULT_BATCH_ITEM_LIMIT

public static final int RANGE_SCAN_DEFAULT_BATCH_ITEM_LIMIT

See Also:

• Constant Field Values

Constructor Details

RangeScanOrchestrator

public RangeScanOrchestrator(Core core,
 CollectionIdentifier collectionIdentifier)

Creates a new RangeScanOrchestrator which can be shared across calls.

Parameters:

core - the core to perform ops against.

collectionIdentifier - the pointer to the right collection to use.

Method Details

rangeScan

public Flux<CoreRangeScanItem> rangeScan(CoreRangeScan rangeScan,
 CoreScanOptions options)

Performs a range scan between a start and an end term (reactive).

Parameters:

rangeScan -

options -

Returns:

a Flux of returned items, or a failed flux during errors.

samplingScan

public Flux<CoreRangeScanItem> samplingScan(CoreSamplingScan samplingScan,
 CoreScanOptions options)

Performs a sampling scan (reactive).

Parameters:

samplingScan -

options -

Returns:

a Flux of returned items, or a failed flux during errors.