ColdFusion 9.0 Resources

CF.query

Description

Performs queries against ColdFusion data sources.

Return value

Returns a RecordSet object.

Syntax

CF.query 
        ({ 
            datasource:"data source name",  
            sql:"SQL stmts",  
            username:"username",  
            password:"password", 
            maxrows:number,  
            timeout:milliseconds 
        })

Arguments

Arguments	Req/Opt	Description
datasource	Required	Name of the data source from which the query retrieves data.
sql	Required	SQL statement.
username	Optional	Username. Overrides the username specified in the data source setup.
password	Optional	Password. Overrides the password specified in the data source setup.
maxrows	Optional	Maximum number of rows to return in the record set.
timeout	Optional	Maximum number of seconds for the query to execute before returning an error indicating that the query has timed out. Can only be used in named arguments.

Usage

You can code the CF.query function using named or positional arguments. You can invoke all supported arguments using the named argument style, as follows:

CF.query({datasource:"datasource", sql:"sql stmt", 
    username:"username", password:"password", maxrows:"maxrows", 
    timeout:"timeout"});

Note: The named argument style uses curly braces {} to surround the function arguments.

Positional argument style, which is a shorthand coding style, does not support all arguments. Use the following syntax to code the CF.query function using positional arguments:

CF.query(datasource, sql); 
CF.query(datasource, sql, maxrows); 
CF.query(datasource, sql, username, password); 
CF.query(datasource, sql, username, password, maxrows);

Note: Do not use curly braces {} with positional arguments.

You can manipulate the record set returned by the CF.query function using methods in the RecordSet ActionScript class. The following are some of the methods available in the RecordSet class:

RecordSet.getColumnnames
RecordSet.getLength
RecordSet.getItemAt
RecordSet.getItemID
RecordSet.sortItemsBy
RecordSet.getNumberAvailable
RecordSet.filter
RecordSet.sort

For more information on using server-side ActionScript, see Using Server-Side ActionScript in the Developing ColdFusion Applications. For more detailed information about the RecordSet ActionScript class, see Using Flash Remoting.

Example

// Define a function to do a basic query 
// Note use of positional arguments 
function basicQuery() 
{ 
    result = CF.query("myquery", "cust_data", "SELECT * from tblParks"); 
    return result; 
} 
 
// Example function declaration using named arguments 
function basicQuery() 
{ 
    result = CF.query({datasource:"cust_data", sql:"SELECT * from tblParks"}); 
    return result; 
} 
 
// Example of the CF.query function using maxrows argument 
function basicQueryWithMaxRows() 
{ 
    result = CF.query("cust_data", "SELECT * from tblParks", 25); 
    return result; 
} 
 
// Example of the CF.query function with username and password 
function basicQueryWithUser() 
{ 
    result = CF.query("cust_data", "SELECT * from tblParks",  
        "wsburroughs", "migraine1"); 
    return result; 
}