abstract class Collection[Doc <: Document[Doc], Model <: DocumentModel[Doc]] extends Store[Doc, Model]
Linear Supertypes
Known Subclasses
Ordering
- Alphabetic
- By Inheritance
Inherited
- Collection
- Store
- Disposable
- Initializable
- AnyRef
- Any
- Hide All
- Show All
Visibility
- Public
- Protected
Instance Constructors
- new Collection(name: String, path: Option[Path], model: Model, lightDB: LightDB, storeManager: StoreManager)
Abstract Value Members
- abstract def _delete[V](index: UniqueIndex[Doc, V], value: V)(implicit transaction: Transaction[Doc]): Task[Boolean]
- Attributes
- protected
- Definition Classes
- Store
- abstract def _get[V](index: UniqueIndex[Doc, V], value: V)(implicit transaction: Transaction[Doc]): Task[Option[Doc]]
- Attributes
- protected
- Definition Classes
- Store
- abstract def _insert(doc: Doc)(implicit transaction: Transaction[Doc]): Task[Doc]
- Attributes
- protected
- Definition Classes
- Store
- abstract def _upsert(doc: Doc)(implicit transaction: Transaction[Doc]): Task[Doc]
- Attributes
- protected
- Definition Classes
- Store
- abstract def aggregate(query: AggregateQuery[Doc, Model])(implicit transaction: Transaction[Doc]): Stream[MaterializedAggregate[Doc, Model]]
- abstract def aggregateCount(query: AggregateQuery[Doc, Model])(implicit transaction: Transaction[Doc]): Task[Int]
- abstract def count(implicit transaction: Transaction[Doc]): Task[Int]
- Definition Classes
- Store
- abstract def doSearch[V](query: Query[Doc, Model, V])(implicit transaction: Transaction[Doc]): Task[SearchResults[Doc, Model, V]]
- abstract def exists(id: Id[Doc])(implicit transaction: Transaction[Doc]): Task[Boolean]
- Definition Classes
- Store
- abstract def jsonStream(implicit transaction: Transaction[Doc]): Stream[Json]
- Definition Classes
- Store
- abstract def prepareTransaction(transaction: Transaction[Doc]): Task[Unit]
- Definition Classes
- Store
- abstract def storeMode: StoreMode[Doc, Model]
- Definition Classes
- Store
- abstract def truncate()(implicit transaction: Transaction[Doc]): Task[Int]
- Definition Classes
- Store
Concrete Value Members
- final def !=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def ##: Int
- Definition Classes
- AnyRef → Any
- final def ==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- def apply(id: Id[Doc])(implicit transaction: Transaction[Doc]): Task[Doc]
- Definition Classes
- Store
- def apply[V](f: (Model) => (UniqueIndex[Doc, V], V))(implicit transaction: Transaction[Doc]): Task[Doc]
- Definition Classes
- Store
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @IntrinsicCandidate() @native()
- def delete(id: Id[Doc])(implicit transaction: Transaction[Doc]): Task[Boolean]
- Definition Classes
- Store
- def delete[V](f: (Model) => (UniqueIndex[Doc, V], V))(implicit transaction: Transaction[Doc]): Task[Boolean]
- Definition Classes
- Store
- lazy val dispose: Task[Unit]
Calls doDispose() exactly one time.
Calls doDispose() exactly one time. Safe to call multiple times.
- Definition Classes
- Disposable
- def doDispose(): Task[Unit]
- Attributes
- protected
- Definition Classes
- Store → Disposable
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def equals(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef → Any
- lazy val fields: List[Field[Doc, _]]
- Definition Classes
- Store
- def fromString(string: String): Doc
- Attributes
- protected
- Definition Classes
- Store
- def get(id: Id[Doc])(implicit transaction: Transaction[Doc]): Task[Option[Doc]]
- Definition Classes
- Store
- def get[V](f: (Model) => (UniqueIndex[Doc, V], V))(implicit transaction: Transaction[Doc]): Task[Option[Doc]]
- Definition Classes
- Store
- def getAll(ids: Seq[Id[Doc]])(implicit transaction: Transaction[Doc]): Stream[Doc]
- Definition Classes
- Store
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @IntrinsicCandidate() @native()
- def getOrCreate(id: Id[Doc], create: => Doc, establishLock: Boolean = true)(implicit transaction: Transaction[Doc]): Task[Doc]
- Definition Classes
- Store
- lazy val hasSpatial: Task[Boolean]
- Definition Classes
- Store
- def hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @IntrinsicCandidate() @native()
- def id(doc: Doc): Id[Doc]
- Attributes
- protected
- Definition Classes
- Store
- lazy val idField: UniqueIndex[Doc, Id[Doc]]
- Definition Classes
- Store
- lazy val init: Task[Unit]
Calls initialize() exactly one time.
Calls initialize() exactly one time. Safe to call multiple times.
- Definition Classes
- Initializable
- def initialize(): Task[Unit]
Define initialization functionality here, but never call directly.
Define initialization functionality here, but never call directly.
- Attributes
- protected
- Definition Classes
- Store → Initializable
- final def insert(docs: Seq[Doc])(implicit transaction: Transaction[Doc]): Task[Seq[Doc]]
- Definition Classes
- Store
- final def insert(doc: Doc)(implicit transaction: Transaction[Doc]): Task[Doc]
- Definition Classes
- Store
- def isDisposes: Boolean
- Definition Classes
- Disposable
- def isInitialized: Boolean
- Definition Classes
- Initializable
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- val lightDB: LightDB
- Definition Classes
- Store
- def list()(implicit transaction: Transaction[Doc]): Task[List[Doc]]
- Definition Classes
- Store
- lazy val lock: LockManager[Id[Doc], Doc]
- Definition Classes
- Store
- val model: Model
- Definition Classes
- Store
- def modify(id: Id[Doc], establishLock: Boolean = true, deleteOnNone: Boolean = false)(f: Forge[Option[Doc], Option[Doc]])(implicit transaction: Transaction[Doc]): Task[Option[Doc]]
- Definition Classes
- Store
- val name: String
- Definition Classes
- Store
- final def ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @IntrinsicCandidate() @native()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @IntrinsicCandidate() @native()
- 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.
- Definition Classes
- Store
- val path: Option[Path]
- Definition Classes
- Store
- lazy val query: Query[Doc, Model, Doc]
- def reIndex(doc: Doc): Task[Boolean]
- Definition Classes
- Store
- def reIndex(): Task[Boolean]
- Definition Classes
- Store
- def releaseTransaction(transaction: Transaction[Doc]): Task[Unit]
- Definition Classes
- Store
- val storeManager: StoreManager
- Definition Classes
- Store
- def stream(implicit transaction: Transaction[Doc]): Stream[Doc]
- Definition Classes
- Store
- def supportsArbitraryQuery: Boolean
- Definition Classes
- Store
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- lazy val t: Transactionless[Doc, Model]
- Definition Classes
- Store
- def toJson(string: String): Json
- Attributes
- protected
- Definition Classes
- Store
- def toString(doc: Doc): String
- Attributes
- protected
- Definition Classes
- Store
- def toString(): String
- Definition Classes
- AnyRef → Any
- final def upsert(docs: Seq[Doc])(implicit transaction: Transaction[Doc]): Task[Seq[Doc]]
- Definition Classes
- Store
- final def upsert(doc: Doc)(implicit transaction: Transaction[Doc]): Task[Doc]
- Definition Classes
- Store
- def verify(): Task[Boolean]
- Definition Classes
- Store
- final def wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- object transaction
- Definition Classes
- Store
- object trigger extends StoreTriggers[Doc]
- Definition Classes
- Store
Deprecated Value Members
- def finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.Throwable]) @Deprecated
- Deprecated
(Since version 9)