Packages

  • package root

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

    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.

    Definition Classes
    root
  • package core
    Definition Classes
    molecule
  • package api
    Definition Classes
    core
  • package exception
    Definition Classes
    api
  • package get

    Synchronous getter methods to retrieve data from Datomic.

    Synchronous getter methods to retrieve data from Datomic.

    The Datomic On-Prem(ises) server model provides a Peer that returns data synchronously. The Peer which lives in application memory caches data aggressively and for data fitting in memory latency can be extremely low and queries return very fast. And even when access to disk is needed, clever branching is used. Memcached is also an option.

    The Datomic Cloud model data returns data asynchronously. If Datomic creates a Java API for the Cloud model, Molecule could relatively easy adapt to this model too. In the meanwhile, Future-wrapped methods in this package can be used.

    Molecule has 5 groups of synchronous getters, each returning data in various formats:

    • GetArray - fastest retrieved typed data set. Can be traversed with a fast while loop
    • GetIterable - for lazily traversing row by row
    • GetJson - data formatted as Json string
    • GetList - default getter returning Lists of tuples. Convenient typed data, suitable for smaller data sets
    • GetRaw - fastest retrieved raw un-typed data from Datomic

    Getters in each of the 5 groups come with 5 time-dependent variations:

    • get [current data]
    • getAsOf
    • getSince
    • getWith
    • getHistory

    Each time variation has various overloads taking different parameters (see each group for more info).

    Definition Classes
    api
    See also

    equivalent asynchronous getters in the getAsync package.

  • GetArray
  • GetIterable
  • GetJson
  • GetList
  • GetRaw
  • package getAsync

    Asynchronous getter methods to retrieve data from Datomic.

    Asynchronous getter methods to retrieve data from Datomic.

    For convenience, all synchronous getter methods from the get package are here wrapped in Futures.

    The Datomic On-Prem(ises) server model provides a Peer that returns data synchronously. The Peer which lives in application memory caches data aggressively and for data fitting in memory latency can be extremely low and queries return very fast. And even when access to disk is needed, clever branching is used. Memcached is also an option.

    The Datomic Cloud model data returns data asynchronously. If Datomic creates a Java API for the Cloud model, Molecule could relatively easy adapt to this model too. In the meanwhile, Future-wrapped methods in this package can be used.

    Molecule has 5 groups of asynchronous getters, each returning Futures of data in various formats:

    • GetAsyncArray - fastest retrieved typed data set. Can be traversed with a fast while loop
    • GetAsyncIterable - for lazily traversing row by row
    • GetAsyncJson - data formatted as Json string
    • GetAsyncList - default getter returning Lists of tuples. Convenient typed data, suitable for smaller data sets
    • GetAsyncRaw - fastest retrieved raw un-typed data from Datomic

    Getters in each of the 5 groups come with 5 time-dependent variations:

    • getAsync [current data]
    • getAsyncAsOf
    • getAsyncSince
    • getAsyncWith
    • getAsyncHistory

    Each time variation has various overloads taking different parameters (see each group for more info).

    Definition Classes
    api
    See also

    equivalent synchronous getters in the get package.

package get

Synchronous getter methods to retrieve data from Datomic.

The Datomic On-Prem(ises) server model provides a Peer that returns data synchronously. The Peer which lives in application memory caches data aggressively and for data fitting in memory latency can be extremely low and queries return very fast. And even when access to disk is needed, clever branching is used. Memcached is also an option.

The Datomic Cloud model data returns data asynchronously. If Datomic creates a Java API for the Cloud model, Molecule could relatively easy adapt to this model too. In the meanwhile, Future-wrapped methods in this package can be used.

Molecule has 5 groups of synchronous getters, each returning data in various formats:

  • GetArray - fastest retrieved typed data set. Can be traversed with a fast while loop
  • GetIterable - for lazily traversing row by row
  • GetJson - data formatted as Json string
  • GetList - default getter returning Lists of tuples. Convenient typed data, suitable for smaller data sets
  • GetRaw - fastest retrieved raw un-typed data from Datomic

Getters in each of the 5 groups come with 5 time-dependent variations:

  • get [current data]
  • getAsOf
  • getSince
  • getWith
  • getHistory

Each time variation has various overloads taking different parameters (see each group for more info).

Source
package.scala
See also

equivalent asynchronous getters in the getAsync package.

Linear Supertypes
AnyRef, Any
Content Hierarchy
GetList[Tpl]GetArray[Tpl]

Type Members

  1. trait GetArray[Tpl] extends AnyRef

    Data getter methods on molecules returning Array[Tpl].

    Data getter methods on molecules returning Array[Tpl].

    The fastest way of getting a large typed data set. Can then be traversed with a fast while loop.

  2. trait GetIterable[Tpl] extends AnyRef

    Data getter methods on molecules that return Iterable[Tpl].

    Data getter methods on molecules that return Iterable[Tpl].

    Suitable for data sets that are lazily consumed.

  3. trait GetJson extends AnyRef

    Data getter methods on molecules that return a Json String.

    Data getter methods on molecules that return a Json String.

    Molecule builds a Json String directly from the untyped raw Datomic data.

    Attributes names are used as Json field names. In order to distinguish fields from each other, all attribute names are prepended with the namespace name (in lowercase). For a namespace Person with an attribute name we get:

    • "person.name"

    To distinguis fields of multiple relationships to the same namespace like friends and enemies pointing to other Person's require us to add a relationship name prefix too:

    • "friends.person.name"
    • "enemies.person.name"

    Furthermore, if the attribute is part of a transaction meta-data molecule, we prefix that with tx too:

    • "tx.person.name"
    • "tx.friends.person.name"
  4. trait GetList[Tpl] extends GetArray[Tpl] with Quoted

    Default data getter methods on molecules that return List[Tpl].

    Default data getter methods on molecules that return List[Tpl].

    For expected smaller result sets it's convenient to return Lists of tuples of data. Considered as the default getter, no postfix has been added (get instead of getList).

  5. trait GetRaw extends AnyRef

    Data getter methods on molecules that return raw untyped Datomic data.

    Data getter methods on molecules that return raw untyped Datomic data.

    Returns raw untyped java.util.Collection[java.util.List[Object]] directly from Datomic and is therefore the fastest (but untyped) way of retrieving data. Can be useful where typed data is not needed.

Inherited from AnyRef

Inherited from Any

Ungrouped