Packages

abstract class Store[Doc <: Document[Doc], Model <: DocumentModel[Doc]] extends Initializable with Disposable

Linear Supertypes
Disposable, Initializable, AnyRef, Any
Known Subclasses
InMemoryIndexes, MapStore, SplitStore
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Store
  2. Disposable
  3. Initializable
  4. AnyRef
  5. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new Store(name: String, model: Model)

Abstract Value Members

  1. abstract def aggregate(query: AggregateQuery[Doc, Model])(implicit transaction: Transaction[Doc]): Stream[MaterializedAggregate[Doc, Model]]
  2. abstract def aggregateCount(query: AggregateQuery[Doc, Model])(implicit transaction: Transaction[Doc]): Task[Int]
  3. abstract def count(implicit transaction: Transaction[Doc]): Task[Int]
  4. abstract def delete[V](field: UniqueIndex[Doc, V], value: V)(implicit transaction: Transaction[Doc]): Task[Boolean]
  5. abstract def doDispose(): Task[Unit]
    Attributes
    protected
    Definition Classes
    Disposable
  6. abstract def doSearch[V](query: Query[Doc, Model, V])(implicit transaction: Transaction[Doc]): Task[SearchResults[Doc, Model, V]]
  7. abstract def exists(id: Id[Doc])(implicit transaction: Transaction[Doc]): Task[Boolean]
  8. abstract def get[V](field: UniqueIndex[Doc, V], value: V)(implicit transaction: Transaction[Doc]): Task[Option[Doc]]
  9. abstract def initialize(): Task[Unit]

    Define initialization functionality here, but never call directly.

    Define initialization functionality here, but never call directly.

    Attributes
    protected
    Definition Classes
    Initializable
  10. abstract def insert(doc: Doc)(implicit transaction: Transaction[Doc]): Task[Doc]
  11. abstract def prepareTransaction(transaction: Transaction[Doc]): Task[Unit]
  12. abstract def storeMode: StoreMode[Doc, Model]
  13. abstract def stream(implicit transaction: Transaction[Doc]): Stream[Doc]
  14. abstract def truncate()(implicit transaction: Transaction[Doc]): Task[Int]
  15. abstract def upsert(doc: Doc)(implicit transaction: Transaction[Doc]): Task[Doc]

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. def apply(id: Id[Doc])(implicit transaction: Transaction[Doc]): Task[Doc]
  5. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  6. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @IntrinsicCandidate() @native()
  7. lazy val dispose: Task[Unit]

    Calls doDispose() exactly one time.

    Calls doDispose() exactly one time. Safe to call multiple times.

    Definition Classes
    Disposable
  8. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  9. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  10. lazy val fields: List[Field[Doc, _]]
  11. def fromString(string: String): Doc
    Attributes
    protected
  12. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @IntrinsicCandidate() @native()
  13. lazy val hasSpatial: Task[Boolean]
  14. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @IntrinsicCandidate() @native()
  15. def id(doc: Doc): Id[Doc]
    Attributes
    protected
  16. lazy val idField: UniqueIndex[Doc, Id[Doc]]
  17. lazy val init: Task[Unit]

    Calls initialize() exactly one time.

    Calls initialize() exactly one time. Safe to call multiple times.

    Definition Classes
    Initializable
  18. def isDisposes: Boolean
    Definition Classes
    Disposable
  19. def isInitialized: Boolean
    Definition Classes
    Initializable
  20. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  21. def jsonStream(implicit transaction: Transaction[Doc]): Stream[Json]
  22. lazy val lock: LockManager[Id[Doc], Doc]
  23. def modify(id: Id[Doc], establishLock: Boolean = true, deleteOnNone: Boolean = false)(f: Forge[Option[Doc], Option[Doc]])(implicit transaction: Transaction[Doc]): Task[Option[Doc]]
  24. val name: String
  25. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  26. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @IntrinsicCandidate() @native()
  27. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @IntrinsicCandidate() @native()
  28. def optimize(): Task[Unit]

    Optimizes this store.

    Optimizes this store. This allows the implementation an opportunity to clean up, optimize, etc. to improve the performance of the store.

  29. def reIndex(doc: Doc): Task[Boolean]
  30. def reIndex(): Task[Boolean]
  31. def releaseTransaction(transaction: Transaction[Doc]): Task[Unit]
  32. def supportsArbitraryQuery: Boolean
  33. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  34. def toString(doc: Doc): String
    Attributes
    protected
  35. def toString(): String
    Definition Classes
    AnyRef → Any
  36. def verify(): Task[Boolean]
  37. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  38. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  39. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  40. object transaction
  41. object trigger extends CollectionTriggers[Doc]

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 Disposable

Inherited from Initializable

Inherited from AnyRef

Inherited from Any

Ungrouped