DB - datomiscadao.DB

Type Members

class EntityGetter[T] extends AnyRef

Little bit of boilerplate to get around the fact that Scala type parameter inference is either all or nothing.
Little bit of boilerplate to get around the fact that Scala type parameter inference is either all or nothing. See http://stackoverflow.com/questions/10726222/simulate-partial-type-parameter-inference-with-implicits/10734268#10734268 for an explaination of why this is necessary and the sample from which this code is derived from.
T
the return type

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 add[DD <: AnyRef, Card <: Cardinality, A, I](id: I)(attrVal: (Attribute[DD, Card], A))(implicit conn: Connection, ec: ExecutionContext, ev1: AsEntityId[I], ev2: Attribute2FactWriter[DD, Card, A]): Future[TxReport]

Asserts a new fact in the database
Asserts a new fact in the database
DD
the Datomic Data type
Card
the cardinality of the attribute
A
the type of the value that you are adding
id
the entity ID
attrVal
the assertion of the form Schema.thing -> value
conn
the database connection
ec
the execution context
ev2
the Attribute2FactWriter
returns
the database result
final def asInstanceOf[T0]: T0

Definition Classes
Any
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( ... )
final def eq(arg0: AnyRef): Boolean

Definition Classes
AnyRef
def equals(arg0: Any): Boolean

Definition Classes
AnyRef → Any
def factOrNone[T, DD <: AnyRef, Card <: Cardinality, A](original: Any, changed: Any, attrVal: (Attribute[DD, Card], A))(implicit ev2: Attribute2FactWriter[DD, Card, A], id: Long): Option[TxData]
def finalize(): Unit

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( classOf[java.lang.Throwable] )
def get[T]: EntityGetter[T]

See EntityGetter.apply().
See EntityGetter.apply().
T
the type that you want returned
returns
the EntityGetter
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
def hasAttribute(attributeIdent: Keyword)(implicit db: Database, conn: Connection): Boolean
def hashCode(): Int

Definition Classes
AnyRef → Any
def headOption[T](query: Iterable[Any], db: Database)(implicit reader: EntityReader[T]): Option[T]

Returns a single entity (the first entity if there are many that match the query) as an option or None if there are no results matching the query
Returns a single entity (the first entity if there are many that match the query) as an option or None if there are no results matching the query
query
the executed query
db
the database - Required to convert the entity ID to the full entity. For consistency, This should be the same database that you used to execute the query.
reader
the reader to convert to the specified entity type
returns
Some(entity) of there is at lease one result where entity is the first entity found, or None if there are no results
def headOptionWithId[T](query: Iterable[Any], db: Database)(implicit reader: EntityReader[T]): Option[(Long, T)]
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
def list[T](query: Iterable[Any], db: Database)(implicit reader: EntityReader[T]): List[T]

Returns the list of entities chosen by the query tupled with its ID.
Returns the list of entities chosen by the query tupled with its ID.
query
the Datomic Query
db
the database - Required to convert the entity ID to the full entity. For consistency, This should be the same database that you used to execute the query.
reader
the reader for the entity
def listToPage[T](rawList: List[Any], filter: PageFilter)(implicit db: Database, reader: EntityReader[T]): Page[T]
def listWithId[T](query: Iterable[Any], db: Database)(implicit reader: EntityReader[T]): List[(Long, T)]
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
def page[T](query: Iterable[Any], filter: PageFilter)(implicit db: Database, reader: EntityReader[T]): Page[T]

Runs a query and pulls a single page worth of values out.
Runs a query and pulls a single page worth of values out.
query
the query
filter
the filter
db
the database - Required to convert the entity ID to the full entity. For consistency, This should be the same database that you used to execute the query.
reader
the entity reader
returns
the Page

Attributes
protected
def pageWithId[T](query: Iterable[Any], filter: PageFilter)(implicit db: Database, reader: EntityReader[T]): Page[(Long, T)]

Attributes
protected
def pageWithSort[T](query: Iterable[(Any, Any)], filter: PageFilter, sort: SortOrder = Asc)(implicit db: Database, reader: EntityReader[T]): Page[T]

Attributes
protected
def retract[I, DD <: AnyRef, Card <: Cardinality, T](id: I, attr: Attribute[DD, Card])(implicit conn: Connection, ec: ExecutionContext, attrC: Attribute2EntityReaderInj[DD, Card, T], ev2: Attribute2FactWriter[DD, Card, T], idConv: AsPermanentEntityId[I]): Future[Unit]

Retract an individual attribute for a given entity.
Retract an individual attribute for a given entity. Before issuing the retraction, it first checks that there is a value there to retract. If there is not, this method is simply a NOOP.
I
the type of the ID
DD
the Datomic Data type
Card
the cardinality of the attribute
T
the type of the value that you are retracting
id
the identified for the entity. Can either be an ID, or a lookup ref
attr
the attribute to retract
conn
the database connection
ec
the ExecutionContext
attrC
the Attribute2EntityReaderInj
ev2
the Attribute2FactWriter
idConv
the ID converter
returns
a successful future if all goes well
def retractEntity[I](id: I)(implicit conn: Connection, ex: ExecutionContext, idConv: AsPermanentEntityId[I]): Future[TxReport]

This is the Datomic equivalent of a delete, except in Datomic, nothing ever gets deleted.
This is the Datomic equivalent of a delete, except in Datomic, nothing ever gets deleted. You can only insert a retraction, that flags the specified entity as ignored.
I
the type of the ID, can either be a Long or a LookupRef
id
the ID of the entity to retract
ex
the ExecutionContext
returns
the transaction record specifying whether or not the transaction succeeded or failed
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
def toString(): String

Definition Classes
AnyRef → Any
def transactAndWait(facts: TraversableOnce[TxData], resolveId: DId)(implicit conn: Connection): Long
def transactAndWait(facts: TraversableOnce[TxData])(implicit conn: Connection): Unit
def transactAndWait(facts: TxData*)(implicit conn: Connection): Unit
def uuid: UUID

Generate a unique UUID to be used as a lookup-ref.
Generate a unique UUID to be used as a lookup-ref. Abstracting away the fact that we are using Datomic to generate UUIDs. We are using Datomic for reasons specified here: http://docs.datomic.com/identity.html
returns
the UUID
def value[I, DD <: AnyRef, Card <: Cardinality, T](id: I, attribute: Attribute[DD, Card], db: Database)(implicit attrC: Attribute2EntityReaderInj[DD, Card, T], idConv: AsPermanentEntityId[I]): T

Retrieves the value of a particular field for a particular entity.
Retrieves the value of a particular field for a particular entity. In other words, in the EAVT structure of Datomic this method allows you to specify the id (E), attribute (A), and what you will get in return is the most recent (T) value (V).
DD
the Datomic Data type
Card
the cardinality
T
the return type (must correspond to the Datomic data type)
id
the ID of the entity that you want to query
attribute
the schema attribute of the field that you want to get
db
the database
attrC
the converter
returns
the field value
def valueOpt[I, DD <: AnyRef, Card <: Cardinality, T](id: I, attribute: Attribute[DD, Card], database: Database)(implicit attrC: Attribute2EntityReaderInj[DD, Card, T], idConv: AsPermanentEntityId[I]): Option[T]

Retrieves the optional value of a particular attribute for a particular entity, from a particular database value.
Retrieves the optional value of a particular attribute for a particular entity, from a particular database value. In other words, in the EAVT structure of Datomic this method allows you to specify the id (E), attribute (A), and what you will get in return is the most recent (T) value (V), for the supplied database.
DD
the Datomic Data type
Card
the cardinality
T
the return type (must correspond to the Datomic data type)
id
the ID of the entity that you want to query
attribute
the schema attribute of the field that you want to get
database
the database
attrC
the converter
returns
the field value
final def wait(): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long, arg1: Int): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )

DB

Related Docs: trait DB | package datomiscadao

object DB

Type Members

class EntityGetter[T] extends AnyRef

Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: Any): Boolean

def add[DD <: AnyRef, Card <: Cardinality, A, I](id: I)(attrVal: (Attribute[DD, Card], A))(implicit conn: Connection, ec: ExecutionContext, ev1: AsEntityId[I], ev2: Attribute2FactWriter[DD, Card, A]): Future[TxReport]

final def asInstanceOf[T0]: T0

def clone(): AnyRef

final def eq(arg0: AnyRef): Boolean

def equals(arg0: Any): Boolean

def factOrNone[T, DD <: AnyRef, Card <: Cardinality, A](original: Any, changed: Any, attrVal: (Attribute[DD, Card], A))(implicit ev2: Attribute2FactWriter[DD, Card, A], id: Long): Option[TxData]

def finalize(): Unit

def get[T]: EntityGetter[T]

final def getClass(): Class[_]

def hasAttribute(attributeIdent: Keyword)(implicit db: Database, conn: Connection): Boolean

def hashCode(): Int

def headOption[T](query: Iterable[Any], db: Database)(implicit reader: EntityReader[T]): Option[T]

def headOptionWithId[T](query: Iterable[Any], db: Database)(implicit reader: EntityReader[T]): Option[(Long, T)]

final def isInstanceOf[T0]: Boolean

def list[T](query: Iterable[Any], db: Database)(implicit reader: EntityReader[T]): List[T]

def listToPage[T](rawList: List[Any], filter: PageFilter)(implicit db: Database, reader: EntityReader[T]): Page[T]

def listWithId[T](query: Iterable[Any], db: Database)(implicit reader: EntityReader[T]): List[(Long, T)]

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

def page[T](query: Iterable[Any], filter: PageFilter)(implicit db: Database, reader: EntityReader[T]): Page[T]

def pageWithId[T](query: Iterable[Any], filter: PageFilter)(implicit db: Database, reader: EntityReader[T]): Page[(Long, T)]

def pageWithSort[T](query: Iterable[(Any, Any)], filter: PageFilter, sort: SortOrder = Asc)(implicit db: Database, reader: EntityReader[T]): Page[T]

def retract[I, DD <: AnyRef, Card <: Cardinality, T](id: I, attr: Attribute[DD, Card])(implicit conn: Connection, ec: ExecutionContext, attrC: Attribute2EntityReaderInj[DD, Card, T], ev2: Attribute2FactWriter[DD, Card, T], idConv: AsPermanentEntityId[I]): Future[Unit]

def retractEntity[I](id: I)(implicit conn: Connection, ex: ExecutionContext, idConv: AsPermanentEntityId[I]): Future[TxReport]

final def synchronized[T0](arg0: ⇒ T0): T0

def toString(): String

def transactAndWait(facts: TraversableOnce[TxData], resolveId: DId)(implicit conn: Connection): Long

def transactAndWait(facts: TraversableOnce[TxData])(implicit conn: Connection): Unit

def transactAndWait(facts: TxData*)(implicit conn: Connection): Unit

def uuid: UUID

def value[I, DD <: AnyRef, Card <: Cardinality, T](id: I, attribute: Attribute[DD, Card], db: Database)(implicit attrC: Attribute2EntityReaderInj[DD, Card, T], idConv: AsPermanentEntityId[I]): T

def valueOpt[I, DD <: AnyRef, Card <: Cardinality, T](id: I, attribute: Attribute[DD, Card], database: Database)(implicit attrC: Attribute2EntityReaderInj[DD, Card, T], idConv: AsPermanentEntityId[I]): Option[T]

final def wait(): Unit

final def wait(arg0: Long, arg1: Int): Unit

final def wait(arg0: Long): Unit

Inherited from AnyRef

Inherited from Any

Ungrouped