Packages

abstract class CouchbaseCollectionSession extends AnyRef

Java API: A Couchbase session allowing querying and interacting with a specific couchbase bucket.

Not for user extension.

Annotations
@DoNotInherit()
Source
CouchbaseCollectionSession.scala
Linear Supertypes
AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. CouchbaseCollectionSession
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new CouchbaseCollectionSession()

Abstract Value Members

  1. abstract def asScala: scaladsl.CouchbaseCollectionSession
  2. abstract def bucket: CouchbaseSession
  3. abstract def createIndex(indexName: String, createQueryIndexOptions: CreateQueryIndexOptions, fields: String*): CompletionStage[Done]

    Create a secondary index for the current collection.

    Create a secondary index for the current collection.

    indexName

    the name of the index.

    createQueryIndexOptions

    Couchbase index options

    fields

    the JSON fields to index

    returns

    a CompletionStage of true if the index was/will be effectively created, false if the index existed and ignoreIfExist is true. Completion of the future does not guarantee the index is online and ready to be used.

  4. abstract def get[T](id: String, target: Class[T]): CompletionStage[CouchbaseDocument[T]]
  5. abstract def getBytes(id: String, timeout: Duration): CompletionStage[CouchbaseDocument[Array[Byte]]]

    returns

    A raw document data if found or none if there is no document for the id

  6. abstract def getBytes(id: String): CompletionStage[CouchbaseDocument[Array[Byte]]]

    id

    Identifier of the document to fetch

    returns

    Raw data for the document or none

  7. abstract def getDocument(id: String, timeout: Duration): CompletionStage[CouchbaseDocument[JsonValue]]

    timeout

    fail the returned future with a TimeoutException if it takes longer than this

    returns

    A document if found or none if there is no document for the id

  8. abstract def getDocument(id: String): CompletionStage[CouchbaseDocument[JsonValue]]

    returns

    A document if found or none if there is no document for the id

  9. abstract def getJsonArray(id: String): CompletionStage[CouchbaseDocument[JsonArray]]
  10. abstract def getJsonObject(id: String): CompletionStage[CouchbaseDocument[JsonObject]]
  11. abstract def insert[T](id: String, document: T, insertOptions: InsertOptions): CompletionStage[Done]
  12. abstract def insert[T](id: String, document: T): CompletionStage[Done]

    Insert a JSON document using the default write settings

    Insert a JSON document using the default write settings

    document

    A tuple where first element is id of the document and second is its value

    returns

    A Future that completes with the id of the written document when the write is done

  13. abstract def listIndexes(): Source[QueryIndex, NotUsed]

    List the existing secondary indexes for the collection

  14. abstract def remove(id: String, removeOptions: RemoveOptions, timeout: Duration): CompletionStage[Done]

    Removes document with given id, remove options and timeout

    Removes document with given id, remove options and timeout

    id

    id of the document to remove

    removeOptions

    Couchbase remove options

    timeout

    timeout

    returns

    the id

  15. abstract def remove(id: String, removeOptions: RemoveOptions): CompletionStage[Done]

    Remove a document by id using the default write settings.

    Remove a document by id using the default write settings.

    returns

    Future that completes when the document has been removed, if there is no such document the future is failed with a DocumentDoesNotExistException

  16. abstract def remove(id: String): CompletionStage[Done]

    Remove a document by id using the default write settings.

    Remove a document by id using the default write settings.

    returns

    Future that completes when the document has been removed, if there is no such document the future is failed with a DocumentDoesNotExistException

  17. abstract def replace[T](id: String, document: T, replaceOptions: ReplaceOptions, timeout: Duration): CompletionStage[Done]

    Replace using write settings and timeout

    Replace using write settings and timeout

    id

    document id

    document

    document value to replace

    replaceOptions

    Couchbase replace options

    timeout

    timeout for the operation

    returns

    the document id and value

  18. abstract def replace[T](id: String, document: T, replaceOptions: ReplaceOptions): CompletionStage[Done]

    Replace using the given replace options

    Replace using the given replace options

    For replacing other types of documents see replaceDoc.

    returns

    a future that completes when the replace is done

  19. abstract def replace[T](id: String, document: T): CompletionStage[Done]

    Replace using the default write settings.

    Replace using the default write settings.

    For replacing other types of documents see replaceDoc.

    returns

    a future that completes when the replace is done

  20. abstract def scope: AsyncScope
  21. abstract def underlying: AsyncCollection
  22. abstract def upsert[T](id: String, document: T, upsertOptions: UpsertOptions, timeout: Duration): CompletionStage[Done]

    Upsert using given write settings and timeout

    Upsert using given write settings and timeout

    id

    document id

    document

    document value to upsert

    upsertOptions

    Couchbase UpsertOptions

    timeout

    timeout for the operation

    returns

    the document id and value

  23. abstract def upsert[T](id: String, document: T, upsertOptions: UpsertOptions): CompletionStage[Done]

    Upsert using the given write settings

    Upsert using the given write settings

    Separate from upsert to make the most common case smoother with the type inference

    returns

    a future that completes when the upsert is done

  24. abstract def upsert[T](id: String, document: T): CompletionStage[Done]

    Upsert using the default write settings.

    Upsert using the default write settings.

    returns

    a future that completes when the upsert is done

Concrete Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##: Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native()
  6. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  7. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  8. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  9. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  10. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  11. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  12. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  13. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  14. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  15. def toString(): String
    Definition Classes
    AnyRef → Any
  16. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  17. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  18. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable]) @Deprecated
    Deprecated

    (Since version 9)

Inherited from AnyRef

Inherited from Any

Ungrouped