lightdb-async
API
Generated with
lightdb-async/lightdb.async/AsyncLightDB

AsyncLightDB

lightdb.async.AsyncLightDB
trait AsyncLightDB extends FeatureSupport[DBFeatureKey]

Attributes

Graph
Supertypes
trait FeatureSupport[DBFeatureKey]
class Object
trait Matchable
class Any
Self type

Members list

Type members

Classlikes

object stored

Attributes

Supertypes
class Object
trait Matchable
class Any
Self type
stored.type
object underlying extends LightDB

Attributes

Supertypes
trait LightDB
trait FeatureSupport[DBFeatureKey]
trait Initializable
class Object
trait Matchable
class Any
Show all
Self type
underlying.type

Value members

Abstract methods

def directory: Option[Path]

The base directory for this database. If None, the database is expected to operate entirely in memory.

The base directory for this database. If None, the database is expected to operate entirely in memory.

Attributes

def storeManager: StoreManager

Default StoreManager to use for collections that do not specify a Store.

Default StoreManager to use for collections that do not specify a Store.

Attributes

def upgrades: List[AsyncDatabaseUpgrade]

List of upgrades that should be applied at the start of this database.

List of upgrades that should be applied at the start of this database.

Attributes

Concrete methods

def backingStore: AsyncCollection[KeyValue, KeyValue.type]
def collection[Doc <: Document[LazyRef(...)], Model <: DocumentModel[Doc]](model: Model, name: Option[String], store: Option[Store[Doc, Model]], storeManager: Option[StoreManager], maxInsertBatch: Int, cacheQueries: Boolean): AsyncCollection[Doc, Model]
def dispose(): IO[Boolean]
final def init(): IO[Boolean]
protected def initialize(): IO[Unit]
def name: String

Identifiable name for this database. Defaults to using the class name.

Identifiable name for this database. Defaults to using the class name.

Attributes

override def put[T](key: DBFeatureKey[T], value: T): Unit

Attributes

Definition Classes
FeatureSupport
def reIndex(): IO[Int]
protected def truncateOnInit: Boolean

Automatically truncates all collections in the database during initialization if this is set to true. Defaults to false.

Automatically truncates all collections in the database during initialization if this is set to true. Defaults to false.

Attributes

Inherited methods

def apply[T](key: DBFeatureKey[T]): T

Attributes

Inherited from:
FeatureSupport
def featureMap: Map[DBFeatureKey[Any], Any]

Attributes

Inherited from:
FeatureSupport
def features: Iterable[Any]

Attributes

Inherited from:
FeatureSupport
def get[T](key: DBFeatureKey[T]): Option[T]

Attributes

Inherited from:
FeatureSupport
def getOrCreate[T](key: DBFeatureKey[T], create: => T): T

Attributes

Inherited from:
FeatureSupport
Generated with