Home >	Contents >	Index >

Expanded TOC   |    Accordion TOC   |    Annotated TOC   |    Index

ICS.CallSQL

Executes a SQL statement stored in the SystemSQL table.

Syntax

public IList 
CallSQL(String qryname,
        String listname,
        int limit,
        boolean bCache,
        StringBuffer errstr)

Parameters

qryname

Specify the value of the qryname column that uniquely identifies the row whose SQL statement should be executed.

listname

The name of the list to be created as a result of the query. The resultset will be accessible from XML using this name. If you set listname to null, CallSQL will generate a unique name for the list.

limit

Maximum number of rows returned; setting limit to -1 means no limit.

bCache

true to cache the results; false otherwise. Setting bCache to false can hurt performance. Regardless of the value of bCache, the existing cache will be used in the return value. bCache only prevents new resultsets from being cached.

errstr

For return values; may contain error information.

Description

The CallSQL method executes a SQL statement stored in the SystemSQL table.

The deftable column of the SystemSQL table holds a list of the tables in which the resultsets will be cached. The tables specified in deftable must all exist. If you specify multiple tables in the deftable column, the first table listed is the "primary" table, meaning that the resultset will be cached based on that table's caching rules (maximum cache size, timeout, and so on).

Returns

IList object containing the results. An empty result set returns an IList with no data.

Errno

If IList is null, an errno will be set. Use GetErrno to find the error.

Example

The following example executes a SQL statement stored in the SystemSQL table. Before running this code, you would have to place a SQL statement named Query1 in the SystemSQL table:

StringBuffer errStr = new StringBuffer();
ics.ClearErrno()
IList results = ics.CallSQL("Query1", null, -1, 
                             true, errStr); 
int errNum = ics.GetErrno();

See Also

literal , SelectTo , SQL , SQLExp

 

		Home >	Contents >	Index >
	FatWire JAVA Reference Copyright 2005 by FatWire Software All rights reserved.