Molecule0.25.1 < Back

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 getAsyncObj
Asynchronous getter methods to retrieve data as objects.
Asynchronous getter methods to retrieve data as objects.
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 4 groups of asynchronous getters for objects, each returning Futures of data in various formats:
- GetAsyncObjArray - fastest retrieved typed data set. Can be traversed with a fast while loop
- GetAsyncObjIterable - for lazily traversing row by row
- GetAsyncObjList - default getter returning Lists of objects. Convenient typed data, suitable for smaller data sets
- GetAsyncRaw - fastest retrieved raw un-typed data from Datomic
Getters in each of the 4 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 getTpl package.
package getAsyncTpl
Asynchronous getter methods to retrieve tuples of data.
Asynchronous getter methods to retrieve tuples of data.
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 4 groups of asynchronous getters for tuples, each returning Futures of data in various formats:
- GetAsyncTplArray - fastest retrieved typed data set. Can be traversed with a fast while loop
- GetAsyncTplIterable - for lazily traversing row by row
- GetAsyncTplList - 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 4 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 getTpl package.
package getObj
Synchronous getter methods to retrieve data as objects.
Synchronous getter methods to retrieve data as objects.
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 3 groups of synchronous object getters, each returning data in various formats:
- GetObjArray - fastest retrieved typed data set. Can be traversed with a fast while loop
- GetObjIterable - for lazily traversing row by row
- GetObjList - default getter returning Lists of objects. Convenient typed data, suitable for smaller data sets
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 getAsyncTpl package.
package getTpl
Synchronous getter methods to retrieve data as tuples.
Synchronous getter methods to retrieve data as tuples.
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.
Molecule has 4 groups of synchronous tuple getters, each returning data in various formats:
- GetTplArray - fastest retrieved typed data set. Can be traversed with a fast while loop
- GetTplIterable - for lazily traversing row by row
- GetTplList - 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 4 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 getAsyncTpl package.
GetAsyncRaw
GetRaw
InputMolecule
Keywords
Molecule_0
Molecule_1
Molecule_2
Molecule_3
OptionalMapOps
TxBundles
TxFunctions

molecule.core.api

TxFunctions

Companion object TxFunctions

trait TxFunctions extends AnyRef

Transactional methods for bundled transactions and tx functions

Source: TxFunctions.scala

Linear Supertypes

AnyRef, Any

Known Subclasses

api, api, 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

Type Hierarchy

Ordering

Grouped
Alphabetic
By Inheritance

Inherited

TxFunctions
AnyRef
Any

Hide All
Show All

Visibility

Public
All

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[lang]
Definition Classes
AnyRef
Annotations
@throws( ... ) @native()
final def eq(arg0: AnyRef): Boolean

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

Definition Classes
AnyRef → Any
def finalize(): Unit

Attributes
protected[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()

macro def inspectTransactFn(txFnCall: Seq[Seq[Statement]], txMolecules: Molecule*): Unit

Inspect tx function invocation

Print transaction statements to output of a tx function invocation without affecting the live database.

// Print inspect info for tx function invocation
inspectTransact(transfer(fromAccount, toAccount, 20))

// Prints produced tx statements to output:
/*
## 1 ## TxReport
========================================================================
1          ArrayBuffer(
  1          List(
    1          :db/add       17592186045445       :Account/balance    80        Card(1))
  2          List(
    1          :db/add       17592186045447       :Account/balance    720       Card(1)))
------------------------------------------------
2          List(
  1    1     added: true ,   t: 13194139534345,   e: 13194139534345,   a: 50,   v: Thu Nov 22 16:23:09 CET 2018

  2    2     added: true ,   t: 13194139534345,   e: 17592186045445,   a: 64,   v: 80
       3     added: false,  -t: 13194139534345,  -e: 17592186045445,  -a: 64,  -v: 100

  3    4     added: true ,   t: 13194139534345,   e: 17592186045447,   a: 64,   v: 720
       5     added: false,  -t: 13194139534345,  -e: 17592186045447,  -a: 64,  -v: 700)
========================================================================
*/

txFnCall: Tx function invocation
txMolecules: Optional tx meta data molecules

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
macro def transactFn(txFnCall: Seq[Seq[Statement]], txMolecules: Molecule*): TxReport
Transact tx function invocation

Macro that takes a tx function invocation itself as its argument.
Transact tx function invocation

Macro that takes a tx function invocation itself as its argument. The tx function is analyzed by the macro and the necessary transaction preparations done at compile time.

At runtime, the returned statements from the tx function is transacted as one atomic transaction.
```
val txReport = transact(transfer(fromAccount, toAccount, 20))
```
Transaction meta data molecules can be added
```
// Add tx meta data that John did the transfer and that it is a scheduled transfer
transact(
  transfer(fromAccount, toAccount, 20),
  Person.name("John"),
  UseCase.name("Scheduled transfer"))

// Query multiple Tx meta data molecules
Account(fromAccount).balance
  .Tx(Person.name_("John"))
  .Tx(UseCase.name_("Scheduled transfer")).get.head === 80
Account(toAccount).balance
  .Tx(Person.name_("John"))
  .Tx(UseCase.name_("Scheduled transfer")).get.head === 720
```
txFnCall
Tx function invocation
txMolecules
Optional tx meta data molecules
returns
TxReport with result of transaction
macro def transactFnAsync(txFnCall: Seq[Seq[Statement]], txMolecules: Molecule*): Future[TxReport]
Asynchronously transact tx function invocation

Macro that takes a tx function invocation itself as its argument.
Asynchronously transact tx function invocation

Macro that takes a tx function invocation itself as its argument. The tx function is analyzed by the macro and the necessary transaction preparations done at compile time.

At runtime, the returned statements from the tx function is asynchronously transacted as one atomic transaction using Datomic's asynchronous API.
```
Await.result(
  transactAsync(transfer(fromAccount, toAccount, 20)) map { txReport =>
    Account(fromAccount).balance.get.head === 80 // (could be asynchronous too)
    Account(toAccount).balance.get.head === 720
  },
  2.seconds
)
```
Additional transaction meta data can be added
```
Await.result(
  transactAsync(
    transfer(fromAccount, toAccount, 20),
    Person.name("John"),
    UseCase.name("Scheduled transfer")) map { txReport =>
      Account(fromAccount).balance
      .Tx(Person.name_("John"))
      .Tx(UseCase.name_("Scheduled transfer"))
      .get.head === 80 // (could be asynchronous too)
  },
  2.seconds
)
```
txFnCall
Tx function invocation
txMolecules
Optional tx meta data molecules
returns
Future with TxReport with result of transaction
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
@throws( ... ) @native()

Packages

TxFunctions

Companion object TxFunctions

trait TxFunctions extends AnyRef

Value Members

Inherited from AnyRef

Inherited from Any

Transaction functions

Ungrouped

Packages

TxFunctions 

Companion object TxFunctions

trait TxFunctions extends AnyRef

Value Members

Inherited from AnyRef

Inherited from Any

Transaction functions

Ungrouped

TxFunctions