QueryHandle

Functions and more information for QueryHandle

execute ( options: Object ) →{ Promise }

Executes the query.

Parameters
Name Type Description
options Object

options Options object.

Properties
Name Type Description
options Object options.options Holds query specific configurations.
options Boolean options.options.nested If true, the query will include related objects in its result set.
options Number options.options.count Number of objects to return in the result.

getResult ( ) →{ Object }

Returns the result of the query.

Returns

The query's result set.

refresh ( force: Boolean )

Refrehes the query.

Parameters
Name Type Description
force Boolean

Force the query to execute

removeParameter ( param: String , noupdate: Boolean )

Clears the value of specified parameter.

Parameters
Name Type Description
param String

The name of the parameter to clear.
noupdate Boolean

If true, the query will not automatically update after the parameter has been removed.

setParameter ( param: String , value: Object , noupdate: Boolean )

Sets a query parameter to the specified value.

Parameters
Name Type Description
param String

The name of the parameter.
value Object

The desired value.
noupdate Boolean

If true, the query will not automatically update after the value has been set.

setParameters ( params: Object , noupdate: Boolean )

Sets a collection of parameters to their specified values.

Parameters
Name Type Description
params Object

value pairs.
noupdate Boolean

If true, the query will not automatically update after the value has been set.

setQueryParameters ( qps: Object )

Sets query parameter values according to the specified map.

Parameters
Name Type Description
qps Object

Map of query parameter name and value pairs.

setRelations ( relations: String , noupdate: Boolean )

Sets the related records to also load

Parameters
Name Type Description
relations String

separated list of relations
noupdate Boolean

result

Objects