multirow is really template::multirow or possibly template::query::multirow depending on context. the "template::" or "template::query::" may be omitted depending on what the namespace is. .tcl pages are evaluated in the template:: namespace. DEPRECATED: namespace should actually NOT be omitted

Switches:

-ulevel (optional, defaults to "1")

-local (optional, boolean)

-unclobber (optional, boolean)

Parameters:

op (required)

name (required)

See Also:

• template::multirow
• template::query::multirow

Testcases:

No testcase defined.

Generic Caching

Parameters:

command (required)

cache_key (required)

Testcases:

No testcase defined.

Looks in the appropriate cache for the named query result If a valid result is found, then sets the result in the returning stack frame.

Parameters:

name (required)

Name of cached result-set

type (required)

Type of query

Returns:

1 if result was successfully retrieved, 0 if failed

Testcases:

No testcase defined.

Create/Manipulate a multirow datasource (for use with <multiple> tags)

template::multirow create datasourcename column [column ...]

creates a multirow datasource of datasourcename

template::multirow extend datasourcename column [column ...]

extend adds a column to an existing multirow

template::multirow append datasourcename value [value ...]

appends the row to an existing multirow.

template::multirow pop datasourcename

pops a row off an existing multirow, returning a list of the rows keys gand values

template::multirow size datasourcename

returns the rowcount

template::multirow columns datasourcename

returns the columns in the datasource

template::multirow get datasourcename rownum [column]

returns the row of data (or the particular row/column if column is provided)

template::multirow set datasourcename rownum column value

set an element value

template::multirow foreach datasource code

evaluate code block for each row (like db_foreach)

template::multirow upvar datasource [new_name]

upvar the multirow, aliasing to new_name if provided

template::multirow unset datasource

unset multirow

template::multirow sort datasource -lsort-switch col1 col2

Sort the multirow by the column(s) specified. The value sorted by will be the values of the columns specified, separated by the space character. Any switches specified before the columns will be passed directly to the lsort command.

template::multirow exists datasource

Return 1 if the multirow datasource exists, 0 if it doesn't.

Switches:

-ulevel (optional, defaults to "1")

Used in conjunction with the "local" parameter to specify how many levels up the multirow variable resides.

-local (optional, boolean)

If set, the multirow will be looked for in the scope the number of levels up given by ulevel (normally the caller's scope), instead of the [template::adp_level] scope, which is the default.

-unclobber (optional, boolean)

This only applies to the 'foreach' command. If set, will cause the proc to not overwrite local variables. Actually, what happens is that the local variables will be overwritten, so you can access them within the code block. However, if you specify -unclobber, we will revert them to their original state after execution of this proc.

Parameters:

command (required)

Multirow datasource operation: create, extend, append, pop, size, get, set, foreach, upvar

name (required)

Name of the multirow datasource

See Also:

• db_multirow
• template::query::multirow

Testcases:

db__transaction_bug_3440, util_user_messages, templates_and_scripts, lists_and_multirows

Public interface to template query api. This routine parses the arguments and dispatches to the query command specified by the type argument.

Parameters:

statement_name (required)

Standard db_api query name

result_name (required)

Tcl variable name when doing an uplevel to set the returned result

type (required)

The query type

sql (required)

The sql to be used for the query

Options:

-maxrows

Limits the query results of a multirow query to a fixed number of rows.

-cache

Cache the query results keyed on an identifier that is unique for both the query and the bind variables used in the query. The cached result reflects any initial specification of maxrows and startrows.

-refresh

Force a query to be performed even if it is cached, and refresh the cache.

Only applicable if the cache option is specified as well. Does not affect a previously specified timeout period.

-timeout

The maximum period of time for which the cached results are valid in seconds. Only applicable for persistently cached results.

-persistent

Cache the query results persistently, so that all subsequent requests use the results.

Returns:

1 if query was a success, 0 if it failed

Testcases:

No testcase defined.

Process an SQL statement that is not a query; perhaps update or insert

Parameters:

statement_name (required)

Standard db_api statement name used to hook into query dispatcher

db (required)

Database handle

name (required)

Tcl variable name to use when setting the result

sql (required)

Query to use when processing this command

Testcases:

No testcase defined.

Flush the cached queries where the query name matches the specified string match

Parameters:

cache_match (required)

Name of query to match for cache flushing

Testcases:

No testcase defined.

Process a multilist query.

Parameters:

statement_name (required)

Standard db_api statement name used to hook into query dispatcher

db (required)

Database handle

result_name (required)

Tcl variable name to use when setting the result

sql (required)

Query to use when processing this command

Testcases:

No testcase defined.

Process a multirow query. Use an array for each row in the result. Arrays are named name0, name1, name2 etc. The variable name.rowcount is also defined for checking and iteration.

Parameters:

statement_name (required)

Standard db_api statement name used to hook into query dispatcher

db (required)

Database handle

result_name (required)

Tcl variable name to use when setting the result

sql (required)

Query to use when processing this command

See Also:

• db_multirow
• template::multirow

Testcases:

No testcase defined.

Creates a data source where the values for each row are returned as a list. Rows are grouped according to the column values specified in the -groupby option See template::util::lnest for more details.

Parameters:

statement_name (required)

Standard db_api statement name used to hook into query dispatcher

db (required)

Database handle

result_name (required)

Tcl variable name to use when setting the result

sql (required)

Query to use when processing this command

Testcases:

No testcase defined.

Process a onelist query.

Parameters:

statement_name (required)

Standard db_api statement name used to hook into query dispatcher

db (required)

Database handle

result_name (required)

Tcl variable name to use when setting the result

sql (required)

Query to use when processing this command

Testcases:

No testcase defined.

Process a onerow query. Use a single array to store the results.

Parameters:

statement_name (required)

Standard db_api statement name used to hook into query dispatcher

db (required)

Database handle

result_name (required)

Tcl variable name to use when setting the result

sql (required)

Query to use when processing this command

Testcases:

No testcase defined.

Process a onevalue query. Use a single array to store the results.

Parameters:

statement_name (required)

Standard db_api statement name used to hook into query dispatcher

db (required)

Database handle

result_name (required)

Tcl variable name to use when setting the result

sql (required)

Query to use when processing this command

Testcases:

No testcase defined.

Places a query result in the appropriate cache.

Testcases:

No testcase defined.

Maintains an ns_set of parameters that can be bulk converted to URL parameters. It is not clear if this API makes a lot of sense, many alternatives exist to export parameters in various forms...

Parameters:

command (required)

one of 'set_param *name* *value*' (set a parameter), 'get_param *name* *default*' (get a parameter value), or 'get_query' (export all parameters as URL query).

See Also:

• export_vars

Testcases:

No testcase defined.