Return Format

returnFormat refers to the transformation your executed query makes (if any) before being returned to you. You can choose one of three return formats:

  • "array"

  • "query"

  • A custom function

By default, qb returns an array of structs as the result of your query. This is the same as specifying array as your returnFormat:

config/ColdBox.cfc
moduleSettings = {
"qb": {
"returnFormat": "array"
}
};

You can get the original query object that CFML generates by setting the returnFormat to query:

config/ColdBox.cfc
moduleSettings = {
"qb": {
"returnFormat": "query"
}
};

If you want complete control over your return result, you can provide a function as a returnFormat. The results of the function will be returned as the results of the builder.

config/ColdBox.cfc
moduleSettings = {
"qb": {
"returnFormat": function( q ) {
return application.wirebox.getInstance(
"name" = "Collection",
"initArguments" = { "collection": q }
);
}
}
};