<cfquery>

Passes SQL statements to a data source.

Not limited to queries.

This tag may have a body.

This tag is also supported within <cfscript>

<cfquery name=string columnKey=string result=string dataSource=any dbType=string dbServer=string dbName=string tags=any connectString=string username=string password=string maxRows=number blockFactor=number timeout=any cachedAfter=datetime cachedWithin=object provider=string providerDSN=string debug=boolean cacheName=string psq=boolean unique=boolean ormOptions=struct indexName=string returnType=string timezone=timezone lazy=boolean params=object sql=string listener=any async=boolean cacheId=string ><!--- body --->[</cfquery>]
Attribute Description
name
string, optional

The name query. Must begin with a letter and may consist of letters, numbers, and the underscore character, spaces are not allowed. The query name is used later in the page to reference the query's record set.

Alias: variable
columnKey
string, optional

Specifies the column to use as primary key when returnType is set to struct.

Alias: columnname, column, keycolumn
result
string, optional

Specifies a name for the structure in which cfquery returns the result variables.

  • SQL: The SQL statement that was executed. (string)
  • Cached: If the query was cached. (boolean)
  • SqlParameters: An ordered Array of cfqueryparam values. (array)
  • RecordCount: Total number of records in the query. (numeric)
  • ColumnList: Column list, comma separated. (string)
  • ExecutionTime: Execution time for the SQL request. (numeric)
dataSource
any, optional

The name of the data source from which this query should retrieve data.
dbType
string, optional

The following values are supported

  • query: for doing a query on an existing query object (QoQ / Query of Queries)
  • hql: for doing a query on orm
tags
any, optional

tags stored with the cache.

Alias: tag
username
string, optional

If specified, username overrides the username value specified in the data source setup.
password
string, optional

If specified, password overrides the password value specified in the data source setup.
maxRows
number, optional

Specifies the maximum number of rows to return in the record set.
blockFactor
number, optional

Specifies the maximum number of rows to fetch at a time from the server. The range is 1, default to 100. This parameter applies to ORACLE native database drivers and to ODBC drivers. Certain ODBC drivers may dynamically reduce the block factor at runtime.
timeout
any, optional

The maximum number of seconds for the query to execute before returning an error indicating that the query has timed-out. This attribute is not supported by most ODBC drivers. timeout is supported by the SQL Server 6.x or above driver. The minimum and maximum allowable values vary, depending on the driver.
cachedAfter
datetime, optional

This is the age of which the query data can be
cachedWithin
object, optional

Supported values are:

  • String "request": If original query was created within the current request, cached query data is used.
  • a timespan (created with function CreateTimeSpan()): If original query date falls within the time span, cached query data is used.

To use cached data, the current query must use the same SQL statement, params, data source, query name, user name, and password.
debug
boolean, optional

Used for debugging queries. Specifying this attribute causes the SQL statement submitted to the data source and the number of records returned from the query to be returned.
psq
boolean, optional

preserve single quote or not
unique
boolean, optional

Specifies if the object parameter is unique, used only for dbtype=orm or hql
ormOptions
struct, optional

Object parameter for the entity.
indexName
string, optional

Name of the column to index, see QueryRowByIndex(), QueryGetCellByIndex() and QueryRowDataByIndex()
returnType
string, optional

One of the following values:

  • query: default for all dbtype expect "hql", returns a query object
  • array_of_entity: works only with dbtype "hql" and is also the default value for dbtype "hql"
  • array: converts the query object into an array of structs
  • struct: returns either a struct of structs where the key is specified by the keyColumn attribute and each value is a struct with a query record, or a single record if keyColumn is not set, where each key is a column name and each value has its corresponding value
timezone
timezone, optional

the timezone used to convert a date object to a timestamp (string), this value is needed when your database runs in another timezone and you are not using cfqueryparam to insert dates.
params
object, optional

Alternative to using nested cfqueryparam tags. Supports two parameter styles:

  • Positional parameters (Array): Use question marks (?) as placeholders in SQL.

SQL example:

    "SELECT * FROM users WHERE status = ? AND id > ? LIMIT ?"
    Params: [
    { type: "string", value: "active" },
    { type: "integer", value: 42 },
    { type: "integer", value: 100 }
    ]
  • Named parameters (Struct): Use colon-prefixed names as placeholders in SQL.

SQL example:

    "SELECT * FROM users WHERE status = :status AND id > :id LIMIT :limit"
    Params: {
    "status": { type: "string", value: "active" },
    "id": { type: "integer", value: 42 },
    "limit": { type: "integer", value: 100 }
    }
  • List parameters (for IN clauses): Set list=true to expand arrays into comma-separated values.

SQL example:

    "SELECT * FROM users WHERE status IN (?)"
    Params: [
    { type: "string", value: ["active", "pending"], list: true }
    ]

(The same can be done with named parameters)
sql
string, optional

the SQL query to execute.
listener
any, optional

Listener for the query.

The listener can have 3 (optional) functions, before, after and error that get triggered before and after executing the query and in case of an exception.

The functions get all data about the query.

This attributes overwrites any query listener defined in the application.cfc/cfapplication.

All the functions can also modify all data, by returning a struct containing the keys to overwrite following the same structure as the input coming in the argument scope.

The listener can be a component looking like this:

component {
    function before( cachedAfter, cachedWithin, columnName, datasource, dbType, debug,
        maxRows, name, ormOptions, username, password, result,
        returnType, timeout, timezone, unique, sql, args, params, caller){}
    function after( result, meta, cachedAfter, cachedWithin, columnName, datasource,
        dbType, debug, maxRows, name, ormOptions, username, password, result,
        returnType, timeout, timezone, unique, sql, args, params, caller){}
    function error(exception, lastExecution, nextExecution, created, id, type, detail,
        tries, remainingTries, closed, caller, advanced, passed, exception){}
}

or a struct looking like this:

component {
    before:function(...){},
    after:function(...){},
    error:function(...){}}

async
boolean, optional

If set to true, the query is executed asynchronously by the Lucee Task manager,

If set to false (default) the query is executed in the same thread that executes the request.

Unimplemented Attribute(s)

Attribute Description
dbServer
string, optional

This attribute has been deprecated and is non-functional.

* deprecated *
dbName
string, optional

This attribute has been deprecated and is non-functional.

* deprecated *
connectString
string, optional

This attribute has been deprecated and is non-functional.

* deprecated *
provider
string, optional

This attribute has been deprecated and is non-functional.

* deprecated *
providerDSN
string, optional

This attribute has been deprecated and is non-functional.

* deprecated *
cacheName
string, optional

This attribute has been deprecated and is non-functional.

* deprecated *
lazy
boolean, optional

If "lazy" is set to true (default "false") Lucee does not initially load all the data from the datasource.

When "true" the data is only loaded when requested, this means the data is dependent on the datasource connection. If the datasource connection has been lost for some reason and the data has not yet been requested, Lucee throws an error if you try to access the data.

The "lazy" attribute only works if the following attributes are not used: cachewithin, cacheafter and result.

* deprecated *
cacheId
string, optional

Attribute not supported

* unimplemented *

Examples

Tags

<cfset qry= queryNew("name,age,whatever", "varchar,date,int", [
[ "Susi", CreateDate( 1970, 1, 1 ), 5 ],
[ "Urs" , CreateDate( 1995, 1, 1 ), 7 ],
[ "Fred", CreateDate( 1960, 1, 1 ), 9 ],
[ "Jim" , CreateDate( 1988, 1, 1 ), 11 ]
])>
<!-- bad example, not using a bound parameter, unsafe when using input from users -->
<cfquery name="q" dbtype="query">
	select * from qry where name = 'jim'
</cfquery>
<cfdump var="#q#" />

<!-- using a bound parameter with cfqueryparam -->
<cfquery name="q" dbtype="query">
	select * from qry where name = <cfqueryparam value='jim'>
</cfquery>
<cfdump var="#q#" />

<!-- using an array of simple params -->
<cfscript>
    p = [ 'jim' ];
</cfscript>
<cfquery name="q" dbtype="query" params=#p#>
	select * from qry where name = ?
</cfquery>
<cfdump var="#q#" />

<!-- using an array of struct params -->
<cfscript>
    p = [ { value='jim', sqltype='varchar' } ];
</cfscript>
<cfquery name="q" dbtype="query" params=#p#>
	select * from qry where name = ?
</cfquery>
<cfdump var="#q#" />

<!-- using an array of named struct params -->
<cfscript>
    p = [id= { value='jim', sqltype='varchar' } ];
</cfscript>
<cfquery name="q" dbtype="query" params=#p#>
	select * from qry where name = :id
</cfquery>
<cfdump var="#q#" />

Script

  qry= queryNew("name,age,whatever", "varchar,date,int", [
    [ "Susi", CreateDate( 1970, 1, 1 ), 5 ],
    [ "Urs" , CreateDate( 1995, 1, 1 ), 7 ],
    [ "Fred", CreateDate( 1960, 1, 1 ), 9 ],
    [ "Jim" , CreateDate( 1988, 1, 1 ), 11 ]
    ])

	query name="q" dbtype="query" {
	echo("select * from qry where name = 'jim'");
	}
	writedump(q);

	query name="q" dbtype="query" {
	echo("select * from qry where name = ")
	queryParam cfsqltype="cf_sql_varchar" value="jim";
	}
	writedump(q);

	p = [ 'jim' ];
	query name="q" dbtype="query" params=#p#{
	echo("select * from qry where name = ?");
	}
	writedump(q);

 	p = [id= { value='jim', sqltype='varchar' } ];
	query name="q" dbtype="query" params=#p#{
	echo("select * from qry where name = :id");
	}
	writedump(q);

See also