Packages

class AsyncCollection extends AnyRef

Provides asynchronous access to all collection APIs, based around Scala Futures. This is the main entry-point for key-value (KV) operations.

If synchronous, blocking access is needed, we recommend looking at the Collection. If a more advanced async API based around reactive programming is desired, then check out the ReactiveCollection.

Since

1.0.0

Linear Supertypes
AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. AsyncCollection
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new AsyncCollection(name: String, bucketName: String, scopeName: String, core: Core, environment: ClusterEnvironment)

Value Members

  1. val binary: AsyncBinaryCollection
  2. val core: Core
  3. val environment: ClusterEnvironment
  4. def exists(id: String, options: ExistsOptions): Future[ExistsResult]

    Checks if a document exists.

    Checks if a document exists.

    This asynchronous version performs the same functionality and takes the same parameters, but returns the same result object asynchronously in a Future.

  5. def exists(id: String, timeout: Duration = kvReadTimeout): Future[ExistsResult]

    Checks if a document exists.

    Checks if a document exists.

    This asynchronous version performs the same functionality and takes the same parameters, but returns the same result object asynchronously in a Future.

  6. def get(id: String, options: GetOptions): Future[GetResult]

    Fetches a full document from this collection.

    Fetches a full document from this collection.

    This asynchronous version performs the same functionality and takes the same parameters, but returns the same result object asynchronously in a Future.

  7. def get(id: String, timeout: Duration = kvReadTimeout): Future[GetResult]

    Fetches a full document from this collection.

    Fetches a full document from this collection.

    This asynchronous version performs the same functionality and takes the same parameters, but returns the same result object asynchronously in a Future.

  8. def getAllReplicas(id: String, options: GetAllReplicasOptions): Seq[Future[GetReplicaResult]]

    Retrieves all available versions of the document.

    Retrieves all available versions of the document.

    This asynchronous version performs the same functionality and takes the same parameters, but returns the same result object asynchronously in a Future.

  9. def getAllReplicas(id: String, timeout: Duration = kvReadTimeout): Seq[Future[GetReplicaResult]]

    Retrieves all available versions of the document.

    Retrieves all available versions of the document.

    This asynchronous version performs the same functionality and takes the same parameters, but returns the same result object asynchronously in a Future.

  10. def getAndLock(id: String, lockTime: Duration, options: GetAndLockOptions): Future[GetResult]

    Fetches a full document from this collection, and simultaneously lock the document from writes.

    Fetches a full document from this collection, and simultaneously lock the document from writes.

    This asynchronous version performs the same functionality and takes the same parameters, but returns the same result object asynchronously in a Future.

  11. def getAndLock(id: String, lockTime: Duration, timeout: Duration = kvReadTimeout): Future[GetResult]

    Fetches a full document from this collection, and simultaneously lock the document from writes.

    Fetches a full document from this collection, and simultaneously lock the document from writes.

    This asynchronous version performs the same functionality and takes the same parameters, but returns the same result object asynchronously in a Future.

  12. def getAndTouch(id: String, expiry: Duration, options: GetAndTouchOptions): Future[GetResult]

    Fetches a full document from this collection, and simultaneously update the expiry value of the document.

    Fetches a full document from this collection, and simultaneously update the expiry value of the document.

    This asynchronous version performs the same functionality and takes the same parameters, but returns the same result object asynchronously in a Future.

  13. def getAndTouch(id: String, expiry: Duration, timeout: Duration = kvReadTimeout): Future[GetResult]

    Fetches a full document from this collection, and simultaneously update the expiry value of the document.

    Fetches a full document from this collection, and simultaneously update the expiry value of the document.

    This asynchronous version performs the same functionality and takes the same parameters, but returns the same result object asynchronously in a Future.

  14. def getAnyReplica(id: String, options: GetAnyReplicaOptions): Future[GetReplicaResult]

    Retrieves any available version of the document.

    Retrieves any available version of the document.

    This asynchronous version performs the same functionality and takes the same parameters, but returns the same result object asynchronously in a Future.

  15. def getAnyReplica(id: String, timeout: Duration = kvReadTimeout): Future[GetReplicaResult]

    Retrieves any available version of the document.

    Retrieves any available version of the document.

    This asynchronous version performs the same functionality and takes the same parameters, but returns the same result object asynchronously in a Future.

  16. def insert[T](id: String, content: T, options: InsertOptions)(implicit serializer: JsonSerializer[T]): Future[MutationResult]

    Inserts a full document into this collection, if it does not exist already.

    Inserts a full document into this collection, if it does not exist already.

    This asynchronous version performs the same functionality and takes the same parameters, but returns the same result object asynchronously in a Future.

  17. def insert[T](id: String, content: T, durability: Durability = Disabled, timeout: Duration = Duration.MinusInf)(implicit serializer: JsonSerializer[T]): Future[MutationResult]

    Inserts a full document into this collection, if it does not exist already.

    Inserts a full document into this collection, if it does not exist already.

    This asynchronous version performs the same functionality and takes the same parameters, but returns the same result object asynchronously in a Future.

  18. def lookupIn(id: String, spec: Seq[LookupInSpec], options: LookupInOptions): Future[LookupInResult]

    SubDocument lookups allow retrieving parts of a JSON document directly, which may be more efficient than retrieving the entire document.

    SubDocument lookups allow retrieving parts of a JSON document directly, which may be more efficient than retrieving the entire document.

    This asynchronous version performs the same functionality and takes the same parameters, but returns the same result object asynchronously in a Future.

  19. def lookupIn(id: String, spec: Seq[LookupInSpec], timeout: Duration = kvReadTimeout): Future[LookupInResult]

    SubDocument lookups allow retrieving parts of a JSON document directly, which may be more efficient than retrieving the entire document.

    SubDocument lookups allow retrieving parts of a JSON document directly, which may be more efficient than retrieving the entire document.

    This asynchronous version performs the same functionality and takes the same parameters, but returns the same result object asynchronously in a Future.

  20. def mutateIn(id: String, spec: Seq[MutateInSpec], options: MutateInOptions): Future[MutateInResult]

    Sub-Document mutations allow modifying parts of a JSON document directly, which can be more efficiently than fetching and modifying the full document.

    Sub-Document mutations allow modifying parts of a JSON document directly, which can be more efficiently than fetching and modifying the full document.

    This asynchronous version performs the same functionality and takes the same parameters, but returns the same result object asynchronously in a Future.

  21. def mutateIn(id: String, spec: Seq[MutateInSpec], cas: Long = 0, document: StoreSemantics = StoreSemantics.Replace, durability: Durability = Disabled, timeout: Duration = Duration.MinusInf): Future[MutateInResult]

    Sub-Document mutations allow modifying parts of a JSON document directly, which can be more efficiently than fetching and modifying the full document.

    Sub-Document mutations allow modifying parts of a JSON document directly, which can be more efficiently than fetching and modifying the full document.

    This asynchronous version performs the same functionality and takes the same parameters, but returns the same result object asynchronously in a Future.

  22. val name: String
  23. def remove(id: String, options: RemoveOptions): Future[MutationResult]

    Removes a document from this collection, if it exists.

    Removes a document from this collection, if it exists.

    This asynchronous version performs the same functionality and takes the same parameters, but returns the same result object asynchronously in a Future.

  24. def remove(id: String, cas: Long = 0, durability: Durability = Disabled, timeout: Duration = Duration.MinusInf): Future[MutationResult]

    Removes a document from this collection, if it exists.

    Removes a document from this collection, if it exists.

    This asynchronous version performs the same functionality and takes the same parameters, but returns the same result object asynchronously in a Future.

  25. def replace[T](id: String, content: T, options: ReplaceOptions)(implicit serializer: JsonSerializer[T]): Future[MutationResult]

    Replaces the contents of a full document in this collection, if it already exists.

    Replaces the contents of a full document in this collection, if it already exists.

    This asynchronous version performs the same functionality and takes the same parameters, but returns the same result object asynchronously in a Future.

  26. def replace[T](id: String, content: T, cas: Long = 0, durability: Durability = Disabled, timeout: Duration = Duration.MinusInf)(implicit serializer: JsonSerializer[T]): Future[MutationResult]

    Replaces the contents of a full document in this collection, if it already exists.

    Replaces the contents of a full document in this collection, if it already exists.

    This asynchronous version performs the same functionality and takes the same parameters, but returns the same result object asynchronously in a Future.

  27. def touch(id: String, expiry: Duration, options: TouchOptions): Future[MutationResult]

    Updates the expiry of the document with the given id.

    Updates the expiry of the document with the given id.

    This asynchronous version performs the same functionality and takes the same parameters, but returns the same result object asynchronously in a Future.

  28. def touch(id: String, expiry: Duration, timeout: Duration = kvReadTimeout): Future[MutationResult]

    Updates the expiry of the document with the given id.

    Updates the expiry of the document with the given id.

    This asynchronous version performs the same functionality and takes the same parameters, but returns the same result object asynchronously in a Future.

  29. def unlock(id: String, cas: Long, options: UnlockOptions): Future[Unit]

    Unlock a locked document.

    Unlock a locked document.

    This asynchronous version performs the same functionality and takes the same parameters, but returns the same result object asynchronously in a Future.

  30. def unlock(id: String, cas: Long, timeout: Duration = kvReadTimeout): Future[Unit]

    Unlock a locked document.

    Unlock a locked document.

    This asynchronous version performs the same functionality and takes the same parameters, but returns the same result object asynchronously in a Future.

  31. def upsert[T](id: String, content: T, options: UpsertOptions)(implicit serializer: JsonSerializer[T]): Future[MutationResult]

    Upserts the contents of a full document in this collection.

    Upserts the contents of a full document in this collection.

    This asynchronous version performs the same functionality and takes the same parameters, but returns the same result object asynchronously in a Future.

  32. def upsert[T](id: String, content: T, durability: Durability = Disabled, timeout: Duration = Duration.MinusInf)(implicit serializer: JsonSerializer[T]): Future[MutationResult]

    Upserts the contents of a full document in this collection.

    Upserts the contents of a full document in this collection.

    This asynchronous version performs the same functionality and takes the same parameters, but returns the same result object asynchronously in a Future.