arrow-left

All pages
gitbookPowered by GitBook
1 of 1

Loading...

Introduction

Quick logo

hashtag
A CFML ORM Engine

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

We can do better.

hashtag
What?

Quick is an ORM (Object Relational Mapper) written in CFML for CFML. It provides an 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.

hashtag
Prerequisites

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

See for more details.

hashtag
Supported Databases

Quick supports all databases supported by .

hashtag
Example

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

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

Now that you've seen an example, with Quick!

hashtag
Prior Art, Acknowledgements, and Thanks

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

Quick is inspired heavily by . 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.

hashtag
Discussion & Help

The Box products community for further discussion and help can be found here:

  • 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.)

  • Configure your BaseGrammar in config/ColdBox.cfc

    ActiveRecordarrow-up-right
    Getting Startedarrow-up-right
    qbarrow-up-right
    migrations filearrow-up-right
    dig in to what you can doarrow-up-right
    qbarrow-up-right
    Eloquent in Laravelarrow-up-right
    https://community.ortussolutions.com/c/communities/quick-orm/23arrow-up-right
    // 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
        // all fields in a table are mapped by default
        // both of these points 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>