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

  Definition Classes

  molecule

•  package exception

  Definition Classes

  api

• CompositeException
• EntityException
•  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.

•  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.

molecule.api

exception