QuerySelect Property

Selects only the specified properties to be returned in an entry when querying a service.

Syntax

 odata.getQuerySelect([callback])
 odata.setQuerySelect( querySelect, [callback])

Default Value

""

Callback

The 'callback' parameter specifies a function which will be called when the operation completes (or an error is encountered). If the 'callback' parameter is not specified, then the method will block and will not return until the operation completes (or an error is encountered).

The callback for the getQuerySelect([callback]) method is defined as:

function(err, data){ }

'err' is the error that occurred. If there was no error, then 'err' is 'null'.

'data' is the value returned by the method.

The callback for the setQuerySelect([callback]) method is defined as:

function(err){ }

'err' is the error that occurred. If there was no error, then 'err' is 'null'.

'err' has 2 properties which hold detailed information:

err.code
err.message

Remarks

This property allows you to specify the specific properties you want returned within an entry when calling QueryService. The specified value should be a comma-separated list of properties (provided you wish to have more than one property returned). For example, if you wish to only have the 'Name' and 'Price' of each item returned you can set QuerySelect to "Name,Price".

Note the specified values can be a property name, navigation property name (EntryLinksTitle) or the "*" character (which returns all the properties for each entry).

This property is not available at design time.

Data Type

String