Using Server-Side ActionScript in ColdFusion MX
ColdFusion ActionScript Functions

CF.query

Description

Performs queries against ColdFusion data sources.

Return value

Returns a RecordSet object. For information about methods that you can use to manipulate the record set returned by the CF.query function, see "Methods available in the RecordSet ActionScript class".

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 query retrieves data.
sql	Required	SQL statement.
username	Optional	Overrides the username specified in the data source setup.
password	Optional	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 query has timed out. Can only be used in named arguments.

Usage

You can code the CF.query function using named arguments or using 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 arguments let you use a shorthand coding style. However, not all arguments are supported for the positional argument style. Use the following schemas 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:   When using positional arguments, do not use curly braces {}.

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 query function using maxrows argument
function basicQueryWithMaxRows()
{
  result = CF.query("cust_data", "SELECT * from tblParks", 25);
  return result;
}

// Example of CF.query with username and password
function basicQueryWithUser()
{
  result = CF.query("cust_data", "SELECT * from tblParks", 
    "wsburroughs", "migraine1");
  return result;
}

Methods available in the RecordSet ActionScript class

The record set returned by the CF.query function can be manipulated 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 detailed information about the RecordSet ActionScript class, see Using Flash Remoting.

ColdFusion 9 | ColdFusion 8 | ColdFusion MX 7 | ColdFusion MX 6.1 | ColdFusion MX | Forums | Developer Center | Bug Reporting

Version 6

Comments are no longer accepted for ColdFusion MX. ColdFusion 8 is the current version.