Introduction
Quick logo
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 errorbecause they are provided directly by the Java classes.
- Complex CFML Hibernate ORM applications can consume significant memory andprocessing resources, making them cost-prohibitive and inefficient when usedin microservices architecture.
- Hibernate ORM is tied to the engine releases. This means that updates comeinfrequently and may be costly for non-OSS engine users.
- Hibernate ORM is built in Java. This limits contributions from CFMLdevelopers who don't know Java or don't feel comfortable contributing to aJava project.
- Hibernate ORM doesn't take advantage of a lot of dynamic- andmeta-programming available in CFML. (Tools like CBORM have helped to bridgethis 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
quickin yourApplication.cfc - Configure your
BaseGrammarinconfig/ColdBox.cfc
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
// 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>
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.
The Box products community for further discussion and help can be found here: https://community.ortussolutions.com/c/communities/quick-orm/23
Last modified 2mo ago