core

object core extends core

Source: core.scala

Linear Supertypes

core, EntityOps, LogicImplicits, AggregateKeywords, AttrExpressions, Datomic, AnyRef, Any

Content Hierarchy

Ordering

Grouped
Alphabetic
By Inheritance

Inherited

core
core
EntityOps
LogicImplicits
AggregateKeywords
AttrExpressions
Datomic
AnyRef
Any

Hide All
Show All

Visibility

Public
All

Type Members

type ?? = expression.AttrExpressions.?

Definition Classes
AttrExpressions
trait avg extends AnyRef
Average of attribute values.
Average of attribute values.

Apply avg keyword to attribute to return average of attribute values of entities matching the molecule.
```
Match.score.insert(1, 2, 4)
Match.score(avg).get.head === 2.3333333333333335 // (1 + 2 + 4) / 3
```
returns
Double

Definition Classes
AggregateKeywords

trait count extends AnyRef

Count of attribute values.

Count of attribute values.

Apply count keyword to attribute to return count of attribute values of entities matching the molecule.

Person.firstName.lastName.age insert List(
  ("Ben", "Hayday", 42),
  ("Liz", "Taylor", 34),
  ("Liz", "Swifty", 34),
  ("Liz", "Mooray", 25)
)
Person.firstName.age(count).get === List(
  ("Ben", 1),
  ("Liz", 3) // 34, 34, 25
)

returns: Int

Definition Classes: AggregateKeywords

trait countDistinct extends AnyRef
Count of distinct attribute values.
Count of distinct attribute values.

Apply countDistinct keyword to attribute to return count of distinct attribute values of entities matching the molecule.
```
Person.firstName.lastName.age insert List(
  ("Ben", "Hayday", 42),
  ("Liz", "Taylor", 34),
  ("Liz", "Swifty", 34),
  ("Liz", "Mooray", 25)
)
Person.firstName.age(countDistinct).get === List(
  ("Ben", 1),
  ("Liz", 2) // 34, 25
)
```
returns
Int

Definition Classes
AggregateKeywords

trait distinct extends AnyRef

Distinct attribute values.

Distinct attribute values.

Apply distinct keyword to attribute to return Vector of distinct attribute values of entities matching the molecule.

Person.firstName.lastName.age insert List(
  ("Ben", "Hayday", 42),
  ("Liz", "Taylor", 34),
  ("Liz", "Swifty", 34),
  ("Liz", "Mooray", 25)
)
Person.firstName.age(distinct) insert List(
  ("Ben", 42),
  ("Liz", Vector(34, 25)) // only single 34 returned
)

returns: List[attribute-type]

Definition Classes: AggregateKeywords

trait max extends AnyRef
Maximum attribute value(s).
Maximum attribute value(s).

Apply max keyword to attribute to return the maximum attribute value of entities matching the molecule.
```
Person.age.insert(25, 34, 37, 42, 70)
Person.age(max).get.head === 70
```
Apply max(n) to return Vector of the n biggest values.
```
Person.age(max(3)).get.head === Vector(37, 42, 70)
```
Definition Classes
AggregateKeywords
Note
max/max(n) supports all value types (via comparators).
max(n) Can at most return the number of values that match.
trait maxs extends AnyRef

Definition Classes
AggregateKeywords
trait median extends AnyRef
Median of attribute values.
Median of attribute values.

Apply median keyword to attribute to return median of attribute values of entities matching the molecule.
```
Match.score.insert(1, 2, 4)
Match.score(median).get.head === 2
```
OBS: When it comes to an even number of values, Datomic has a special implementation of median that is different from the one described on the Wiki entry on the median function.

Datomic calculates the median of even number of values as the average of the two middle numbers rounded down to nearest whole number
```
Match.score.insert(1, 2, 3, 4)
Match.score(median).get.head === 2 // (2 + 3) / 2 = 2.5 rounded down to 2
```
With decimal numbers this can go wrong:
```
Match.score.insert(1.0, 2.5, 2.5, 3.0)
Match.score(median).get.head === 2 // (2.5 + 2.5) / 2 = 2.5 rounded down to 2 (This is wrong and bug report has been filed)
```
returns
Value of Attribute type

Definition Classes
AggregateKeywords
trait min extends AnyRef
Minimum attribute value(s).
Minimum attribute value(s).

Apply min keyword to attribute to return the minimum attribute value of entities matching the molecule.
```
Person.age.insert(25, 34, 37, 42, 70)
Person.age(min).get.head === 25
```
Apply min(n) to return Vector of the n smallest values.
```
Person.age(min(3)).get.head === Vector(25, 34, 37)
```
Definition Classes
AggregateKeywords
Note
min/min(n) supports all value types (via comparators).
min(n) Can at most return the number of values that match.
trait mins extends AnyRef

Definition Classes
AggregateKeywords
trait rand extends AnyRef
Random attribute value(s).
Random attribute value(s).

Apply random keyword to attribute to return a single random attribute of entities matching the molecule.
```
Person.age.insert(25, 34, 37, 42, 70)
Person.age(random).get.head === 34 // or other..
```
Apply random(n) to return Vector of n random values. Observe though that duplicate random values can re-occur.
```
Person.age(random(3)).get.head === Vector(42, 25, 42) // or other..
```
To get distinct values only, use the sample(n) keyword instead.
Definition Classes
AggregateKeywords
trait rands extends AnyRef

Definition Classes
AggregateKeywords
trait sample extends AnyRef
Sample attribute value(s).
Sample attribute value(s).

Apply sample keyword to attribute to return a single sample (random) attribute value of entities matching the molecule.
```
Person.age.insert(25, 34, 37, 42, 70)
Person.age(sample).get.head === 42 // or other..
```
Apply sample(n) to return Vector of up to n distinct sample values.
```
Person.age(sample(3)).get.head === Vector(70, 25, 37) // or other..
```
If values don't need to be distinct, random(n) can be used also.
Definition Classes
AggregateKeywords
Note
Can at most return the number of values that match.
trait samples extends AnyRef

Definition Classes
AggregateKeywords
trait stddev extends AnyRef
Variance of attribute values.
Variance of attribute values.

Apply stddev keyword to attribute to return variance of attribute values of entities matching the molecule.
```
Match.score.insert(1, 2, 4)
Match.score(stddev).get.head === 1.247219128924647
```
returns
Double

Definition Classes
AggregateKeywords
trait sum extends AnyRef
Sum of attribute values.
Sum of attribute values.

Apply sum keyword to attribute to return sum of attribute values of entities matching the molecule.
```
Match.score.insert(1, 2, 4)
Match.score(sum).get.head === 7
```
returns
Value of Attribute type

Definition Classes
AggregateKeywords
trait variance extends AnyRef
Variance of attribute values.
Variance of attribute values.

Apply variance keyword to attribute to return variance of attribute values of entities matching the molecule.
```
Match.score.insert(1, 2, 4)
Match.score(variance).get.head === 1.5555555555555556
```
returns
Double

Definition Classes
AggregateKeywords
trait ? extends AnyRef
Turn molecule into input molecule awaiting input.
Turn molecule into input molecule awaiting input.

Apply input marker ? to attribute to turn molecule into an 'input molecule'.

At runtime the input molecule expects input for the attribute in place of the ? marker.
```
// Input molecule created at compile time.
val ageOfPersons = m(Person.name_(?).age) // awaiting name of type String

// At runtime, "Ben" is applied as input replacing the `?` placeholder and we can get the age.
ageOfPersons("Ben").get === List(42)
```
Definition Classes
AttrExpressions
Note
Data can only be retrieved from input molecules once they have been resolved with input.
Input molecule queries are cached and optimized by Datomic.
trait AttrExpr[Ns, T] extends AnyRef
Expression methods common for all attributes.
Expression methods common for all attributes.

Definition Classes
AttrExpressions
trait FulltextSearchExpr[Ns, In] extends AnyRef
Expression methods of String attributes with fulltext search.
Expression methods of String attributes with fulltext search.

Definition Classes
AttrExpressions
trait ManyAttrExpr[Ns, Add, OldNew, Rem] extends AnyRef
Value update methods for card-many attributes.
Value update methods for card-many attributes.

Definition Classes
AttrExpressions
trait ManyExpr[Ns, In, T] extends ValueAttrExpr[Ns, In, T] with ManyAttrExpr[Ns, T, (T, T), T]
Expression methods of card-many attributes.
Expression methods of card-many attributes.

Definition Classes
AttrExpressions
trait ManyRefAttrExpr[Ns, In] extends AttrExpr[Ns, Long] with ManyAttrExpr[Ns, Long, (Long, Long), Long]
Expression methods of card-many ref attributes.
Expression methods of card-many ref attributes.

Definition Classes
AttrExpressions
trait MapAttrExpr[Ns, In, T] extends ValueAttrExpr[Ns, In, T] with ManyAttrExpr[Ns, (String, T), (String, T), String]
Expression methods of map attributes.
Expression methods of map attributes.

Definition Classes
AttrExpressions
trait OneExpr[Ns, In, T] extends ValueAttrExpr[Ns, In, T]
Expression methods of card-one attributes.
Expression methods of card-one attributes.

Definition Classes
AttrExpressions
trait OneRefAttrExpr[Ns, In] extends AttrExpr[Ns, Long]
Expression methods of card-one ref attributes.
Expression methods of card-one ref attributes.

Definition Classes
AttrExpressions
trait OptionalExpr[Ns, T] extends AnyRef
Expression methods of optional attributes.
Expression methods of optional attributes.

Definition Classes
AttrExpressions
trait ValueAttrExpr[Ns, In, T] extends AttrExpr[Ns, T]
Expression methods of value attributes.
Expression methods of value attributes.

Definition Classes
AttrExpressions

trait unify extends AnyRef

Unify attribute value in self-join.

Unify attribute value in self-join.

Apply unify marker to attribute to unify its value with previous values of the same attribute in the molecule in a self-join.

m(Person.age.name.Beverages * Beverage.name.rating) insert List(
    (23, "Joe", List(("Coffee", 3), ("Cola", 2), ("Pepsi", 3))),
    (25, "Ben", List(("Coffee", 2), ("Tea", 3))),
    (23, "Liz", List(("Coffee", 1), ("Tea", 3), ("Pepsi", 1))))

// What beverages do pairs of 23- AND 25-year-olds like in common?
// Drink name is unified - Joe and Ben both drink coffee, etc..
Person.age_(23).name.Beverages.name._Ns.Self
      .age_(25).name.Beverages.name_(unify).get.sorted === List(
  ("Joe", "Coffee", "Ben"),
  ("Liz", "Coffee", "Ben"),
  ("Liz", "Tea", "Ben")
)

Definition Classes: AttrExpressions

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
final def asInstanceOf[T0]: T0

Definition Classes
Any
implicit final def bigDec2Model(v: BigDecimal): TermValue[BigDecimal]

Definition Classes
LogicImplicits
implicit final def bigDecSet2Model(set: Set[BigDecimal]): TermValue[Set[BigDecimal]]

Definition Classes
LogicImplicits
implicit final def bigInt2Model(v: BigInt): TermValue[BigInt]

Definition Classes
LogicImplicits
implicit final def bigIntSet2Model(set: Set[BigInt]): TermValue[Set[BigInt]]

Definition Classes
LogicImplicits
implicit final def boolean2Model(v: Boolean): TermValue[Boolean]

Definition Classes
LogicImplicits
implicit final def booleanSet2Model(set: Set[Boolean]): TermValue[Set[Boolean]]

Definition Classes
LogicImplicits
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@native() @throws( ... )
implicit final def date2Model(v: Date): TermValue[Date]

Definition Classes
LogicImplicits
implicit final def dateSet2Model(set: Set[Date]): TermValue[Set[Date]]

Definition Classes
LogicImplicits

def debugRetract(eids: Iterable[Long], txMetaDataMolecules: MoleculeBase*)(implicit conn: Conn): Unit

Debug retracting multiple entities with optional transaction meta data.

Debug retracting multiple entities with optional transaction meta data.

Without affecting the database, a multiple entity retract action can be debugged by adding a 'D' (for 'Debug') to the retract method.

Here we debug a possible retraction of two comment entities with transaction meta data asserting that the retraction was done by Ben Goodman:

debugRetract(Seq(commentEid1, commentEid2), MetaData.user("Ben Goodman"))

This will print debugging info about the retraction to output (without affecting the database):

## 1 ## molecule.Datomic.debugRetract
===================================================================================================================
1      Model(
  1      TxMetaData(
    1      Atom(metaData,user,String,1,Eq(List(Ben Goodman)),None,List(),List())))
------------------------------------------------
2      List(
  1      :db/add     'tx                             :metaData/user     Values(Eq(List(Ben Goodman)),None)   Card(1))
------------------------------------------------
3      List(
  1      List(
    1      :db.fn/retractEntity   17592186045445
    2      :db.fn/retractEntity   17592186045446
    3      :db/add   #db/id[:db.part/tx -1000097]    :metaData/user     b                                    Card(1)))
===================================================================================================================

eids: Iterable of entity ids of type Long
txMetaDataMolecules: Zero or more transaction meta data molecules
conn: Implicit Conn value in scope
returns: Unit (prints to output)

Definition Classes: EntityOps

implicit final def double2Model(v: Double): TermValue[Double]

Definition Classes
LogicImplicits
implicit final def doubleSet2Model(set: Set[Double]): TermValue[Set[Double]]

Definition Classes
LogicImplicits
final def eq(arg0: AnyRef): Boolean

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

Definition Classes
AnyRef → Any
def finalize(): Unit

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( classOf[java.lang.Throwable] )
implicit final def float2Model(v: Float): TermValue[Float]

Definition Classes
LogicImplicits
implicit final def floatSet2Model(set: Set[Float]): TermValue[Set[Float]]

Definition Classes
LogicImplicits
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
Annotations
@native()
def hashCode(): Int

Definition Classes
AnyRef → Any
Annotations
@native()
implicit final def int2Model(v: Int): TermValue[Int]

Definition Classes
LogicImplicits
implicit final def intSet2Model(set: Set[Int]): TermValue[Set[Int]]

Definition Classes
LogicImplicits
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
implicit final def long2Entity(id: Long)(implicit conn: Conn): Entity
Long -> Entity api implicit.
Long -> Entity api implicit.

Convenience implicit to allow calling Entity methods directly on entity Long value.
```
// Get entity id of Ben
val benId = Person.e.name_("Ben").get.head

// Retract Ben entity directly on his entity id
benId.retract
```
id
Entity id of type Long
conn
Implicit Conn value in scope

Definition Classes
EntityOps
implicit final def long2Model(v: Long): TermValue[Long]

Definition Classes
LogicImplicits
implicit final def longSet2Model(set: Set[Long]): TermValue[Set[Long]]

Definition Classes
LogicImplicits
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
Annotations
@native()
final def notifyAll(): Unit

Definition Classes
AnyRef
Annotations
@native()
def recreateDbFrom(schema: SchemaTransaction, identifier: String = "", protocol: String = "mem"): Conn
Deletes existing database (!) and creates a new empty db with schema from Schema Transaction file.
Deletes existing database (!) and creates a new empty db with schema from Schema Transaction file.

A typical development cycle in the initial stages of creating the db schema:
1. Edit schema definition file
2. sbt compile to update boilerplate code in generated jars
3. Obtain a fresh connection to new empty db with updated schema:
  implicit val conn = recreateDbFrom(YourDomainSchema)
schema
Auto-generated YourDomainSchema Transaction object
(in package yourdomain.schema of generated source jar)
identifier
Optional String identifier to name database (default empty string creates a randomUUID)
protocol
Datomic protocol. Defaults to "mem" for in-memory database.
returns
Conn

Definition Classes
Datomic
def recreateDbFromRaw(schemaData: List[_], identifier: String = "", protocol: String = "mem"): Conn
Deletes existing database (!) and creates a new empty db with schema from schema data structure.
Deletes existing database (!) and creates a new empty db with schema from schema data structure.

Schema data structure is a java List of Map's of key/value pairs defining the schema.

Can be an EDN file like the mbrainz example.
schemaData
java.util.List of java.util.Maps of key/values defining a Datomic schema
identifier
Optional String identifier to name database (default empty string creates a randomUUID)
protocol
Datomic protocol. Defaults to "mem" for in-memory database.
returns
Conn

Definition Classes
Datomic
See also
https://docs.datomic.com/on-prem/data-structure-literals.html
def retract(eids: Iterable[Long], txMetaDataMolecules: MoleculeBase*)(implicit conn: Conn): TxReport
Retract multiple entities with optional transaction meta data.
Retract multiple entities with optional transaction meta data.

0 or more transaction meta data molecules can be asserted together with a retraction of entities.

Here we retract two comment entities with transaction meta data asserting that the retraction was done by Ben Goodman:
```
retract(Seq(commentEid1, commentEid2), MetaData.user("Ben Goodman"))
```
We can then later see what comments Ben Goodman retracted (op_(false)):
```
Comment.e.text.op_(false).Tx(MetaData.user_("Ben Goodman")).getHistory === List(
  (commentEid1, "I like this"),
  (commentEid2, "I hate this")
)
```
eids
Iterable of entity ids of type Long
txMetaDataMolecules
Zero or more transaction meta data molecules
conn
Implicit Conn value in scope
returns
TxReport with result of retract

Definition Classes
EntityOps
See also
Manual | Test
implicit final def string2Model(v: String): TermValue[String]

Definition Classes
LogicImplicits
implicit final def stringSet2Model(set: Set[String]): TermValue[Set[String]]

Definition Classes
LogicImplicits
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
def toString(): String

Definition Classes
AnyRef → Any
def transactSchema(schema: SchemaTransaction, identifier: String, protocol: String = "mem"): Conn
Transact schema from auto-generated schema transaction data.
Transact schema from auto-generated schema transaction data.
schema
sbt-plugin auto-generated Transaction file path.to.schema.YourDomainSchema

Definition Classes
Datomic
implicit final def tuple2Model[A, B](tpl: (A, B)): TermValue[(A, B)]

Definition Classes
LogicImplicits
implicit final def uri2Model(v: URI): TermValue[URI]

Definition Classes
LogicImplicits
implicit final def uriSet2Model(set: Set[URI]): TermValue[Set[URI]]

Definition Classes
LogicImplicits
implicit final def uuid2Model(v: UUID): TermValue[UUID]

Definition Classes
LogicImplicits
implicit final def uuidSet2Model(set: Set[UUID]): TermValue[Set[UUID]]

Definition Classes
LogicImplicits
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
@native() @throws( ... )
object ? extends expression.AttrExpressions.?

Definition Classes
core
object avg extends avg

Definition Classes
core
object count extends count

Definition Classes
core
object countDistinct extends countDistinct

Definition Classes
core
object distinct extends distinct

Definition Classes
core
object max extends max

Definition Classes
core
object median extends median

Definition Classes
core
object min extends min

Definition Classes
core
object rand extends rand

Definition Classes
core
object sample extends sample

Definition Classes
core
object stddev extends stddev

Definition Classes
core
object sum extends sum

Definition Classes
core
object unify extends unify

Definition Classes
core
object variance extends variance

Definition Classes
core

Inherited from core

Inherited from EntityOps

Inherited from LogicImplicits

Inherited from AggregateKeywords

Inherited from AttrExpressions

Inherited from Datomic

Inherited from AnyRef

Inherited from Any

Database operations

Entity operations

Attribute markers

Markers applied to attributes that change the semantics of the attribute/molecule.

Expression implicits

Turns basic types into TermValue's that can be used in Expression

Aggregate keywords

Keywords applied to attributes that return aggregated value(s).

Number aggregation keywords

Keywords applied to number attributes that return aggregated value(s).

action		Actions on molecules and entities.
api		Molecule import interfaces of various arities.
ast		Internal Molecule ASTs.
boilerplate		Internal interfaces for auto-generated DSL boilerplate code.
composition		Builder methods to compose molecules.
exceptions		Exceptions thrown by Molecule.
expression		Attribute expressions and operations.
facade		Molecule facades to Datomic.
factory		Implicit macro methods `m` to instantiate molecules from custom DSL molecule constructs.
generic		Interfaces to generic information about datoms and Datomic database.
input		Input molecules awaiting input.
macro		Internal macros generating molecule code from custom DSL molecule constructs.
ops		Internal operational helpers for transforming DSL to molecule.
schema		Schema definition DSL.
transform		Internal transformers from DSL to Model/Query/Transaction.
util		Internal Java database functions for Datomic.

Packages

Sub-packages

core

object core extends core

Type Members

Value Members

Inherited from core

Inherited from EntityOps

Inherited from LogicImplicits

Inherited from AggregateKeywords

Inherited from AttrExpressions

Inherited from Datomic

Inherited from AnyRef

Inherited from Any

Database operations

Entity operations

Attribute markers

Expression implicits

Aggregate keywords

Number aggregation keywords

Ungrouped

Packages

Sub-packages

core 

object core extends core

Type Members

Value Members

Inherited from core

Inherited from EntityOps

Inherited from LogicImplicits

Inherited from AggregateKeywords

Inherited from AttrExpressions

Inherited from Datomic

Inherited from AnyRef

Inherited from Any

Database operations

Entity operations

Attribute markers

Expression implicits

Aggregate keywords

Number aggregation keywords

Ungrouped

core