Introduction

Search…
Introduction
Master Branch Build Status
Development Branch Build Status
Introduction
qb is a fluent query builder for CFML. It is heavily inspired by Eloquent from Laravel.
Using qb, you can:
Quickly scaffold simple queries
Make complex, out-of-order queries possible
Abstract away differences between database engines
Requirements
Adobe ColdFusion 2016+
Lucee 5+
qb supports four major database grammars:
MySQL (MySQLGrammar)
Oracle (OracleGrammar)
Postgres (PostgresGrammar)
Microsoft SQL Server (SqlServerGrammar)
Discussion & Help
The Box modules discussion group and community can be found here:
​https://community.ortussolutions.com/c/box-modules/qb/27​
Installation
Installation is easy through CommandBox and ForgeBox. Simply type box install qb to get started.
Code Samples
Compare these two examples:
1
// Plain old CFML
2
q = queryExecute("SELECT * FROM users");
3
​
4
// qb
5
query = wirebox.getInstance('[email protected]');
6
q = query.from('users').get();
Copied!
The differences become even more stark when we introduce more complexity:
1
// Plain old CFML
2
q = queryExecute(
3
    "SELECT * FROM posts WHERE published_at IS NOT NULL AND author_id IN ?",
4
    [ { value = '5,10,27', cfsqltype = 'CF_SQL_NUMERIC', list = true } ]
5
);
6
​
7
// qb
8
query = wirebox.getInstance('[email protected]');
9
q = query.from('posts')
10
         .whereNotNull('published_at')
11
         .whereIn('author_id', [5, 10, 27])
12
         .get();
Copied!
With qb you can easily handle setting order by statements before the columns you want or join statements after a where clause:
1
query = wirebox.getInstance('[email protected]');
2
q = query.from('posts')
3
         .orderBy('published_at')
4
         .select('post_id', 'author_id', 'title', 'body')
5
         .whereLike('author', 'Ja%')
6
         .join('authors', 'authors.id', '=', 'posts.author_id')
7
         .get();
8
​
9
// Becomes
10
​
11
q = queryExecute(
12
    "SELECT post_id, author_id, title, body FROM posts INNER JOIN authors ON authors.id = posts.author_id WHERE author LIKE ? ORDER BY published_at",
13
    [ { value = 'Ja%', cfsqltype = 'CF_SQL_VARCHAR', list = false, null = false } ]
14
);
Copied!
qb enables you to explore new ways of organizing your code by letting you pass around a query builder object that will compile down to the right SQL without you having to keep track of the order, whitespace, or other SQL gotchas!
Here's a gist with an example of the powerful models you can create with this! https://gist.github.com/elpete/80d641b98025f16059f6476561d88202​
Usage
To start a new query, instantiate a new Builder: wirebox.getInstance('[email protected]').
By default, qb uses a generic Grammar. You can specify your specific grammar in ColdBox by setting the defaultGrammar in your moduleSettings.
1
moduleSettings = {
2
    qb = {
3
        defaultGrammar = "[email protected]"
4
    }
5
};
Copied!
If you are not using WireBox, just make sure to wire up the Builder object with the correct grammar:
1
var grammar = new qb.models.Query.Grammars.MySQLGrammar();
2
var builder = new qb.models.Query.Builder( grammar );
Copied!
What's New?
Last modified 11mo ago
Copy link
Edit on GitHub
Contents