case class ScanOptions(timeout: Duration = Duration.MinusInf, parentSpan: Option[RequestSpan] = None, retryStrategy: Option[RetryStrategy] = None, transcoder: Option[Transcoder] = None, idsOnly: Option[Boolean] = None, consistentWith: Option[MutationState] = None, batchByteLimit: Option[Int] = None, batchItemLimit: Option[Int] = None) extends Product with Serializable

Provides control over how a KV range scan is performed.

Linear Supertypes
Serializable, Product, Equals, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. ScanOptions
  2. Serializable
  3. Product
  4. Equals
  5. AnyRef
  6. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new ScanOptions(timeout: Duration = Duration.MinusInf, parentSpan: Option[RequestSpan] = None, retryStrategy: Option[RetryStrategy] = None, transcoder: Option[Transcoder] = None, idsOnly: Option[Boolean] = None, consistentWith: Option[MutationState] = None, batchByteLimit: Option[Int] = None, batchItemLimit: Option[Int] = None)

Value Members

  1. def batchByteLimit(value: Int): ScanOptions

    Controls how many bytes are sent from the server to the client on each partition batch.

    Controls how many bytes are sent from the server to the client on each partition batch.

    If both this and batchItemLimit are set, the lowest wins.

    returns

    a copy of this with the change applied, for chaining.

  2. def batchItemLimit(value: Int): ScanOptions

    Controls how many documents are sent from the server to the client on each partition batch.

    Controls how many documents are sent from the server to the client on each partition batch.

    If both this and batchByteLimit are set, the lowest wins.

    returns

    a copy of this with the change applied, for chaining.

  3. def consistentWith(value: MutationState): ScanOptions

    The KV range scan will wait until this mutation has been consistently applied.

    The KV range scan will wait until this mutation has been consistently applied.

    returns

    a copy of this with the change applied, for chaining.

  4. def idsOnly(value: Boolean): ScanOptions

    Just returns each document's id - not the CAS, expiry or content.

    Just returns each document's id - not the CAS, expiry or content.

    returns

    a copy of this with the change applied, for chaining.

  5. def parentSpan(value: Option[RequestSpan]): ScanOptions

    Changes the parent span setting used for this operation.

    Changes the parent span setting used for this operation.

    This allows tracing requests through a full distributed system.

    This Option-overload is provided as a convenience to help with chaining.

    returns

    a copy of this with the change applied, for chaining.

  6. def parentSpan(value: RequestSpan): ScanOptions

    Changes the parent span setting used for this operation.

    Changes the parent span setting used for this operation.

    This allows tracing requests through a full distributed system.

    returns

    a copy of this with the change applied, for chaining.

  7. def productElementNames: Iterator[String]
    Definition Classes
    Product
  8. def retryStrategy(value: RetryStrategy): ScanOptions

    Provides some control over how the SDK handles failures.

    Provides some control over how the SDK handles failures. Will default to retryStrategy() in the provided com.couchbase.client.scala.env.ClusterEnvironment, which by default is BestEffortRetryStrategy; this will automatically retry some operations (e.g. non-mutating ones, or mutating operations that have unambiguously failed before they mutated state) until the chosen timeout.

    returns

    a copy of this with the change applied, for chaining.

  9. def timeout(value: Duration): ScanOptions

    Changes the timeout setting used for this operation.

    Changes the timeout setting used for this operation.

    When the operation will timeout. This will default to timeoutConfig().kvScanTimeout() in the com.couchbase.client.scala.env.ClusterEnvironment.

    returns

    a copy of this with the change applied, for chaining.

  10. def transcoder(value: Transcoder): ScanOptions

    Changes the transcoder used for this operation.

    Changes the transcoder used for this operation.

    The transcoder provides control over how JSON is converted in the returned ScanResult.

    If not specified it will default to to transcoder() in the com.couchbase.client.scala.env.ClusterEnvironment.

    returns

    a copy of this with the change applied, for chaining.