Molecule0.22.4 < Back

Packages

package root
Documentation/API for the Molecule library - a meta DSL for the Datomic database.
Manual | scalamolecule.org | Github | Forum
Definition Classes
root

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 schema
Schema definition DSL and API.
Schema definition DSL and API.
Definition Classes
molecule

object definition

Schema definition DSL.

Schema definition DSL.

Define Datomic database schema in a Schema Definition file.

For small projects, the schema can be defined without partition definitions where all namespaces reside in a default tacit partition:

package path.to.your.project
import molecule.schema.definition._       // import schema definition DSL

@InOut(1, 8)                              // Set input/output arity
object SeattleDefinition {                // Schema definition object

  trait Person {                          // Namespace
    val name = oneString.fulltext   // String attribute definition with fulltext search
    val age  = oneInt                     // Int attribute definition
  }

  // Additional namespaces...
}

For larger projects, it is recommended to group namespaces in partitions:

package path.to.your.project
import molecule.schema.definition._

@InOut(3, 15)
object SeattleDefinition {

  object customer {
    trait Person {
      val name    = oneString.fulltext
      val age     = oneInt
      val address = one[Address]
      val bought  = many[products.Item]
    }
    trait Address {
      val street = oneString.fulltext
      val city   = oneInt
    }
    // ..more namespaces in the `customer` partition
  }

  object products {
    trait Item {
      val title   = oneString
      val inStock = oneInt
    }
    // ..more namespaces in the `products` partition
  }

  // Additional partitions...
}

Definition Classes: schema
See also: Manual | Tests: Schema without partitions, Schema with partitions, Bidirectionals

InOut
many
manyBi
manyBiEdge
manyBigDecimal
manyBigInt
manyBoolean
manyByte
manyDate
manyDouble
manyEnum
manyFloat
manyInt
manyLong
manyString
manyURI
manyUUID
mapBigDecimal
mapBigInt
mapBoolean
mapByte
mapDate
mapDouble
mapFloat
mapInt
mapLong
mapString
mapURI
mapUUID
one
oneBi
oneBiEdge
oneBigDecimal
oneBigInt
oneBoolean
oneByte
oneDate
oneDouble
oneEnum
oneFloat
oneInt
oneLong
oneString
oneURI
oneUUID
optionBuilder
refOptionBuilder
target

molecule.schema.definition

target

Companion object target

trait target extends refOptionBuilder[target]

Bi-directional edge target attribute.

Source: definition.scala
See also: Manual | Example

Linear Supertypes

refOptionBuilder[target], optionBuilder[target], AnyRef, Any

Known Subclasses

target

Type Hierarchy

Ordering

Alphabetic
By Inheritance

Inherited

target
refOptionBuilder
optionBuilder
AnyRef
Any

Hide All
Show All

Visibility

Public
Protected

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
def apply[RefNs]: target
Apply namespace type to reference.
Apply namespace type to reference.
RefNs
Ref namespace type
Definition Classes
refOptionBuilder
final def asInstanceOf[T0]: T0
Definition Classes
Any
def clone(): AnyRef
Attributes
protected[lang]
Definition Classes
AnyRef
Annotations
@throws(classOf[java.lang.CloneNotSupportedException]) @native()
def doc(s: String): Nothing
Attribute description.
Attribute description.
Definition Classes
optionBuilder
final def eq(arg0: AnyRef): Boolean
Definition Classes
AnyRef
def equals(arg0: AnyRef): Boolean
Definition Classes
AnyRef → Any
def finalize(): Unit
Attributes
protected[lang]
Definition Classes
AnyRef
Annotations
@throws(classOf[java.lang.Throwable])
final def getClass(): Class[_ <: AnyRef]
Definition Classes
AnyRef → Any
Annotations
@native()
def hashCode(): Int
Definition Classes
AnyRef → Any
Annotations
@native()
lazy val indexed: target
Indexed option (defaults to true).
Indexed option (defaults to true).

Generated index for this attribute. By default all attributes are set with the indexed option automatically by Molecule, so you don't need to set this.
Definition Classes
optionBuilder
lazy val isComponent: target
Is-component option.
Is-component option.

Specifies that an attribute whose type is :db.type/ref is a component.

Referenced entities become subcomponents of the entity to which the attribute is applied.

When you retract an entity with :db.fn/retractEntity, all subcomponents are also retracted.

When you touch an entity, all its subcomponent entities are touched recursively.
Definition Classes
refOptionBuilder
final def isInstanceOf[T0]: Boolean
Definition Classes
Any
final def ne(arg0: AnyRef): Boolean
Definition Classes
AnyRef
lazy val noHistory: target
No history option.
No history option.
Definition Classes
optionBuilder
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
lazy val uniqueIdentity: target
Unique identity option.
Unique identity option.

Attribute value is unique to each entity and "upsert" is enabled.

Attempts to insert a duplicate value for a temporary entity id will cause all attributes associated with that temporary id to be merged with the entity already in the database.
Definition Classes
optionBuilder
lazy val uniqueValue: target
Unique value option.
Unique value option.

Attribute value is unique to each entity.

Attempts to insert a duplicate value for a different entity id will fail.
Definition Classes
optionBuilder
final def wait(): Unit
Definition Classes
AnyRef
Annotations
@throws(classOf[java.lang.InterruptedException])
final def wait(arg0: Long, arg1: Int): Unit
Definition Classes
AnyRef
Annotations
@throws(classOf[java.lang.InterruptedException])
final def wait(arg0: Long): Unit
Definition Classes
AnyRef
Annotations
@throws(classOf[java.lang.InterruptedException]) @native()

Packages

Sub-packages

target

Companion object target

trait target extends refOptionBuilder[target]

Value Members

Inherited from refOptionBuilder[target]

Inherited from optionBuilder[target]

Inherited from AnyRef

Inherited from Any

Ungrouped

Packages

Sub-packages

target

Companion object target

trait target extends refOptionBuilder[target]

Value Members

Inherited from refOptionBuilder[target]

Inherited from optionBuilder[target]

Inherited from AnyRef

Inherited from Any

Ungrouped

target