Installation

Leverage CommandBox to install into your ColdBox app:

# Latest version
install cborm
‚Äč
# Bleeding Edge
install cborm@be

System Requirements

  • Lucee 5.x+

  • ColdFusion 2016+

Application.cfc Setup

Unfortunately, due to the way that ORM is loaded by ColdFusion, if you are using the ORM EventHandler or ActiveEntity or any ColdBox Proxies that require ORM, you must create an Application Mapping in the Application.cfc like this:

Application.cfc
# In the pseudo constructor
this.mappings[ "/cborm" ] = COLDBOX_APP_ROOT_PATH & "modules/cborm";

WireBox DSL

The module registers a new WireBox DSL called entityservice which can produce virtual or base orm entity services. Below are the injections you can use:

  • entityservice - Inject a global ORM service

  • entityservice:{entityName} - Inject a Virtual entity service according to entityName

Module Settings

Here are the module settings you can place in your ColdBox.cfc under moduleSettings -> cborm structure:

config/ColdBox.cfc
moduleSettings = {
cborm = {
injection = {
// enable entity injection via WireBox
enabled = true,
// Which entities to include in DI ONLY, if empty include all entities
include = "",
// Which entities to exclude from DI, if empty, none are excluded
exclude = ""
}
}
}

Validation

We have also integrated a UniqueValidator from the validation module into our ORM module. It is mapped into WireBox as UniqueValidator@cborm so you can use in your model constraints like so:

{ fieldName : { validator: "UniqueValidator@cborm" } }