BoxLang 🚀 A New JVM Dynamic Language Learn More...

quick

A CFML ORM Engine

Why?

Quick was built out of lessons learned and persistent challenges in developing complex RDBMS applications using built-in Hibernate ORM in CFML.

Hibernate ORM error messages often obfuscate the actual cause of the error because they are provided directly by the Java classes.
Complex CFML Hibernate ORM applications can consume significant memory and processing resources, making them cost-prohibitive and inefficient when used in microservices architecture.
Hibernate ORM is tied to the engine releases. This means that updates come infrequently and may be costly for non-OSS engine users.
Hibernate ORM is built in Java. This limits contributions from CFML developers who don't know Java or don't feel comfortable contributing to a Java project.
Hibernate ORM doesn't take advantage of a lot of dynamic- and meta-programming available in CFML. (Tools like CBORM have helped to bridge this gap.)

We can do better.

What?

Quick is an ORM (Object Relational Mapper) written in CFML for CFML. It provides an ActiveRecord implementation for working with your database. With it you can map database tables to components, create relationships between components, query and manipulate data, and persist all your changes to your database.

Prerequisites

You need the following configured before using Quick:

Configure a default datasource in your CFML engine
ColdBox 6+
qb 14.x (installed as a dependency of Quick)
Add a mapping for quick in your Application.cfc
Configure your BaseGrammar in config/ColdBox.cfc

See Getting Started for more details.

Supported Databases

Quick supports all databases supported by qb.

Example

Here's a "quick" example to whet your appetite.

We'll show the database structure using a migrations file. This isn't required to use quick, but it is highly recommended.

// 2017_11_10_122835_create_users_table.cfc
component {

    function up() {
        schema.create( "users", function( table ) {
            table.increments( "id" );
            table.string( "username" ).unique();
            table.string( "email" ).unique();
            table.string( "password" );
            table.timestamp( "createdDate" );
            table.timestamp( "updatedDate" );
        } );
    }

}

// User
component extends="quick.models.BaseEntity" {

    // the name of the table is the pluralized version of the model
    // this can be configured on a per-entity basis

}

// handlers/Users.cfc
component {

    // /users/:id
    function show( event, rc, prc ) {
        // this finds the User with an id of 1 and retrieves it
        prc.user = getInstance( "User" ).findOrFail( rc.id );
        event.setView( "users/show" );
    }

}

<!-- views/users/show.cfm -->
<cfoutput>
    <h1>Hi, #prc.user.getUsername()#!</h1>
</cfoutput>

Now that you've seen an example, dig in to what you can do with Quick!

Caching queries

Quick passes query options through to queryExecute, so applications can use the query cache provided by their CFML engine. This works with collection queries and primary-key lookups:

var users = getInstance( "User" ).get(
    options = { cachedWithin : createTimeSpan( 0, 0, 5, 0 ) }
);

var user = getInstance( "User" ).find(
    rc.id,
    { cachedWithin : createTimeSpan( 0, 0, 5, 0 ) }
);

An entity can also configure defaults for every query by assigning _queryOptions in its pseudo-constructor:

component extends="quick.models.BaseEntity" {

    variables._queryOptions = {
        cachedWithin : createTimeSpan( 0, 0, 5, 0 )
    };

}

Query caching stores database results, not live Quick entities or loaded relationships. Cache lifetime and invalidation are managed by the CFML engine, so use short lifetimes for data that Quick or another process may update. For application-specific invalidation or distributed caching, cache entity mementos in CacheBox at the service layer and rehydrate them through Quick's public APIs.

Passing a Quick query to qb

asQuery() changes how Quick returns results; it still returns a QuickBuilder. When a plain qb query needs a subquery built with Quick, pass the underlying qb builder using getQB() or retrieveQuery():

var userIds = getInstance( "User" ).where( "active", true ).select( "id" );
var posts = getInstance( "QueryBuilder@qb" )
    .from( "posts" )
    .whereIn( "user_id", userIds.getQB() )
    .get();

Keep Quick-specific scopes and column selection on the Quick builder before crossing this boundary. asQuery() is not a replacement for retrieveQuery().

belongsToMany().create( attributes, pivotAttributes ) saves the related entity, attaches its pivot row, and returns the saved entity. Supply additional pivot values in the second argument. Configure a pivot model with using() when reading pivot attributes through a model with casts or behavior.

A through relationship can traverse multiple intermediate entities and relationship types. Creating a target does not identify which intermediate records to reuse or create. Persist the target and intermediate associations explicitly through the direct relationship methods, using a transaction when those writes must succeed together. Quick does not infer and cascade-create an arbitrary through path.

Optional parallel eager loading

Parallel eager loading is disabled by default. To allow independent eager-load branches to run concurrently on Lucee and BoxLang, explicitly enable it in your ColdBox module settings:

moduleSettings = {
    quick = {
        parallelEagerLoading = true
    }
};

Then opt in on individual queries:

var posts = getInstance( "Post" )
    .with( [ "author", "tags" ], true )
    .get();

With parallelEagerLoading = false (the default), Quick does not create or validate a parallel executor, and all eager loading remains sequential even when .with( relations, true ) is used. Enabling the module setting still requires the per-query opt-in shown above. Adobe ColdFusion, a single top-level relationship, and active database transactions use the sequential path. Parallel workers retrieve and hydrate separate branches; matching the results onto the parent entities happens on the calling thread. Worker errors and timeouts propagate to the caller.

Quick's module settings include parallelEagerLoadingMaxThreads (default 4), parallelEagerLoadingTimeout (default 60000 milliseconds per batch), and parallelEagerLoadingExecutor (the name of an optional application-provided bounded ColdBox executor). When parallel eager loading is enabled, Quick creates and manages a fixed executor when none is supplied. Account for database connection capacity when increasing concurrency.

Testing with model factories

Quick includes Laravel-inspired model factories under quick.resources.testing. Define application factories outside of your production model code:

// tests/resources/factories/UserFactory.cfc
component extends="quick.resources.testing.Factory" {

    struct function definition() {
        return {
            username  : "factory-#lCase( createUUID() )#",
            firstName : "Factory",
            lastName  : "User"
        };
    }

    any function administrator() {
        return state( { type : "admin" } );
    }

}

Create a manager in your test base class and expose a short factory() helper:

variables.factoryManager = new quick.resources.testing.FactoryManager(
    wirebox     = getWireBox(),
    factoryPath = "tests.resources.factories"
);

any function factory( required string name ) {
    return variables.factoryManager.factory( arguments.name );
}

Factories support default definitions, explicit and named states, counts, sequences, attribute closures, and afterMaking and afterCreating callbacks. make() returns unsaved Quick entities, while create() persists through the entity's normal save() lifecycle:

var admin = factory( "User" ).administrator().create();
var users = factory( "User" ).count( 3 ).create();
var unsavedUser = factory( "User" ).make( { firstName : "Override" } );

Factories do not manage database transactions. Integration tests should start a transaction around each test and roll it back in finally, ensuring both passing and failing tests leave the database unchanged.

All factory implementation classes are isolated beneath resources/testing; production deployment tooling may exclude that directory. Quick does not load or register these classes during normal module startup.

Tests and Contributing

To run the tests, first clone this repo and run a box install.

Quick's test suite runs specifically on MySQL, so you will need a MySQL database to run the tests. If you do not have one, Docker provides an easy way to start one.

docker run -d --name quick -p 3306:3306 -e MYSQL_RANDOM_ROOT_PASSWORD=yes -e MYSQL_DATABASE=quick -e MYSQL_USER=quick -e MYSQL_PASSWORD=quick mysql:5

Finally, copy the .env.example file to .env and fill in the values for your database.

Prior Art, Acknowledgements, and Thanks

Quick is backed by qb. Without qb, there is no Quick.

Quick is inspired heavily by Eloquent in Laravel. Thank you Taylor Otwell and the Laravel community for a great library.

Development of Quick is sponsored by Ortus Solutions. Thank you Ortus Solutions for investing in the future of CFML.

Community and Support

Join us in our Ortus Community and become a valuable member of this project Quick ORM. We are looking forward to hearing from you!

v13.0.4

25 Sep 2026 — 19:25: 07 UTC

other

*: ci: apply full-null compatibility patches only to ColdBox 7 (b1504f0)
*: fix: disable parallel eager loading infrastructure by default (bc80a56)

v13.0.3

21 Sep 2026 — 03:32: 08 UTC

other

*: ci: contain experimental cron failures (a752824)

v13.0.2

19 Sep 2026 — 01:42: 03 UTC

other

*: Merge next into main (23d0e4e)
*: Apply cfformat changes (d9a89bd)
*: fix: require qb 14.0.2 (fae22b3)
*: Apply cfformat changes (27ff030)
*: Apply cfformat changes (fa442b1)
*: docs: clarify query interop and relationship persistence boundaries (21dbb4c)
*: Apply cfformat changes (cde9cf4)
*: Use cross-engine array membership in tests (018953f)
*: Restore application mappings in Lucee workers (07bf73f)
*: Resolve worker query clones through WireBox (cdd019d)
*: Expand parallel eager loading hydration (4e165bd)
*: Isolate BoxLang parallel worker requests (e27d867)
*: Track parallel worker contexts explicitly (f0e73f8)
*: Use ColdBox executor for parallel eager loading (0313d42)
*: avoid Lucee test bytecode verifier failure (4e17ffb)
*: split eager loading test registrations (cb3049c)
*: fix parallel eager loading isolation (7a2c347)
*: fix: avoid BoxLang thread scope collision (e062805)
*: fix: disambiguate serialized attribute state (839583b)
*: fix: use portable thread attribute resolution (001e13e)
*: test: allow concurrent worker failure ordering (20bf778)
*: fix: preserve parallel eager loading semantics (d8c38b6)
*: fix: hydrate parallel entities inside workers (38499d0)
*: fix: hydrate loaded entities for parallel workers (541e33e)
*: fix: tag null thread values before assignment (ec7801f)
*: fix: transfer parallel eager loads as entity state (cc23c28)
*: fix: retain eager-loaded CFCs in their worker state (4c9a4ee)
*: fix: detect parallel support on BoxLang (ca0122e)
*: fix: transfer eager relationship values directly (4119599)
*: fix: preserve parallel eager-load results across threads (991849f)
*: fix: preserve Lucee thread merge scope (c840e82)
*: fix: isolate parallel merge loop variables (5eabe8a)
*: refactor: avoid internal closures (f147b0b)
*: fix: preserve engine thread transfer semantics (3f02055)
*: fix: make parallel eager loading cross-engine safe (bb15413)
*: Add optional parallel eager loading (c11ef6b)
*: fix: support derived table aliases with released qb 14.0.1 (e324280)
*: fix: preserve null getters and SQL-valued where arguments (e466373)
*: Apply cfformat changes (ddb7edd)
*: Apply cfformat changes (c805881)
*: Apply cfformat changes (164e946)
*: ci: use released TestBox null-safety fixes (0b8c206)
*: Apply cfformat changes (b953704)
*: test: retain global restrictions for refreshed projections (d43b069)
*: Apply cfformat changes (c213f2f)
*: fix: preserve query identity and delegated void results (a0b6fd6)

v13.0.1

17 Sep 2026 — 17:47: 28 UTC

other

*: Apply cfformat changes (f9a0b4e)
*: fix: ignore irrelevant ordering for bulk mutations (f7c76eb)
*: fix: honor convertToNull when filling entities (5cd81e3)

v13.0.0

15 Sep 2026 — 23:27: 45 UTC

BREAKING

qb: document the qb 14 requirement (3d4ea75)

v12.1.0

15 Sep 2026 — 23:18: 46 UTC

chore

ci: fix dependency setup and upgrade semantic release (bac546d)

feat

Casts: delegate null handling to custom casts (#279) (914bfaf)

fix

Events: cast attributes assigned in preSave (#273) (#280) (7ce1dd4)
BaseEntity: handle null values in fill (#278) (9f534dc)

other

*: fix: Use qb 14 (d88715f)
*: Apply cfformat changes (cc98bbd)
*: Apply cfformat changes (4fa72d0)
*: test: verify timestamps precede persistence events (fbc0006)
*: fix: preserve uninitialized BoxLang attributes (590c370)
*: feat: Add automatic entity timestamps (d2fc9cb)
*: test: collect concurrent registry results portably (8df610b)
*: docs: record final performance verification (fe06ee0)
*: docs: complete architecture candidate dispositions (7524f1e)
*: docs: record query seed outcome (7066c9f)
*: docs: record hydration plan outcome (8dda70f)
*: perf: resolve hydration attributes once (082dab2)
*: perf: separate entity definitions from metadata cache (395f81b)
*: test: decompose metadata and hydration performance (ac22297)
*: docs: record cross-engine performance verification (7dbd605)
*: docs: record performance candidate outcomes (64474d8)
*: perf: index deep runtime attribute overlays (c28b033)
*: perf: clone refresh queries on demand (b4c9483)
*: perf: reduce attribute state allocations (8db931d)
*: refactor: remove soft delete closures (#356) (5e2997c)
*: feat: add model factories for testing (#355) (fbcf968)
*: Add built-in soft delete support (#340) (10989a0)
*: feat: guard loaded entity keys from mutation (#349) (d087d36)
*: feat: add entity replication (#350) (4e9c35a)
*: test: cover has-many deleteAll bindings (#352) (76de7d2)
*: Refresh database-generated attributes on save (#338) (c90d39c)
*: Support upserts through Quick entity queries (#334) (9e6a746)
*: feat: return empty relationships for new entities (#304) (5e2143c)
*: fix: restore cross-engine CI compatibility (#354) (8a3544f)
*: feat: fill relationships on new entities (#303) (219975a)
*: feat: support virtual attribute defaults (#113) (#328) (85cad3a)
*: refactor: reduce internal closure usage (05b8a6f)
*: Touch only configured timestamp fields (#341) (057c5b3)
*: Add selective and explicit eager-load clearing (#345) (5bc7d7c)
*: Reject duplicate entity property names (#337) (80a206b)
*: Add isClean entity state checks (#344) (833adf6)
*: Allow isDirty checks for one attribute (#343) (3b21380)
*: Add entity-aware chunk queries (#342) (5ba2231)
*: Test scoped subselects with all (#336) (92db1cb)
*: Add createAll for multiple entities (#335) (9d605a3)
*: feat: create belongs-to-many related entities (#331) (a808fa6)
*: feat: add belongs-to-many pivot models (#353) (56103b9)
*: feat: dispatch custom entity lifecycle events (#330) (27a165e)
*: feat: add whereBelongsTo relationship constraints (#311) (12fefa3)
*: Fix eager-load key type coercion (#274) (ada23eb)
*: feat: fill non-persistent entity properties (#313) (32c370b)
*: Add whereHasValue relationship shortcut (#318) (99c5cfc)
*: fix: transform default relationships to mementos (#159) (#310) (9cb2615)
*: feat: add relationship loaded hooks (#305) (2536ec2)
*: fix: recognize key columns mapped to aliases (#235) (#296) (3b2f5c6)
*: test: ignore non-persistent structs in dirty hashes (#146) (#316) (62143b5)
*: test: distinguish UUID and GUID key types (#80) (#332) (e5c47eb)
*: test: cover updateOrCreate primary key aliases (#107) (#329) (675e55c)
*: test: compare whereHas through constraints (#116) (#327) (a89a72d)
*: test: cover has one through initial constraints (#119) (#326) (41c3b1f)
*: test: verify relationship fill does not persist (#120) (#325) (4192148)
*: test: cover polymorphic eager loading key names (#122) (#324) (830f99f)
*: Test eager loading on CBORM compatible entities (#322) (4963e5a)
*: test: preserve bindings while chunking scoped queries (#151) (#315) (4ce97c3)
*: test: support full-null relationship coverage (#312) (e37ac8d)
*: test: cover QuickCollection eager loading (#309) (6c486ae)
*: test: strengthen relationship fill coverage (#188) (#302) (a460136)
*: test: cover date updates through query receivers (#228) (#298) (cae103b)
*: test: cover discriminated cast mementos (#233) (#297) (00dcdff)
*: test: cover pagination ordered by subquery attributes (#236) (#295) (633c922)
*: test: cover original data in entity preUpdate events (#239) (#293) (1633021)
*: test: cover constrained hasManyThrough eager loading (#241) (#292) (0d5f177)
*: test: cover eager loaded relationship defaults (#242) (#291) (4c088cc)
*: test: cover simple QuickQB update values (#246) (#289) (436aac4)
*: test: cover scoped compound-key withCount (#262) (#286) (3a72541)
*: test: verify hasManyThrough subselect aliases (#264) (#285) (d6a0ba9)
*: fix: pass query options through find (#347) (024a7e7)
*: fix: qualify aliased selected attributes (#351) (c55ce37)
*: fix: preserve entity keys in selected columns (#348) (5967b7e)
*: Skip hasMany queries with null composite keys (#323) (ab790c1)
*: fix: synchronize loaded has-many relationships (#301) (e32eecd)
*: fix: reset cached queries with entity state (#300) (2300482)
*: fix: refresh scoped virtual projections (#299) (8add4f9)
*: perf: cache qualified entity columns (#306) (17fd8d6)
*: Fix table qualification in whereIn subqueries (#288) (b854e30)
*: fix: advance nested has relationship paths (#294) (0545868)
*: fix: eager load one-through relationships (#307) (9fad424)
*: fix: eager load belongsToThrough relationships (#254) (#287) (9e8accd)
*: Improve missing query scope errors (#317) (1a8fe7c)
*: Surface missing methods inside qb callbacks (#319) (908a44e)
*: test: cover QuickService get options (#266) (#284) (205754a)
*: fix: restore qb 14 compatibility (#283) (a3826be)
*: fix: exclude read-only attributes from persistence (#282) (d771cca)
*: fix: prioritize aliases over column names (#281) (f732e77)

v12.0.12

21 Mar 2026 — 03:09: 22 UTC

fix

Metadata: BoxLang Prime metadata compatibility (a057a91)

v12.0.11

21 Feb 2026 — 18:16: 43 UTC

chore

tests: Add additional test coverage (2ac2dc2)
tests: Fix timezone-dependent test failures in timestamp assertions (2ab1ff6)

fix

QuickBuilder: Fix join inside QuickBuilder (bf5d726)

v12.0.10

28 Jan 2026 — 21:56: 39 UTC

fix

qb: Migrate to join's joiningQuery name in qb 13.0.18 (1a95350)

v12.0.9

25 Jan 2026 — 01:53: 37 UTC

fix

BoxLang: Fix for BoxLang returning unmodifiable structs (cbab1bd)
EagerLoading: Fix multiple eager loaded relationships (95c612b)

v12.0.8

23 Oct 2025 — 21:12: 52 UTC

other

*: fix(BaseEntity): Use announce as official method for interception points (f9ee762)

v12.0.7

04 Sep 2025 — 16:48: 08 UTC

fix

BooleanCast: booleanFormat actually returns a string (c823213)

v12.0.6

04 Sep 2025 — 07:57: 09 UTC

fix

QuickBuilder: Fix for potential scope walking bug (cdebb52)

v12.0.5

02 Sep 2025 — 19:24: 35 UTC

fix

QueryUtils: Minor fix for isQuickBuilder checks on BoxLang (70b1710)

v12.0.4

15 Jul 2025 — 18:27: 26 UTC

fix

QuickBuilder: Allow passing options for retrieval methods (0e0fc11)

v12.0.3

11 Jul 2025 — 23:07: 07 UTC

fix

BaseEntity: More ACF compatibility fixes for parallel eager loading (3557e84)
BaseEntity: potential workaround for ACF (a46298e)
BaseEntity: use BIF for ACF compat (6f56f52)
BaseEntity: Fix async relationship loading (60b9ba8)

v12.0.2

19 Jun 2025 — 19:37: 19 UTC

fix

ModuleConfig: Ensure cache exists before clearing it when unloading Quick (baaa763)

v12.0.1

18 Jun 2025 — 19:52: 37 UTC

fix

QuickQB: Fix for casts in where statements (c605721)

v12.0.0

12 Jun 2025 — 22:59: 56 UTC

BREAKING

HasManyDeep: Fix for deep entities with compound keys (21c3e03)
HasManyThrough: Use qb 13 to fix missing alias rewriting (95ce7e6)
box.json: Upgrade to latest dependencies (0b3a4c8)

chore

tests: Modify test to work with BoxLang (102406a)
CI: Stick to mysql:5.7 for now (028c2ad)
CI: Use explicity ports for MySQL 8 service (53e4edc)
CI: Update testing matrix and java versions (1d7c0c8)
CI: Use separate server.json files for different engines (ceb4484)

fix

QuickBuilder: Fix for qb 13's new column syntax (e7fb76a)
ChildEntity: Fix for bringing back columns correct when multiple child entities share the same column (9c5d69e)
QuickBuilder: Preserve case for withCount and withSum (1262c8d)
QuickQB: Casts values when using them in where clauses (6035327)
CI: Fix for Lucee 6 and custom DSNs in CI (1e2ddaf)

other

*: Failing test (25bca38)

v11.3.0

29 Apr 2025 — 20:55: 57 UTC

chore

CI: Lucee 6 is not ready for prime time (88473a0)
CI: More test engine matrix pruning (935fd04)
CI: Upgrade ACF testing matrix (3173e92)

feat

Relationship: Allow parallel loading for loadRelationship (4e2b199)

other

*: fix: Use ColdBox Async manager over built in async loops (5920e2c)

v11.2.1

04 Apr 2025 — 20:26: 28 UTC

fix

EagerLoading: Use box namespace for CommandBox compatibility (a05076f)

v11.2.0

03 Apr 2025 — 18:33: 20 UTC

feat

EagerLoading: Give entities a way to automatically eager load certain relationships (399bb93)
EagerLoading: Allow preventing all lazy loading of relationships (5939192)

fix

BoxLang: Compatibility updates (4426aee)

v11.1.0

05 Feb 2025 — 17:05: 10 UTC

feat

KeyTypes: Add GUID keyType introduced in QB v9 (38b2479)

fix

HasManyDeep: Account for compound keys in hasManyDeep relationships (71d9c5a)

v11.0.1

04 Feb 2025 — 02:48: 38 UTC

fix

QuickBuilder: Fix for aliases with fully server qualified identifiers (5b61ebe)

v11.0.0

03 Feb 2025 — 22:21: 28 UTC

BREAKING

*: feat: BoxLang compatibility (68dbfd4)

fix

QuickBuilder: Pass grammar to inferSqlType (54ca2aa)

v10.0.1

15 Jan 2025 — 18:16: 59 UTC

fix

BaseEntity: Better matching of only "as" in relationship strings (263461d)

v10.0.0

08 Oct 2024 — 06:05: 50 UTC

BREAKING

qb: Upgrade to qb v10 (8a9be8f)

v9.0.3

04 Oct 2024 — 17:13: 58 UTC

fix

ChildEntity: Ensure single table inheritance columns are not duplicated (2a37ead)

v9.0.2

24 Sep 2024 — 18:55: 51 UTC

fix

HasOneThrough: Add missing matchOne method (a09196e)
ChildEntities: Fix qualifying column on discriminated joined entities (d3559bc)

v9.0.1

12 Jun 2024 — 21:45: 58 UTC

fix

BaseEntity: Fixed issue with NULL values being inserted into identity columns for MSSQL (4ae80fa)

v9.0.0

31 May 2024 — 22:18: 55 UTC

BREAKING

Relationships: Return default entities for non-matched eager loaded entites (b1212de)
Child Entities: Fix casting for discriminated entities (288b81b)

chore

tests: Only test against Lucee 6 in cron tests (940ed80)
tests: Add in Adobe 2023 and ColdBox 7 to the testing matrix (cd3c8da)

feat

Relationships: Get a new filled instance of a relationship by calling the fill method on the relationship object (a2da133)
Events: Add newAttributes and originalAttributes to the preUpdate event (4dd8496)
Relationships: Add additional fetch methods to all relationships (9709b2f)
Casts: Allow specifying virtual attributes with a cast (a57d092)

fix

Relationships: Clear the relationship cache for a relationship when using the relationship setter (f49b099)
BaseEntity: Only computed attributes hash from persistent attributes (164b047)
Relationships: Fix naming collision with newEntity function and variable name. (81aedbb)
BaseEntity: Handle null values when assigning to attributes (ba3a2f4)
HasOneOrMany: Allow returning a new non-persisted entity (084a089)

other

*: Fixed issue null check would never pass (38005c9)
*: Update JsonCast.cfc (b92fc0a)
*: -fixed regression for issue #203 (45095ad)
*: remove hydrate in favor of manually assigning attributes (c87cb9c)
*: Fixed issue where virtualAttributes were not being applied to discriminated child entities when loading through the parent (149aa9e)

v8.0.3

19 Apr 2024 — 21:16: 01 UTC

fix

ModuleConfig: Support qb's SqlCommenter (66799c6)

v8.0.2

26 Mar 2024 — 22:12: 23 UTC

fix

Relationships: Handle skipping constraints when a relationship is defined with other relationships (62fa4a4)

v8.0.1

26 Mar 2024 — 20:03: 50 UTC

fix

BaseEntity: Make the withoutRelationshipConstraints check more resilient (4aedbac)

v8.0.0

26 Mar 2024 — 19:33: 41 UTC

BREAKING

Relationship: Required the relationship name when disabling constraints to match on (dff52d6)

v7.4.4

26 Mar 2024 — 18:11: 18 UTC

fix

HasManyThrough: Fix for thread safety when loading multiple relationships off of a single entity (9e49f55)

v7.4.3

22 Mar 2024 — 03:08: 47 UTC

fix

HasManyDeep: Fix qualifying column issue (72723b1)

v7.4.2

20 Mar 2024 — 22:55: 50 UTC

fix

HasManyDeep: Remove duplicate join from addCompareConstraints (a9fa07e)

v7.4.1

19 Mar 2024 — 17:54: 52 UTC

fix

box.json: Upgrade to latest str dependency (582e4cc)

v7.4.0

18 Mar 2024 — 16:41: 44 UTC

chore

tests: Remove extra debug logs from tests (1ba3ca0)

feat

HasManyThrough: The hasManyThrough function now returns HasManyDeep relationships (1af491a)
Relationships: New hasManyDeep and hasManyDeepBuilder relationships. (5331b36)

fix

HasManyThrough: Keep constraints of through entities for hasManyThrough relationships (3f3de36)
HasManyThrough: Keep constraints on final related entities in hasManyThrough (95a53d3)
IRelationship: Update type hints to satisfy IRelationship interface (026d7e0)

other

*: v7.4.0-beta.2 (530502c)
*: v7.4.0-beta.1 (49e11bb)

v7.3.2

05 Feb 2024 — 20:23: 02 UTC

fix

BaseEntity: Use the interceptor approach instead of wirebox:targetId to support CommandBox (164247d)

v7.3.1

03 Jan 2024 — 17:58: 04 UTC

fix

Discriminators: Fix where discriminated entities could use the wrong qualified column name in the join with the parent entity. (682aa03)

v7.3.0

21 Dec 2023 — 19:13: 38 UTC

chore

tests: add test case for checking null attributes on newly created entities (638754a)
tests: add test case for deleteAll off of a hasMany relationship (1626bc5)
tests: add test case for belongsToMany withCount (8bfad62)
tests: add test case for firstOrNew with aliases and columns (5dc81bf)

feat

QuickBuilder: Return optional QuickBuilder instances for withCount and withSum (e1b17cf)

fix

BaseEntity: Fix clearAttribute when not setting to null (4018d54)
QuickBuilder: Fix using a query builder instance to define a subselect (8ac6ba7)

other

*: fix: revert server.json change (4182c55)

v7.2.0

15 Sep 2023 — 20:07: 44 UTC

feat

QuickQB: Allow defaultOptions for underlying QuickQB (a1e282f)

v4.1.5

02 Nov 2020 — 12:24: 13 UTC

fix

HasOne: Provide initialThroughConstraints for hasOne relationships (7b3b8d0)

v4.1.4

30 Oct 2020 — 18:35: 59 UTC

chore

Tests: Add test for dynamic subselect relationships (fdf97eb)

fix

Relationship: Don't include orders when doing a count on a relationship (#126) (313c594)

v4.1.3

10 Sep 2020 — 16:11: 22 UTC

chore

Testing: Migrate to new database fixtures setup (e65add5)

v4.1.2

04 Sep 2020 — 15:33: 44 UTC

fix

Casts: Fix for retaining cast cache when creating entities (835beee)

v4.1.1

03 Sep 2020 — 03:48: 53 UTC

chore

Format: Format with CFFormat (621ce6c)

fix

Cast: Preserve casted value after saving (8680b1d)

v4.1.0

28 Aug 2020 — 20:59: 11 UTC

feat

BaseEntity: Allow for child entities included discriminated entities (28bf5e2)

fix

KeyType: Look up returning values by column name not by alias (f1a0832)

v4.0.2

13 Aug 2020 — 05:45: 22 UTC

fix

EagerLoading: Skip eager loading when no keys are found (8b83529)
Relationships: Only apply CONCAT when needed (db220e2)

v4.0.1

04 Aug 2020 — 21:26: 55 UTC

fix

Relationships: Remove DISTINCT in favor of WHERE EXISTS (a051c98)

v4.0.0

24 Jul 2020 — 15:14: 31 UTC

BREAKING

Scopes: Scopes with an OR combinator are automatically grouped (3183f6d)

chore

docs: Fix broken link from README to official docs (6881634)

feat

Relationships: Add a withCount method to easily add relationship counts to entities (8524ef8)
QuickBuilder: Automatically scope whereHas and whereDoesntHave callbacks (38b8a46)

fix

ErrorMessages: Improve error message when attempting to set relationships on unloaded entities (fe4ad26)
Relationships: Fix addSubselect and *manyThrough overflows and bugs (ab8e121)
BelongsTo: If all the foreign keys are null, skip the database and return the default entity or null (287e990)
BelongsTo: Reference provided localKeys instead of pulling them from the related entity (43f47aa)
HasManyThrough: Swap final compare constraints in nested query (22d1728)

v3.1.7

10 Jul 2020 — 16:04: 10 UTC

fix

tests: Correct jQuery link in test runner (#95) (7bb1b3d)

v3.1.6

29 Jun 2020 — 19:19: 44 UTC

fix

QuickBuilder: Allow expressions in basic where clauses (f267c2f)
BaseEntity: Fix delete naming collision (c7dca98)

v3.1.5

24 Jun 2020 — 00:24: 50 UTC

fix

QuickBuilder: Add an alias to with (5491ba7)

v3.1.4

19 Jun 2020 — 05:58: 34 UTC

fix

QuickBuilder: Fix stack overflow on nested relationship checks (16bae19)

v3.1.3

19 Jun 2020 — 05:44: 30 UTC

fix

QuickBuilder: Configured tables are now used for qualifying columns (76bb1f7)

v3.1.2

29 May 2020 — 18:03: 15 UTC

fix

BelongsToMany: Remove unnecessary nesting in compare queries (97e3a88)

v3.1.1

28 May 2020 — 22:05: 51 UTC

fix

Relationships: Fix orWhereHas methods when querying nested relationships (8262bb3)

v3.1.0

28 May 2020 — 21:25: 33 UTC

feat

JSONCast: Add support for JSON casting (137701a)

v3.0.4

27 May 2020 — 05:41: 15 UTC

fix

CBORMCompatEntity: Updates for coldbox@6 (1f10fde)

v3.0.3

13 May 2020 — 17:24: 08 UTC

chore

CI: Fix module id (9d9c4ab)

fix

Casts: Optimize cast caching (2f9b510)

v3.0.2

11 May 2020 — 20:02: 26 UTC

fix

EagerLoading: Apply custom sqltypes during eager loading (c9633d3)

v3.0.1

08 May 2020 — 22:04: 29 UTC

fix

BaseEntity: Account for null values in fill (3f8bc2c)
Memento: Swap structAppend order for a Lucee bug (1e0d217)

v3.0.0

06 May 2020 — 19:01: 56 UTC

BREAKING

QuickBuilder: Prevent duplicate joins by default (a8ac022)
BaseEntity: Enforce accessors for entities (ad16248)
BaseEntity: Remove virtual inheritance (3b026b1)
BaseEntity: Improve virtual column support (5ebc42c)

chore

CI: CI debugging (1111603)
CI: CI debugging (19b3053)
CI: CI debugging (6280040)
CI: CI debugging (75bcb64)
CI: CI debugging (fda269a)
CI: CI debugging (5662bdc)
CI: CI debugging (7716222)
CI: CI debugging. :-( (1912c2a)
CI: Add qb mapping for tests (45c5238)
CI: Fix overriding coldbox@be installation (c4f9ae0)
CI: Publish API docs after publishing a new version (690b95d)
CI: Adjust CI builds to test bleeding edge on cron jobs (0ffdafc)
CI: Clean up .travis.yml (d5753b5)

feat

Interceptors: Fire the postLoad event for all entities (a480ef2)
ErrorMessages: Improve error message when accessing relationships on unloaded entities (d43f699)

fix

BaseEntity: Rename is and isNot to isSameAs and isNotSameAs for better ACF compatibility (fff27a1)
BaseEntity: Improved hasRelationship check (4064619)
QuickBuilder: Fix nested whereHas with belongsToMany Relationships (99f957e)
BaseEntity: Fix for virtual columns trying to be updated (5f13e4f)
BaseEntity: Qualify all column names and correctly return eager loaded belongsToMany Relationships (09f9c64)
BaseEntity: Forward updateOrInsert calls to updateOrCreate (888fa22)
Memento: Ensure virtual columns are included in mementos by default (6c72a46)
BaseEntity: qualify columns when using fresh and refresh (1cce0a2)
QuickBuilder: Clear orders when querying releationships (d77c781)
GlobalScopes: Ensure global scopes are only applied once per query (664b288)
BaseEntity: Duplicate metadata struct when creating new entities (5c06fa4)
BaseEntity: Fix double applying of global scopes (b374caa)
BaseEntity: Default polymorphicBelongsTo name to the relation method name (72352d6)

other

*: v3.0.0-beta.13 (27ada30)
*: v3.0.0-beta.12 (57c1098)
*: v3.0.0-beta.11 (defadc4)
*: v3.0.0-beta.10 (3ed41b4)
*: v3.0.0-beta.9 (0e761bf)
*: v3.0.0-beta.8 (5f33efa)
*: chore: format with cfformat (ad9d544)
*: v3.0.0-beta.7 (da7eb88)
*: Update docblocks (b48e1d8)
*: v3.0.0-beta.6 (24ad429)
*: v3.0.0-beta.5 (27e0258)
*: v3.0.0-beta.4 (d41d071)
*: v3.0.0-beta.3 (59bb622)
*: v3.0.0-beta.2 (6e2ceab)
*: v3.0.0-beta.1 (092ce93)
*: chore: Update docblocks (ecd3e27)
*: v3.0.0-alpha.2 (4f01505)

refactor

BaseEntity: Clean up virtual column naming (88d8237)

v2.5.7

26 Feb 2020 — 00:16: 25 UTC

other

*: docs: Fix link to Gitbook from README (5a8cf6a)

v2.5.6

19 Feb 2020 — 22:22: 10 UTC

fix

BaseEntity: Correctly use the grammar annotation (2312e9e)

v2.5.5

13 Feb 2020 — 17:30: 08 UTC

other

*: chore: Use forgeboxStorage (ad6c413)

v2.5.4

20 Dec 2019 — 06:20: 30 UTC

fix

CBORMCompat: Pass along query options in compat methods (9a2739e)

v2.5.3

11 Dec 2019 — 21:40: 12 UTC

fix

BaseEntity: Revert calling setters when hydrating entities (670fadb)

v2.5.2

09 Dec 2019 — 17:57: 41 UTC

fix

BaseEntity: Pass the entity to when closures (96a8f3a)

v2.5.1

05 Dec 2019 — 04:55: 20 UTC

fix

BaseEntity: Account for null values with custom setters (685e175)
BaseEntity: Reset underlying query when resetting entity (83a6fdb)

v2.5.0

04 Dec 2019 — 21:53: 02 UTC

feat

BaseEntity: Allow entities to define a custom collection type. (9135eee)

v2.4.3

19 Nov 2019 — 07:59: 46 UTC

fix

BaseEntity: Avoid stack overflow with getMemento and custom getters (7c9e073)

v2.4.2

08 Nov 2019 — 00:45: 47 UTC

fix

memento: Use available getters for the memento (ba562c3)

v2.4.1

07 Nov 2019 — 16:58: 47 UTC

fix

memento: Correctly serialize array relationships by default (479dabc)

v2.4.0

06 Nov 2019 — 22:25: 58 UTC

chore

dependencies: Update TestBox to version 3 (a0dd6ab)

feat

setters: Apply setters when hydrating the entity from the database (e4a0158)
ErrorMessages: Improve error messages for not loaded entities (f3f2e2d)
Scopes: Query scopes can return any value (358e977)

v2.3.1

06 Nov 2019 — 21:45: 40 UTC

chore

build: Adjust travis testbox run (790df84)

fix

tests: Fix strange test error on Lucee 5 with nested describe blocks (305e0a2)
BaseEntity: Return the correct memento with accessors on (59614a0)

v2.3.0

08 Jul 2019 — 15:46: 12 UTC

feat

BaseEntity: Add flag to ignore non-existing attributes to fill (428b31a)

v2.2.3

17 Jun 2019 — 15:06: 40 UTC

fix

BaseEntity: Temporary fix for extra values in data (821a054)

v2.2.2

14 Jun 2019 — 05:10: 05 UTC

perf

BaseEntity: Better caching of metadata (27b6ec3)

v2.2.1

14 Jun 2019 — 04:37: 21 UTC

chore

build: Use openjdk8 in Travis builds (d8f7d41)

other

*: docs: Fix Getting Started 404 (5c9eddd)

v2.2.0

29 May 2019 — 03:27: 23 UTC

feat

Relationships: Add fetch methods to all Relationships (61a6035)

v2.1.3

14 May 2019 — 01:57: 33 UTC

tests

Relationships: Prove relationship setters use the cache (953d653)

v2.1.2

07 May 2019 — 07:07: 20 UTC

fix

VirtualInheritance: Certify virtual inheritance support (e105f18)

v2.1.1

03 May 2019 — 22:58: 37 UTC

fix

Subselect: Return the entity after executing a subselect (87e5a7a)

v2.1.0

03 May 2019 — 22:25: 30 UTC

feat

Relationships: Relationships can be set using relationship setters (e1e21a8)
Relationships: Allow saving of ids as well as entities (3f30131)
HasMany: Many entities can be saved to a hasMany relationship at once (c9f8f47)
Scopes: Register global scopes for entities (995706b)
Subselects: Add subselect helper (cf13ddd)

fix

Relationships: Make mapping foreign keys optional (708506d)

v1.3.2

30 Apr 2019 — 19:52: 39 UTC

chore

box.json: Add author (b38a7ed)

v1.3.1

30 Apr 2019 — 19:43: 23 UTC

chore

Release: v2.0.0 (425d474)

docs

README: Document that all fields need to be mapped (ecece5c)

v1.3.0

22 Aug 2018 — 19:58: 30 UTC

chore

ci: Test on adobe@2018 (d42cf61)

feat

BaseEntity: Enable per entity datasources and grammars (561f368)
KeyType: Add AssignedKey Type (897277d)

v1.2.0

19 Jul 2018 — 22:43: 54 UTC

chore

build: Fix spotty gpg key (c3c5a18)
build: Test adobe@2018 on CI (299d5b0)

feat

Scopes: Allow scopes to call other scopes (07bbde1)

v1.1.2

02 Jul 2018 — 17:22: 46 UTC

chore

build: Set location automatically on version update (183b05a)

fix

BaseEntity: Only set loaded for attributes successfully retrieved from the database (665a78a)

v1.1.1

02 Jul 2018 — 16:54: 21 UTC

fix

Relationships: correct detach function name (5dceb17)

other

*: Use logo in README (3125e6b)
*: Add quick logo (9e26b09)
*: Copied Readme from docs (#1) (137c688)

v1.1.0

06 Jun 2018 — 20:50: 16 UTC

chore

box.json: remove package scripts in favor of commandbox-semantic-release (aafe02a)

feat

attributes: better guarding against non-existent attributes (0566e35)
Columns: Allow attributes to set a sqltype (8c3db73)
Relationships: pass arguments through to relationships (5962a19)

fix

Update: don't include the key in the SET clause (846ff78)

other

*: Enable commandbox-semantic-release (e34f966)

Ortus Solutions
Published
13.0.4 is the latest of 167 release(s)
Published
Published on {{ getFullDate("2026-09-25T19:25:17Z") }}
MIT
coldbox-modules/quick

$ box install quick

How do I do this?

No collaborators yet.

quick
Created On: {{ getFullDate("2018-04-25T23:02:25Z") }}
Last Publish: {{ getFullDate("2026-09-25T19:25:17Z") }}
Views: 35,267
Installs: 254,136

Report Abuse

A CFML ORM Engine

Why?

What?

Prerequisites

Supported Databases

Example

Caching queries

Passing a Quick query to qb

Creating related entities

Optional parallel eager loading

Testing with model factories

Tests and Contributing

Prior Art, Acknowledgements, and Thanks

Community and Support

v13.0.4

25 Sep 2026 — 19:25: 07 UTC

other

v13.0.3

21 Sep 2026 — 03:32: 08 UTC

other

v13.0.2

19 Sep 2026 — 01:42: 03 UTC

other

v13.0.1

17 Sep 2026 — 17:47: 28 UTC

other

v13.0.0

15 Sep 2026 — 23:27: 45 UTC

BREAKING

v12.1.0

15 Sep 2026 — 23:18: 46 UTC

chore

feat

fix

other

v12.0.12

21 Mar 2026 — 03:09: 22 UTC

fix

v12.0.11

21 Feb 2026 — 18:16: 43 UTC

chore

fix

v12.0.10

28 Jan 2026 — 21:56: 39 UTC

fix

v12.0.9

25 Jan 2026 — 01:53: 37 UTC

fix

v12.0.8

23 Oct 2025 — 21:12: 52 UTC

other

v12.0.7

04 Sep 2025 — 16:48: 08 UTC

fix

v12.0.6

04 Sep 2025 — 07:57: 09 UTC

fix

v12.0.5

02 Sep 2025 — 19:24: 35 UTC

fix

v12.0.4

15 Jul 2025 — 18:27: 26 UTC

fix

v12.0.3

11 Jul 2025 — 23:07: 07 UTC

fix

v12.0.2

19 Jun 2025 — 19:37: 19 UTC

fix

v12.0.1

18 Jun 2025 — 19:52: 37 UTC

fix

v12.0.0

12 Jun 2025 — 22:59: 56 UTC

BREAKING

chore

fix

other

v11.3.0

29 Apr 2025 — 20:55: 57 UTC