Type Members

1.  case class AppendOptions(cas: Long = 0, durability: Durability = Disabled, timeout: Duration = Duration.MinusInf, parentSpan: Option[RequestSpan] = None, retryStrategy: Option[RetryStrategy] = None) extends Product with Serializable

   Provides control over how a binary append operation is performed.

2.  case class ArrayAddUnique(path: String, fragment: Try[Array[Byte]], _xattr: Boolean = false, _createPath: Boolean = false, _expandMacro: Boolean = false) extends MutateInSpecStandard with Product with Serializable
3.  case class ArrayAppend(path: String, fragment: Try[Array[Byte]], _xattr: Boolean = false, _createPath: Boolean = false, _expandMacro: Boolean = false) extends MutateInSpecStandard with Product with Serializable
4.  case class ArrayInsert(path: String, fragment: Try[Array[Byte]], _xattr: Boolean = false, _createPath: Boolean = false, _expandMacro: Boolean = false) extends MutateInSpecStandard with Product with Serializable
5.  case class ArrayPrepend(path: String, fragment: Try[Array[Byte]], _xattr: Boolean = false, _createPath: Boolean = false, _expandMacro: Boolean = false) extends MutateInSpecStandard with Product with Serializable
6.  case class Count(path: String, _xattr: Boolean = false) extends LookupInSpec with Product with Serializable
7.  case class CounterResult(cas: Long, mutationToken: Option[MutationToken], content: Long) extends HasDurabilityTokens with Product with Serializable

   Contains the result of a successful mutation against a counter document or field.

   Contains the result of a successful mutation against a counter document or field.

   cas

   each Couchbase document has a CAS value, which is increased (not necessarily monotonically) on each successful mutation. This is the updated post-mutation value.

   mutationToken

   if the com.couchbase.client.scala.env.ClusterEnvironment's ioConfig() .mutationTokensEnabled() field is true (which is recommended), this will contain a MutationToken providing additional context on the mutation.

   content

   the post-update content of the counter

8.  case class DecrementOptions(initial: Option[Long] = None, durability: Durability = Disabled, timeout: Duration = Duration.MinusInf, parentSpan: Option[RequestSpan] = None, retryStrategy: Option[RetryStrategy] = None, expiry: Duration = null, expiryTime: Option[Instant] = None) extends Product with Serializable

   Provides control over how an decrement operation is performed.

9.  case class Exists(path: String, _xattr: Boolean = false) extends LookupInSpec with Product with Serializable
10.  case class ExistsOptions(timeout: Duration = Duration.MinusInf, parentSpan: Option[RequestSpan] = None, retryStrategy: Option[RetryStrategy] = None) extends Product with Serializable

    Provides control over how an exists operation is performed.

11.  case class ExistsResult(exists: Boolean, cas: Long) extends Product with Serializable

    The result of an exists operation.

    The result of an exists operation.

    exists

    whether the document exists

12.  case class Get(path: String, _xattr: Boolean = false) extends LookupInSpec with Product with Serializable
13.  case class GetAllReplicasOptions(timeout: Duration = Duration.MinusInf, parentSpan: Option[RequestSpan] = None, retryStrategy: Option[RetryStrategy] = None, transcoder: Option[Transcoder] = None) extends Product with Serializable

    Provides control over how a get-all-replicas operation is performed.

14.  case class GetAndLockOptions(timeout: Duration = Duration.MinusInf, parentSpan: Option[RequestSpan] = None, retryStrategy: Option[RetryStrategy] = None, transcoder: Option[Transcoder] = None) extends Product with Serializable

    Provides control over how a get-and-lock operation is performed.

15.  case class GetAndTouchOptions(timeout: Duration = Duration.MinusInf, parentSpan: Option[RequestSpan] = None, retryStrategy: Option[RetryStrategy] = None, transcoder: Option[Transcoder] = None) extends Product with Serializable

    Provides control over how a get-and-touch operation is performed.

16.  case class GetAnyReplicaOptions(timeout: Duration = Duration.MinusInf, parentSpan: Option[RequestSpan] = None, retryStrategy: Option[RetryStrategy] = None, transcoder: Option[Transcoder] = None) extends Product with Serializable

    Provides control over how a get-any-replica operation is performed.

17.  case class GetOptions(withExpiry: Boolean = false, project: Seq[String] = GetOptions.EmptyProject, timeout: Duration = Duration.MinusInf, parentSpan: Option[RequestSpan] = None, retryStrategy: Option[RetryStrategy] = None, transcoder: Option[Transcoder] = None) extends Product with Serializable

    Provides control over how a get operation is performed.

18.  class GetReplicaResult extends GetResult

    The result of a get-from-replica request.

19.  case class GetResult(id: String, _content: Either[Array[Byte], JsonObject], flags: Int, cas: Long, expiryTime: Option[Instant], transcoder: Transcoder) extends Product with Serializable

    The result of a get operation, e.g.

    The result of a get operation, e.g. the contents of a document.

    id

    the unique identifier of the document

    cas

    the document's CAS value at the time of the lookup

    expiryTime

    the document's expiration time, if it was fetched with the withExpiry flag set. If that flag was not set, this will be None. The time is the point in time when the document expires.

20.  case class Increment(path: String, delta: Long, _xattr: Boolean = false, _createPath: Boolean = false) extends MutateInSpec with Product with Serializable
21.  case class IncrementOptions(initial: Option[Long] = None, durability: Durability = Disabled, timeout: Duration = Duration.MinusInf, parentSpan: Option[RequestSpan] = None, retryStrategy: Option[RetryStrategy] = None, expiry: Duration = null, expiryTime: Option[Instant] = None) extends Product with Serializable

    Provides control over how an increment operation is performed.

22.  case class Insert(path: String, fragment: Try[Array[Byte]], _xattr: Boolean = false, _createPath: Boolean = false, _expandMacro: Boolean = false) extends MutateInSpecStandard with Product with Serializable
23.  case class InsertOptions(durability: Durability = Disabled, timeout: Duration = Duration.MinusInf, parentSpan: Option[RequestSpan] = None, retryStrategy: Option[RetryStrategy] = None, transcoder: Option[Transcoder] = None, expiry: Duration = null, expiryTime: Option[Instant] = None) extends Product with Serializable

    Provides control over how an insert operation is performed.

24.  case class LookupInAllReplicasOptions(timeout: Duration = Duration.MinusInf, parentSpan: Option[RequestSpan] = None, retryStrategy: Option[RetryStrategy] = None) extends Product with Serializable

    Provides control over how a lookupIn Sub-Document operation is performed, when reading from all replicas.

25.  case class LookupInAnyReplicaOptions(timeout: Duration = Duration.MinusInf, parentSpan: Option[RequestSpan] = None, retryStrategy: Option[RetryStrategy] = None) extends Product with Serializable

    Provides control over how a lookupIn Sub-Document operation is performed, when reading from any replica.

26.  case class LookupInOptions(withExpiry: Boolean = false, timeout: Duration = Duration.MinusInf, parentSpan: Option[RequestSpan] = None, retryStrategy: Option[RetryStrategy] = None, transcoder: Option[Transcoder] = None, accessDeleted: Option[Boolean] = None) extends Product with Serializable

    Provides control over how a lookupIn Sub-Document operation is performed.

27.  case class LookupInReplicaResult extends Product with Serializable

    The results of a SubDocument lookupIn operation when reading from replicas.

    The results of a SubDocument lookupIn operation when reading from replicas.

    When doing a lookupIn the application provides a sequence of LookupInSpec. The indexes into this sequence are used when retrieving the results.

28.  case class LookupInResult extends Product with Serializable

    The results of a SubDocument 'lookupIn' operation.

    The results of a SubDocument 'lookupIn' operation.

    When doing a lookupIn the application provides a sequence of LookupInSpec. The indexes into this sequence are used when retrieving the results.

29.  sealed trait LookupInSpec extends AnyRef

    Represents a single SubDocument lookup operation, such as fetching a particular field.

30.  case class MutateInOptions(cas: Long = 0, document: StoreSemantics = StoreSemantics.Replace, durability: Durability = Disabled, timeout: Duration = Duration.MinusInf, parentSpan: Option[RequestSpan] = None, retryStrategy: Option[RetryStrategy] = None, transcoder: Option[Transcoder] = None, expiry: Duration = null, accessDeleted: Boolean = false, createAsDeleted: Boolean = false, expiryTime: Option[Instant] = None, preserveExpiry: Boolean = false) extends Product with Serializable

    Provides control over how a mutateIn operation is performed.

31.  case class MutateInResult(id: String, content: CoreSubdocMutateResult, cas: Long, mutationToken: Option[MutationToken]) extends HasDurabilityTokens with Product with Serializable

    The results of a SubDocument mutateIn operation.

    The results of a SubDocument mutateIn operation.

    When doing a mutateIn the application provides a sequence of MutateInSpec. The indexes into this sequence are used when retrieving the results.

    id

    the unique identifier of the document

    cas

    the document's CAS value at the time of the lookup

    mutationToken

    if the com.couchbase.client.scala.env.ClusterEnvironment's ioConfig() .mutationTokensEnabled() field is true (which is recommended), this will contain a MutationToken providing additional context on the mutation.

32.  sealed trait MutateInSpec extends AnyRef

    Represents an intent to perform a single SubDocument mutation.

33.  trait MutateInSpecStandard extends MutateInSpec

    Most SubDocument mutations are pretty similar, encapsulate the similarities here.

34.  case class MutationResult(cas: Long, mutationToken: Option[MutationToken]) extends HasDurabilityTokens with Product with Serializable

    Contains the result of a successful mutation.

    Contains the result of a successful mutation.

    cas

    each Couchbase document has a CAS value, which is increased (not necessarily monotonically) on each successful mutation. This is the updated post-mutation value.

    mutationToken

    if the com.couchbase.client.scala.env.ClusterEnvironment's ioConfig() .mutationTokensEnabled() field is true (which is recommended), this will contain a MutationToken providing additional context on the mutation.

    Since

    1.0.0

35.  case class MutationState(tokens: Seq[MutationToken]) extends Product with Serializable

    Represents the tokens from one or more mutations.

36.  case class PrependOptions(cas: Long = 0, durability: Durability = Disabled, timeout: Duration = Duration.MinusInf, parentSpan: Option[RequestSpan] = None, retryStrategy: Option[RetryStrategy] = None) extends Product with Serializable

    Provides control over how a binary prepend operation is performed.

37.  case class Remove(path: String, _xattr: Boolean = false) extends MutateInSpec with Product with Serializable
38.  case class RemoveOptions(cas: Long = 0, durability: Durability = Disabled, timeout: Duration = Duration.MinusInf, parentSpan: Option[RequestSpan] = None, retryStrategy: Option[RetryStrategy] = None) extends Product with Serializable

    Provides control over how a remove operation is performed.

39.  case class Replace(path: String, fragment: Try[Array[Byte]], _xattr: Boolean = false, _expandMacro: Boolean = false) extends MutateInSpec with Product with Serializable
40.  case class ReplaceOptions(cas: Long = 0, durability: Durability = Disabled, timeout: Duration = Duration.MinusInf, parentSpan: Option[RequestSpan] = None, retryStrategy: Option[RetryStrategy] = None, transcoder: Option[Transcoder] = None, expiry: Duration = null, expiryTime: Option[Instant] = None, preserveExpiry: Boolean = false) extends Product with Serializable

    Provides control over how a replace operation is performed.

41.  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.

42.  case class ScanResult extends Product with Serializable

    A KV range scan operation will return a stream of these.

43.  case class ScanTerm(term: String, exclusive: Boolean = false) extends Product with Serializable

    A scan term identifies a point to scan from or to scan to.

    A scan term identifies a point to scan from or to scan to.

    term

    matches a particular document id pattern, such as "user_". Since it's represented as an Array[Byte] to support maximum() and minimum(), it's easiest to construct a ScanTerm via the methods in the companion object.

    exclusive

    controls whether this term is inclusive or exclusive - defaults to false.

44.  sealed trait ScanType extends AnyRef

    Controls what type of scan is performed.

45.  sealed class StoreSemantics extends AnyRef

    Specifies whether a document should be created, and how, if it does not already exist.

46.  case class TouchOptions(timeout: Duration = Duration.MinusInf, parentSpan: Option[RequestSpan] = None, retryStrategy: Option[RetryStrategy] = None) extends Product with Serializable

    Provides control over how a touch operation is performed.

47.  case class UnlockOptions(timeout: Duration = Duration.MinusInf, parentSpan: Option[RequestSpan] = None, retryStrategy: Option[RetryStrategy] = None) extends Product with Serializable

    Provides control over how an unlock operation is performed.

48.  case class Upsert(path: String, fragment: Try[Array[Byte]], _xattr: Boolean = false, _createPath: Boolean = false, _expandMacro: Boolean = false) extends MutateInSpecStandard with Product with Serializable
49.  case class UpsertOptions(durability: Durability = Disabled, timeout: Duration = Duration.MinusInf, parentSpan: Option[RequestSpan] = None, retryStrategy: Option[RetryStrategy] = None, transcoder: Option[Transcoder] = None, expiry: Duration = null, expiryTime: Option[Instant] = None, preserveExpiry: Boolean = false) extends Product with Serializable

    Provides control over how an upsert operation is performed.