Packages

  • package root

    Documentation/API for the Molecule library - a meta DSL for the Datomic database.

    Manual | scalamolecule.org | Github | Forum

    Definition Classes
    root
  • package molecule

    Molecule library - a Scala meta-DSL for the Datomic database.

    Molecule library - a Scala meta-DSL for the Datomic database.

    See api package for various api imports to start using Molecule.

    Sub-packages

    api Molecule API.
    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.
    input Input molecules awaiting input.
    macros Internal macros generating molecule code from custom DSL molecule constructs.
    generic Interfaces to generic information about datoms and Datomic database.
    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.

    Definition Classes
    root
  • package generic
    Definition Classes
    molecule
  • package index

    Datomic Index APIs in Molecule.

    Datomic Index APIs in Molecule.

    Datomic maintains four indexes that contain ordered sets of datoms. Each of these indexes is named based on the sort order used:

    • EAVT - Datoms sorted by Entity-Attribute-Value-Transaction
    • AVET - Datoms sorted by Attribute-Value-Entity-Transaction
    • AEVT - Datoms sorted by Attribute-Entity-Value-Transaction
    • VAET - "Reverse index" for reverse lookup of ref types

    Create an Index molecule by instantiating an Index object with one or more arguments in the order of the Index's elements. Datoms are returned as tuples of data depending of which generic attributes you add to the Index molecule:

    // Create EAVT Index molecule with 1 entity id argument
EAVT(e1).e.a.v.t.get === List(
  (e1, ":Person/name", "Ben", t1),
  (e1, ":Person/age", 42, t2),
  (e1, ":Golf/score", 5.7, t2)
)

// Maybe we are only interested in the attribute/value pairs:
EAVT(e1).a.v.get === List(
  (":Person/name", "Ben"),
  (":Person/age", 42),
  (":Golf/score", 5.7)
)

// Two arguments to narrow the search
EAVT(e1, ":Person/age").a.v.get === List(
  (":Person/age", 42)
)
    Definition Classes
    generic
    Note

    The Molecule Index API's don't allow returning the whole Index/the whole database. So omitting arguments constructing the Index object (like EAVT.e.a.v.t.get) will throw an exception.
    Please use Datomics API if you need to return the whole database Index:
    conn.db.datoms(datomic.Database.EAVT)

    See also

    Tests for more Index query examples.

  • trait GenericVAET extends AnyRef

    Container for VAET reverse Index object.

    Container for VAET reverse Index object.

    Definition Classes
    index
  • VAET

object VAET extends VAET_0 with FirstNS

VAET Index object to start VAET reverse Index molecule.

Source
VAET.scala
Linear Supertypes
FirstNS, VAET_0, OutIndex_0, NS00[Nothing], NS, VAET, GenericNs, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. VAET
  2. FirstNS
  3. VAET_0
  4. OutIndex_0
  5. NS00
  6. NS
  7. VAET
  8. GenericNs
  9. AnyRef
  10. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Type Members

  1. type Next_[Attr[_, _], Type] = Attr[VAET_1[Type], P2[_, _]] with VAET_1[Type]
    Definition Classes
    VAET_0
  2. final class a[Ns, In] extends OneString[Ns, In] with Indexed

    (Partition)-Namespace-prefixed attribute name (":part_Ns/attr")

    (Partition)-Namespace-prefixed attribute name (":part_Ns/attr")

    Definition Classes
    VAET
  3. final class e[Ns, In] extends OneLong[Ns, In] with Indexed

    Entity id (Long)

    Entity id (Long)

    Definition Classes
    VAET
  4. final class op[Ns, In] extends OneBoolean[Ns, In] with Indexed

    Transaction operation: assertion (true) or retraction (false)

    Transaction operation: assertion (true) or retraction (false)

    Definition Classes
    VAET
  5. final class t[Ns, In] extends OneLong[Ns, In] with Indexed

    Transaction point in time t (Long/Int)

    Transaction point in time t (Long/Int)

    Definition Classes
    VAET
  6. final class tx[Ns, In] extends OneLong[Ns, In] with Indexed

    Transaction entity id (Long)

    Transaction entity id (Long)

    Definition Classes
    VAET
  7. final class txInstant[Ns, In] extends OneDate[Ns, In] with Indexed

    Transaction wall-clock time (Date)

    Transaction wall-clock time (Date)

    Definition Classes
    VAET
  8. final class v[Ns, In] extends OneAny[Ns, In] with Indexed

    Datom value (Any)

    Datom value (Any)

    Definition Classes
    VAET

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##: Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. final lazy val a: Next_[a, String]
    Definition Classes
    VAET_0
  5. final def apply(refId: Long, a: String, e: Long, t: Long): VAET_0

    Instantiate VAET reverse Index filtered by ref entity id value, attribute name, entity id and transaction entity id (tx) or point in time (t).

  6. final def apply(refId: Long, a: String, e: Long): VAET_0

    Instantiate VAET reverse Index filtered by ref entity id value, attribute name and entity id.

  7. final def apply(refId: Long, a: String): VAET_0

    Instantiate VAET reverse Index filtered by ref entity id value and attribute name.

  8. final def apply(refId: Long): VAET_0

    Instantiate VAET reverse Index filtered by ref entity id value.

  9. def apply(eids: expression.AttrExpressions.?): AnyRef

    Add entity id(s) input placeholder to the molecule.

    Add entity id(s) input placeholder to the molecule.
    At runtime, entity id(s) are applied as vararg(s) or list/sets.

    eids

    Iterable of entity ids, typically List, Seq or Set of ids.

    returns

    molecule to be further expanded with more attributes.

    Definition Classes
    FirstNS
  10. def apply(eids: Iterable[Long]): AnyRef

    Filter molecule by applying one or more entity ids of type Long.

    Filter molecule by applying one or more entity ids of type Long.

    eids

    Iterable of entity ids, typically List, Seq or Set of ids.

    returns

    molecule to be further expanded with more attributes.

    Definition Classes
    FirstNS
  11. def apply(eid: Long, eids: Long*): AnyRef

    Filter molecule by applying one or more entity ids of type Long.

    Filter molecule by applying one or more entity ids of type Long.

    eid

    First entity id

    eids

    Further entity ids (varargs)

    returns

    molecule to be further expanded with more attributes.

    Definition Classes
    FirstNS
  12. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  13. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native()
  14. final lazy val e: Next_[e, Long]
    Definition Classes
    VAET_0
  15. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  16. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  17. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable])
  18. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  19. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  20. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  21. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  22. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  23. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  24. final lazy val op: Next_[op, Boolean]
    Definition Classes
    VAET_0
  25. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  26. final lazy val t: Next_[t, Long]
    Definition Classes
    VAET_0
  27. def toString(): String
    Definition Classes
    AnyRef → Any
  28. final lazy val tx: Next_[tx, Long]
    Definition Classes
    VAET_0
  29. final lazy val txInstant: Next_[txInstant, Date]
    Definition Classes
    VAET_0
  30. final lazy val v: Next_[v, Long]
    Definition Classes
    VAET_0
  31. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  32. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  33. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()

Inherited from FirstNS

Inherited from VAET_0

Inherited from OutIndex_0

Inherited from NS00[Nothing]

Inherited from NS

Inherited from VAET

Inherited from GenericNs

Inherited from AnyRef

Inherited from Any

Ungrouped