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 api

    Public interface to be imported to use Molecule.

    Public interface to be imported to use Molecule.

    To make the Molecule macro materializations as fast as possible we try to import as few macro implicits as possible. If your application code build molecules with at the most 10 attributes, then you can do the following import to start using Molecule:

    import molecule.api.out10._

    out means "output molecule" , and 10 the maximum arity or number of attributes of your molecules.

    If you use input molecules awaiting an input then you can add inX where X is how many inputs (1, 2 or 3) you will use, for instance:

    import molecule.api.in2_out10._

    This way we keep the implicit macro def lookups to a minimum and compilation speed as fast as possible.

    Arities can be changed anytime you like. But not to a lower arity than that of the molecules you use in scope of the import.

    Definition Classes
    molecule
  • class Entity extends AnyRef

    Entity wrapper with actions on entity.

    Entity wrapper with actions on entity.

    Definition Classes
    api
    See also

    Manual | Tests: entity api

  • RetractMolecule
c

molecule.api.Entity

RetractMolecule

case class RetractMolecule(txMeta: MoleculeBase) extends Product with Serializable

Wrapper to add retract methods on entity with transaction meta data.

RetractMolecule is created from calling Tx:

val benId = Person.name("Ben").Tx(MyMetaData.action("add member")).save.eid

// Retract entity with tx meta data
benId.Tx(MyMetaData.action("moved away")).retract

// Query for Ben's history and why he was retracted
Person(benId).name.t.op.Tx(MyMetaData.action).getHistory === List(
  ("Ben", 1028, true, "add member"), // Ben added as member
  ("Ben", 1030, false, "moved away") // Ben retracted since he moved away
)
txMeta

A molecule with transaction meta data to be saved with entity retraction

Source
Entity.scala
Linear Supertypes
Serializable, Serializable, Product, Equals, AnyRef, Any
Type Hierarchy
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. RetractMolecule
  2. Serializable
  3. Serializable
  4. Product
  5. Equals
  6. AnyRef
  7. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new RetractMolecule(txMeta: MoleculeBase)

    txMeta

    A molecule with transaction meta data to be saved with entity retraction

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 def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  6. def debugRetract: Unit

    Debug entity retraction with transaction meta data.

    Debug entity retraction with transaction meta data.

    eid.Tx(MyMetaData.action("moved away")).debugRetract

    This will print generated Datomic transaction statements in a readable format to output:

    ## 1 ## Debug `retract` on entity with tx meta data
========================================================================
1          List(
  1          List(
    1          :db.fn/retractEntity   17592186045445
    2          :db/add   #db/id[:db.part/tx -1000100]  :myMetaData/action   moved away   Card(1)))
========================================================================
  7. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  8. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  9. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  10. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  11. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  12. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  13. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  14. def retract: TxReport

    Perform retraction of entity with added transaction meta data against database.

    Perform retraction of entity with added transaction meta data against database.

    returns

    TxReport with result of transaction

  15. def retractAsync(implicit ec: ExecutionContext): Future[TxReport]

    Perform asynchronous retraction of entity with added transaction meta data against database.

    Perform asynchronous retraction of entity with added transaction meta data against database.

    returns

    Future[molecule.facade.TxReport] with result of transaction

  16. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  17. val txMeta: MoleculeBase
  18. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  19. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  20. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Ungrouped