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.

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

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

package exception

Definition Classes: api

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).

Definition Classes: api
See also: equivalent asynchronous getters in the getAsync package.

package getAsync

Asynchronous getter methods to retrieve data from Datomic.

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

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.

Entity

EntityOps

Molecule

OptionalMapOps

ShowDebug

TxMethods

core

in1_out1

in1_out10

in1_out11

in1_out12

in1_out13

in1_out14

in1_out15

in1_out16

in1_out17

in1_out18

in1_out19

in1_out2

in1_out20

in1_out21

in1_out22

in1_out3

in1_out4

in1_out5

in1_out6

in1_out7

in1_out8

in1_out9

in2_out1

in2_out10

in2_out11

in2_out12

in2_out13

in2_out14

in2_out15

in2_out16

in2_out17

in2_out18

in2_out19

in2_out2

in2_out20

in2_out21

in2_out22

in2_out3

in2_out4

in2_out5

in2_out6

in2_out7

in2_out8

in2_out9

in3_out1

in3_out10

in3_out11

in3_out12

in3_out13

in3_out14

in3_out15

in3_out16

in3_out17

in3_out18

in3_out19

in3_out2

in3_out20

in3_out21

in3_out22

in3_out3

in3_out4

in3_out5

in3_out6

in3_out7

in3_out8

in3_out9

out1

out10

out11

out12

out13

out14

out15

out16

out17

out18

out19

out2

out20

out21

out22

out3

out4

out5

out6

out7

out8

out9

molecule.api

Molecule

Companion trait Molecule

object Molecule

Arity 1-22 molecule implementation interfaces.

Source: Molecule.scala

Linear Supertypes

AnyRef, Any

Ordering

Alphabetic
By Inheritance

Inherited

Molecule
AnyRef
Any

Hide All
Show All

Visibility

Public
All

Type Members

abstract class Molecule01[A] extends Molecule[A]
abstract class Molecule02[A, B] extends Molecule[(A, B)]
abstract class Molecule03[A, B, C] extends Molecule[(A, B, C)]
abstract class Molecule04[A, B, C, D] extends Molecule[(A, B, C, D)]
abstract class Molecule05[A, B, C, D, E] extends Molecule[(A, B, C, D, E)]
abstract class Molecule06[A, B, C, D, E, F] extends Molecule[(A, B, C, D, E, F)]
abstract class Molecule07[A, B, C, D, E, F, G] extends Molecule[(A, B, C, D, E, F, G)]
abstract class Molecule08[A, B, C, D, E, F, G, H] extends Molecule[(A, B, C, D, E, F, G, H)]
abstract class Molecule09[A, B, C, D, E, F, G, H, I] extends Molecule[(A, B, C, D, E, F, G, H, I)]
abstract class Molecule10[A, B, C, D, E, F, G, H, I, J] extends Molecule[(A, B, C, D, E, F, G, H, I, J)]
abstract class Molecule11[A, B, C, D, E, F, G, H, I, J, K] extends Molecule[(A, B, C, D, E, F, G, H, I, J, K)]
abstract class Molecule12[A, B, C, D, E, F, G, H, I, J, K, L] extends Molecule[(A, B, C, D, E, F, G, H, I, J, K, L)]
abstract class Molecule13[A, B, C, D, E, F, G, H, I, J, K, L, M] extends Molecule[(A, B, C, D, E, F, G, H, I, J, K, L, M)]
abstract class Molecule14[A, B, C, D, E, F, G, H, I, J, K, L, M, N] extends Molecule[(A, B, C, D, E, F, G, H, I, J, K, L, M, N)]
abstract class Molecule15[A, B, C, D, E, F, G, H, I, J, K, L, M, N, O] extends Molecule[(A, B, C, D, E, F, G, H, I, J, K, L, M, N, O)]
abstract class Molecule16[A, B, C, D, E, F, G, H, I, J, K, L, M, N, O, P] extends Molecule[(A, B, C, D, E, F, G, H, I, J, K, L, M, N, O, P)]
abstract class Molecule17[A, B, C, D, E, F, G, H, I, J, K, L, M, N, O, P, Q] extends Molecule[(A, B, C, D, E, F, G, H, I, J, K, L, M, N, O, P, Q)]
abstract class Molecule18[A, B, C, D, E, F, G, H, I, J, K, L, M, N, O, P, Q, R] extends Molecule[(A, B, C, D, E, F, G, H, I, J, K, L, M, N, O, P, Q, R)]
abstract class Molecule19[A, B, C, D, E, F, G, H, I, J, K, L, M, N, O, P, Q, R, S] extends Molecule[(A, B, C, D, E, F, G, H, I, J, K, L, M, N, O, P, Q, R, S)]
abstract class Molecule20[A, B, C, D, E, F, G, H, I, J, K, L, M, N, O, P, Q, R, S, T] extends Molecule[(A, B, C, D, E, F, G, H, I, J, K, L, M, N, O, P, Q, R, S, T)]
abstract class Molecule21[A, B, C, D, E, F, G, H, I, J, K, L, M, N, O, P, Q, R, S, T, U] extends Molecule[(A, B, C, D, E, F, G, H, I, J, K, L, M, N, O, P, Q, R, S, T, U)]
abstract class Molecule22[A, B, C, D, E, F, G, H, I, J, K, L, M, N, O, P, Q, R, S, T, U, V] extends Molecule[(A, B, C, D, E, F, G, H, I, J, K, L, M, N, O, P, Q, R, S, T, U, V)]

Value Members

final def !=(arg0: Any): Boolean

Definition Classes
AnyRef → Any
final def ##(): Int

Definition Classes
AnyRef → Any
final def ==(arg0: Any): Boolean

Definition Classes
AnyRef → Any
final def asInstanceOf[T0]: T0

Definition Classes
Any
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@native() @throws( ... )
final def eq(arg0: AnyRef): Boolean

Definition Classes
AnyRef
def equals(arg0: Any): Boolean

Definition Classes
AnyRef → Any
def finalize(): Unit

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( classOf[java.lang.Throwable] )
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
Annotations
@native()
def hashCode(): Int

Definition Classes
AnyRef → Any
Annotations
@native()
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
Annotations
@native()
final def notifyAll(): Unit

Definition Classes
AnyRef
Annotations
@native()
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
def toString(): String

Definition Classes
AnyRef → Any
final def wait(): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long, arg1: Int): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long): Unit

Definition Classes
AnyRef
Annotations
@native() @throws( ... )

Packages

Sub-packages

Molecule

Companion trait Molecule

object Molecule

Type Members

Value Members

Inherited from AnyRef

Inherited from Any

Ungrouped

Packages

Sub-packages

Molecule 

Companion trait Molecule

object Molecule

Type Members

Value Members

Inherited from AnyRef

Inherited from Any

Ungrouped

Molecule