Build Status



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.


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.


You need the following configured before using Quick:

  • Configure a default datasource in your CFML engine
  • ColdBox 4.3+
  • 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.


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 -->
    <h1>Hi, #prc.user.getUsername()#!</h1>

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

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


22 Aug 2018 — 19:58: 30 UTC



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


19 Jul 2018 — 22:43: 54 UTC



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


02 Jul 2018 — 17:22: 46 UTC


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


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


02 Jul 2018 — 16:54: 21 UTC


  • Relationships: correct detach function name (5dceb17)



06 Jun 2018 — 20:50: 16 UTC


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


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


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


  • *: Enable commandbox-semantic-release (e34f966)

Here are all the versions for this package. Please note that you can leverage CommandBox package versioning to install any package you like. Please refer to our managing package version guide for more information.

Version Created Last Update Published By Stable Download
2.0.0-beta.9 Jan 03 2019 08:44 AM Jan 03 2019 08:44 AM Ortus Solutions (ortus)
2.0.0-beta.8 Jan 02 2019 10:03 AM Jan 02 2019 10:03 AM Ortus Solutions (ortus)
2.0.0-beta.7 Dec 29 2018 04:23 PM Dec 29 2018 04:23 PM Ortus Solutions (ortus)
2.0.0-beta.6 Dec 28 2018 12:23 AM Dec 28 2018 12:23 AM Ortus Solutions (ortus)
2.0.0-beta.5 Dec 14 2018 08:51 AM Dec 14 2018 08:51 AM Ortus Solutions (ortus)
2.0.0-beta.4 Dec 12 2018 10:18 PM Dec 12 2018 10:18 PM Ortus Solutions (ortus)
2.0.0-beta.3 Nov 30 2018 08:36 AM Nov 30 2018 08:36 AM Ortus Solutions (ortus)
2.0.0-beta.2 Nov 27 2018 11:27 PM Nov 27 2018 11:27 PM Ortus Solutions (ortus)
2.0.0-beta.1 Sep 17 2018 09:11 PM Sep 17 2018 09:11 PM Ortus Solutions (ortus)
1.3.0 Aug 22 2018 02:58 PM Aug 22 2018 02:58 PM Ortus Solutions (ortus)
1.2.0 Jul 19 2018 05:43 PM Jul 19 2018 05:43 PM Ortus Solutions (ortus)
1.1.2 Jul 02 2018 12:22 PM Jul 02 2018 12:22 PM Ortus Solutions (ortus)
1.1.1 Jul 02 2018 11:54 AM Jul 02 2018 11:54 AM Ortus Solutions (ortus)
1.1.0 Jun 06 2018 03:50 PM Jun 06 2018 03:50 PM Ortus Solutions (ortus)
1.0.0 Apr 25 2018 11:02 PM Apr 25 2018 11:02 PM Ortus Solutions (ortus)


No collaborators yet.
  • Apr 25 2018 11:02 PM
  • Jan 03 2019 08:44 AM
  • 548
  • 0
  • 616