Class ScanOptions

Options for a KV Range Scan.

Inheritance

object

ScanOptions

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Namespace: Couchbase.KeyValue.RangeScan

Assembly: Couchbase.NetClient.dll

Syntax

[InterfaceStability(Level.Volatile)]
public class ScanOptions

Constructors

ScanOptions()

Declaration

public ScanOptions()

Methods

ByteLimit(uint)

Sets the Byte Limit per batch. This will be applied to each stream individually, and acts as a target the server aims to reach.

Declaration

public ScanOptions ByteLimit(uint limit)

Parameters

Type	Name	Description
uint	limit

Returns

Type	Description
ScanOptions	A ScanOptions instance for chaining.

ConsistentWith(MutationState)

Provides a means of ensuring "read your own writes" or RYOW consistency on the current query.

Declaration

public ScanOptions ConsistentWith(MutationState mutationState)

Parameters

Type	Name	Description
MutationState	mutationState

Returns

Type	Description
ScanOptions	A ScanOptions instance for chaining.

IdsOnly(bool)

Do not return content.

Declaration

public ScanOptions IdsOnly(bool withoutContent)

Parameters

Type	Name	Description
bool	withoutContent	True to not send content.

Returns

Type	Description
ScanOptions	A ScanOptions instance for chaining.

ItemLimit(uint)

Sets the Item Limit per batch. This will be applied to each stream individually, and acts as a target the server aims to reach.

Declaration

public ScanOptions ItemLimit(uint limit)

Parameters

Type	Name	Description
uint	limit

Returns

Type	Description
ScanOptions	A ScanOptions instance for chaining.

ParentSpan(IRequestSpan)

Inject an external span which will be the parent span of the internal span(s).

Declaration

public ScanOptions ParentSpan(IRequestSpan parentSpan)

Parameters

Type	Name	Description
IRequestSpan	parentSpan	An IRequestSpan

Returns

Type	Description
ScanOptions	A ScanOptions instance for chaining.

RetryStrategy(IRetryStrategy)

Override the default retry strategy.

Declaration

public ScanOptions RetryStrategy(IRetryStrategy retryStrategy)

Parameters

Type	Name	Description
IRetryStrategy	retryStrategy	A IRetryStrategy instance.

Returns

Type	Description
ScanOptions	A ScanOptions instance for chaining.

TimeLimit(uint)

Sets the Time Limit in milliseconds for the scan to keep returning documents. This will be applied to each stream individually.

Declaration

public ScanOptions TimeLimit(uint limit)

Parameters

Type	Name	Description
uint	limit

Returns

Type	Description
ScanOptions	A ScanOptions instance for chaining.

Timeout(TimeSpan)

The timeout for the scan.

Declaration

public ScanOptions Timeout(TimeSpan timeSpan)

Parameters

Type	Name	Description
TimeSpan	timeSpan	A TimeSpan value specifying when the scan will timeout.

Returns

Type	Description
ScanOptions	A ScanOptions instance for chaining.

Token(CancellationToken)

A CancellationToken for cooperative cancellation.

Declaration

public ScanOptions Token(CancellationToken token)

Parameters

Type	Name	Description
CancellationToken	token

Returns

Type	Description
ScanOptions	A ScanOptions instance for chaining.

Remarks

Prefer to pass the token with WithCancellation on the stream that ScanAsync(IScanType, ScanOptions?) returns. The scan starts only when the stream is enumerated, so either token cancels the same scan. A future version will deprecate this method.

Transcoder(ITypeTranscoder)

Override the default transcoder.

Declaration

public ScanOptions Transcoder(ITypeTranscoder transcoder)

Parameters

Type	Name	Description
ITypeTranscoder	transcoder	A ITypeTranscoder instance.

Returns

Type	Description
ScanOptions	A ScanOptions instance for chaining.