lightdb-core
API
Generated with
lightdb-core/lightdb/lightdb.collection/Collection

Collection

lightdb.collection.Collection
See theCollection companion object
case class Collection[Doc <: Document[Doc], Model <: DocumentModel[Doc]](name: String, model: Model, store: Store[Doc, Model]) extends Initializable, Disposable

Attributes

Companion
object
Graph
Supertypes
trait Serializable
trait Product
trait Equals
trait Disposable
class Object
trait Matchable
class Any
Show all
Self type
Collection[Doc, Model]

Members list

Type members

Classlikes

object t

Convenience feature for simple one-off operations removing the need to manually create a transaction around it.

Convenience feature for simple one-off operations removing the need to manually create a transaction around it.

Attributes

Supertypes
class Object
trait Matchable
class Any
Self type
t.type

Value members

Concrete methods

def apply[V](f: Model => (UniqueIndex[Doc, V], V))(implicit transaction: Transaction[Doc]): Task[Doc]
def apply(id: Id[Doc])(implicit transaction: Transaction[Doc]): Task[Doc]
def count(implicit transaction: Transaction[Doc]): Task[Int]
def delete[V](f: Model => (UniqueIndex[Doc, V], V))(implicit transaction: Transaction[Doc]): Task[Boolean]
def delete(id: Id[Doc])(implicit transaction: Transaction[Doc], ev: Model <:< DocumentModel[_]): Task[Boolean]
def exists(id: Id[Doc])(implicit transaction: Transaction[Doc]): Task[Boolean]
def get[V](f: Model => (UniqueIndex[Doc, V], V))(implicit transaction: Transaction[Doc]): Task[Option[Doc]]
def get(id: Id[Doc])(implicit transaction: Transaction[Doc]): Task[Option[Doc]]
def getAll(ids: Seq[Id[Doc]])(implicit transaction: Transaction[Doc]): Stream[Doc]
def getOrCreate(id: Id[Doc], create: => Doc, establishLock: Boolean)(implicit transaction: Transaction[Doc]): Task[Doc]
def insert(doc: Doc)(implicit transaction: Transaction[Doc]): Task[Doc]
def insert(docs: Seq[Doc])(implicit transaction: Transaction[Doc]): Task[Seq[Doc]]
def list()(implicit transaction: Transaction[Doc]): Task[List[Doc]]
def lock: LockManager[Id[Doc], Doc]
def modify(id: Id[Doc], establishLock: Boolean, deleteOnNone: Boolean)(f: Forge[Option[Doc], Option[Doc]])(implicit transaction: Transaction[Doc]): Task[Option[Doc]]
def reIndex(): Task[Boolean]
def stream(implicit transaction: Transaction[Doc]): Stream[Doc]
def transaction: store.Store.this.transaction.type
def trigger: store.Store.this.trigger.type
def truncate()(implicit transaction: Transaction[Doc]): Task[Int]
def upsert(doc: Doc)(implicit transaction: Transaction[Doc]): Task[Doc]
def upsert(docs: Seq[Doc])(implicit transaction: Transaction[Doc]): Task[Seq[Doc]]
def verify(): Task[Boolean]

Inherited methods

def isDisposes: Boolean

Attributes

Inherited from:
Disposable
def isInitialized: Boolean

Attributes

Inherited from:
Initializable
def productElementNames: Iterator[String]

Attributes

Inherited from:
Product
def productIterator: Iterator[Any]

Attributes

Inherited from:
Product

Concrete fields

lazy val query: Query[Doc, Model, Doc]

Inherited fields

lazy val dispose: Task[Unit]

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

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

Attributes

Inherited from:
Disposable
lazy val init: Task[Unit]

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

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

Attributes

Inherited from:
Initializable
Generated with