Optional
containerOne of the values of ContainerFilter that sets the scope of this query. Defaults to ContainerFilter.current, and is interpreted relative to config.containerPath.
Optional
containerThe container path in which the changes are to be performed. If not supplied, the current container path will be used.
Optional
dataPrefix for query parameters (e.g. filters, sorts, etc) in this request. Defaults to "query".
Optional
failureThis will be called upon failure to complete a request.
Optional
filterArray of objects created by Filter.create.
Optional
ignoreIf true, the command will ignore any filter that may be part of the chosen view.
Optional
maxThe maximum number of rows to return from the server (defaults to 100000). If you want to return all possible rows, set this config property to -1.
Optional
methodSpecify the HTTP method to use when making the request. Defaults to GET.
Optional
parametersMap of name (string)/value pairs for the values of parameters if the SQL
references underlying queries that are parameterized. For example, the following passes
two parameters to the query: {'Gender': 'M', 'CD4': '400'}
. The parameters are written to the
request URL as follows: query.param.Gender=M&query.param.CD4=400.
For details on parameterized SQL queries,
see Parameterized SQL Queries.
Name of a query table associated with the chosen schema. See also: How To Find schemaName, queryName & viewName.
Name of a schema defined within the target container. See also: How To Find schemaName, queryName & viewName.
Optional
scopeA scoping object for the success and failure callback functions (default to this).
Optional
sortString description of the sort. It includes the column names listed in the URL of a sorted data region (with an optional minus prefix to indicate descending order). In the case of a multi-column sort, up to three column names can be included, separated by commas.
Optional
successThis will be called upon successfully completing a request.
Optional
viewName of a view to use. This is potentially important if this view contains filters on the data.
A single column for which the distinct results will be requested. This column must exist within the specified query.