Molecule0.10.0 < Back

Packages

package root

Definition Classes
root
package molecule

Definition Classes
root
package base

Definition Classes
molecule
package api

Definition Classes
base

trait DataModelApi extends AnyRef

Data Model DSL.

Data Model DSL.

Define a Domain Data Model in a data model 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.data.model._       // import data model DSL

object Seattle extends DataModel(8) {  // data model object with input/output arity

  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.data.model._

object Seattle extends DataModel(15) {

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

Options
Requierable
Validations
arrayByte
many
mapBigDecimal
mapBigInt
mapBoolean
mapByte
mapChar
mapDate
mapDouble
mapDuration
mapFloat
mapInstant
mapInt
mapLocalDate
mapLocalDateTime
mapLocalTime
mapLong
mapOffsetDateTime
mapOffsetTime
mapShort
mapString
mapURI
mapUUID
mapZonedDateTime
one
oneBigDecimal
oneBigInt
oneBoolean
oneByte
oneChar
oneDate
oneDouble
oneDuration
oneFloat
oneInstant
oneInt
oneLocalDate
oneLocalDateTime
oneLocalTime
oneLong
oneOffsetDateTime
oneOffsetTime
oneShort
oneString
oneURI
oneUUID
oneZonedDateTime
refOptions
seqBigDecimal
seqBigInt
seqBoolean
seqChar
seqDate
seqDouble
seqDuration
seqFloat
seqInstant
seqInt
seqLocalDate
seqLocalDateTime
seqLocalTime
seqLong
seqOffsetDateTime
seqOffsetTime
seqShort
seqString
seqURI
seqUUID
seqZonedDateTime
setBigDecimal
setBigInt
setBoolean
setByte
setChar
setDate
setDouble
setDuration
setFloat
setInstant
setInt
setLocalDate
setLocalDateTime
setLocalTime
setLong
setOffsetDateTime
setOffsetTime
setShort
setString
setURI
setUUID
setZonedDateTime
stringOptions

molecule.base.api.DataModelApi

refOptions

trait refOptions[Self] extends Requierable

Source: DataModelApi.scala

Linear Supertypes

Requierable, AnyRef, Any

Known Subclasses

many, many, one, one

Type Hierarchy

Ordering

Alphabetic
By Inheritance

Inherited

refOptions
Requierable
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
def apply[RefNs](description: String): refOptions[Self]
def apply[RefNs](implicit x: DummyImplicit): refOptions[Self]
Apply namespace type to reference.
Apply namespace type to reference.
RefNs
Ref namespace type
final def asInstanceOf[T0]: T0

Definition Classes
Any
def clone(): AnyRef

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

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

Definition Classes
AnyRef → Any
final def getClass(): Class[_]

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

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

Definition Classes
Any
lazy val mandatory: Self
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def notify(): Unit

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

Definition Classes
AnyRef
Annotations
@native() @IntrinsicCandidate()
lazy val owner: Self
Owner option.
Owner option.
This entity owns the referenced entity/entities.
- If this entity is deleted, its references are deleted too (and recursively if sub entities have owned entities!)

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/retractEntity, all subcomponents are also retracted.

When you get the graph of an entity, all its subcomponent entities are fetched recursively.
def require(attrs: Requierable*): Self
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
def toString(): String

Definition Classes
AnyRef → Any
final def wait(arg0: Long, arg1: Int): Unit

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

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

Definition Classes
AnyRef
Annotations
@throws( ... )

Deprecated Value Members

def finalize(): Unit

Attributes
protected[lang]
Definition Classes
AnyRef
Annotations
@throws( classOf[java.lang.Throwable] ) @Deprecated
Deprecated

Packages

refOptions

trait refOptions[Self] extends Requierable

Value Members

Deprecated Value Members

Inherited from Requierable

Inherited from AnyRef

Inherited from Any

Ungrouped

Packages

refOptions 

trait refOptions[Self] extends Requierable

Value Members

Deprecated Value Members

Inherited from Requierable

Inherited from AnyRef

Inherited from Any

Ungrouped

refOptions