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 expression

    Attribute expressions and operations.

    Attribute expressions and operations.

    Refine attribute matches with various attribute expressions:

    Person.age(42)                           // equality
    Person.name.contains("John")             // fulltext search
    Person.age.!=(42)                        // negation (or `not`)
    Person.age.<(42)                         // comparison (< > <= >=)
    Person.name("John" or "Jonas")           // OR-logic
    Person.age()                             // apply empty value to retract value(s) in updates
    Person.hobbies.assert("golf")               // add value(s) to card-many attributes
    Person.hobbies.retract("golf")            // retract value(s) of card-many attributes
    Person.hobbies.replace("golf", "diving") // replace value(s) of card-many attributes
    Person.tags.k("en")                      // match values of map attributes by key
    Person.age(Nil)                          // match non-asserted datoms (null)
    Person.name(?)                           // initiate input molecules awaiting input at runtime
    Person.name(unify)                       // Unify attributes in self-joins

    Apply aggregate keywords to aggregate attribute value(s):

    // Aggregates on any attribute type
    Person.age(count).get.head         === 3   // count of asserted `age` attribute values
    Person.age(countDistinct).get.head === 3   // count of asserted distinct `age` attribute values
    Person.age(max).get.head           === 38  // maximum `age` value (using `compare`)
    Person.age(min).get.head           === 5   // maximum `age` value (using `compare`)
    Person.age(rand).get.head          === 25  // single random `age` value
    Person.age(sample).get.head        === 27  // single sample `age` value (when single value, same as random)
    
    // Aggregates on any attribute type, returning multiple values
    Person.age(distinct).get.head  === Vector(5, 7, 38)  // distinct `age` values
    Person.age(max(2)).get.head    === Vector(38, 7)     // 2 maximum `age` values
    Person.age(min(2)).get.head    === Vector(5, 7)      // 2 minimum `age` values
    Person.age(rand(2)).get.head   === Stream(5, ?)      // 2 random `age` values (values can re-occur)
    Person.age(sample(2)).get.head === Vector(7, 38)     // 2 sample `age` values
    
    // Aggregates on number attributes
    Person.age(sum).get.head      === 50               // sum of all `age` numbers
    Person.age(avg).get.head      === 16.66666667      // average of all `age` numbers
    Person.age(median).get.head   === 7                // median of all `age` numbers
    Person.age(stddev).get.head   === 15.107025591499  // standard deviation of all `age` numbers
    Person.age(variance).get.head === 228.2222222222   // variance of all `age` numbers
    Definition Classes
    molecule
    See also

    Manual: expressions | aggregates | input molecules

    Tests: expressions

  • trait AttrExpressions extends AnyRef

    Attribute expression markers and methods.

    Attribute expression markers and methods.

    Person.age(42)                           // equality
    Person.name.contains("John")             // fulltext search
    Person.age.!=(42)                        // negation (or `not`)
    Person.age.<(42)                         // comparison (< > <= >=)
    Person.age().get                         // match non-asserted datoms (null) in query
    Person(benId).age().update               // apply empty value to retract value(s) in updates
    Person.hobbies.assert("golf")            // assert card-many value(s)
    Person.hobbies.replace("golf", "diving") // replace card-many attribute value(s)
    Person.hobbies.retract("golf")           // retract card-many attribute value(s)
    Person.tags.k("en")                      // match values of map attributes by key
    Person.name(?)                           // initiate input molecules awaiting input at runtime
    Person.name(unify)                       // Unify attributes in self-joins
    Definition Classes
    expression
    See also

    Manual: expressions, aggregates, input molecules, self-join | Tests: expressions, input1, input2, input3

  • ?
  • AttrExpr
  • FulltextExpr
  • ManyAttrExpr
  • ManyExpr
  • MapAttrExpr
  • OneExpr
  • OptionalExpr
  • ValueAttrExpr
  • unify

trait ManyAttrExpr[Ns, Add, OldNew, Rem] extends AnyRef

Value update methods for card-many attributes.

Source
AttrExpressions.scala
Linear Supertypes
AnyRef, Any
Type Hierarchy
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. ManyAttrExpr
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

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 assert(values: Iterable[Add]): Ns with Attr

    Assert Iterable of card-many attribute values.

    Assert Iterable of card-many attribute values.

    Person.hobbies.get === List(Set("golf", "diving"))
    
    // Assert/add values of Iterable
    Person(benId).hobbies.assert(Seq("stamps", "walking", "theater")).update
    
    Person.hobbies.get === List(Set("golf", "diving", "stamps", "walking", "theater"))
    values

    Iterable of attribute values

    returns

    Molecule to be updated

  6. def assert(value: Add, moreValues: Add*): Ns with Attr

    Assert one or more card-many attribute values.

    Assert one or more card-many attribute values.

    Person.hobbies.get === List(Set("golf", "diving"))
    
    // Assert/add value
    Person(benId).hobbies.assert("stamps").update
    
    // Assert multiple values
    Person(benId).hobbies.assert("walking", "theater").update
    
    Person.hobbies.get === List(Set("golf", "diving", "stamps", "walking", "theater"))
    value

    New attribute value

    moreValues

    Optional additional new attribute values

    returns

    Molecule to be updated

  7. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native()
  8. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  9. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  10. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable])
  11. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  12. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  13. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  14. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  15. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  16. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  17. def replace(oldNews: Iterable[OldNew]): Ns with Attr

    Replace Iterable of card-many attribute values.

    Replace Iterable of card-many attribute values.

    Retracts old value and asserts new value.

    Person.hobbies.get === List(Set("golf", "diving"))
    
    // Replace values by applying Iterable of old/new value pairs
    Person(benId).hobbies.replace("theater" -> "concerts", "diving" -> "football").update
    
    Person.hobbies.get === List(Set("concerts", "football"))
    oldNews

    Iterable of old/new attribute values. For map attributes it's key/value pairs.

    returns

    Molecule to be updated

  18. def replace(oldNew: OldNew, oldNews: OldNew*): Ns with Attr

    Replace one or more card-many attribute values.

    Replace one or more card-many attribute values.

    Retracts old value and asserts new value.

    Person.hobbies.get === List(Set("golf", "diving"))
    
    // Replace value by applying old/new value pair
    Person(benId).hobbies.replace("golf" -> "theater").update
    
    // Replace multiple values by applying multiple old/new value pairs
    Person(benId).hobbies.replace("theater" -> "concerts", "diving" -> "football").update
    
    Person.hobbies.get === List(Set("concerts", "football"))
    oldNew

    Pair of old/new value

    oldNews

    Optional additional pairs of old/new value

    returns

    Molecule to be updated

  19. def retract(values: Iterable[Rem]): Ns with Attr

    Retract Iterable of card-many attribute values.

    Retract Iterable of card-many attribute values.

    Person.hobbies.get === List(Set("golf", "diving", "stamps", "walking", "theater"))
    
    // Retract multiple values
    Person(benId).hobbies.retract(List("walking", "theater")).update
    
    Person.hobbies.get === List(Set("golf", "diving", "stamps"))
    values

    Iterable of attribute values to be retracted

    returns

    Molecule to be updated

  20. def retract(value: Rem, moreValues: Rem*): Ns with Attr

    Retract one or more card-many attribute values.

    Retract one or more card-many attribute values.

    Person.hobbies.get === List(Set("golf", "diving", "stamps", "walking", "theater"))
    
    // Retract value
    Person(benId).hobbies.retract("theater").update
    
    // Retract multiple values
    Person(benId).hobbies.retract("stamps", "walking").update
    
    Person.hobbies.get === List(Set("golf", "diving"))
    value

    Attribute value to be retracted

    moreValues

    Optional additional attribute values to be retracted

    returns

    Molecule to be updated

  21. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  22. def toString(): String
    Definition Classes
    AnyRef → Any
  23. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  24. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  25. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()

Inherited from AnyRef

Inherited from Any

Ungrouped