LiveQuery Class

Changes the behavior of a query created by -queryAllDocuments.

Gets the Database that owns the Query's View.

Gets or sets whether the rows be returned in descending key order. Default value is false.

Gets or sets the key of the last value to return. A null value has no effect.

Gets or sets the Document id of the last value to return. A null value has no effect. This is useful if the view contains multiple identical keys, making endKey ambiguous.

Gets or sets whether results will be grouped in Views that have reduce functions.

Gets or sets whether Queries created via the Database createAllDocumentsQuery method will include deleted Documents. This property has no effect in other types of Queries.

If true the EndKey (or EndKeyDocID) comparison uses "<=". Else it uses "<". Default value is true.

If true the StartKey (or StartKeyDocID) comparison uses ">=". Else it uses ">"

Gets or sets when a View index is updated when running a Query.

Gets or sets the keys of the values to return. A null value has no effect.

Returns the last error, if any, that occured while executing the Query, otherwise null.

Gets or sets the maximum number of rows to return. The default value is int.MaxValue, meaning 'unlimited'.

Gets or sets whether to only use the map function without using the reduce function.

Gets or sets an optional predicate that filters the resulting query rows. If present, it's called on every row returned from the query, and if it returnsfalseNO the row is skipped.

Gets or sets whether to include the entire Document content with the results. The Documents can be accessed via the QueryRow's documentProperties property.

If nonzero, enables prefix matching of string or array keys. * A value of 1 treats the endKey itself as a prefix: if it's a string, keys in the index that come after the endKey, but begin with the same prefix, will be matched. (For example, if the endKey is "foo" then the key "foolish" in the index will be matched, but not "fong".) Or if the endKey is an array, any array beginning with those elements will be matched. (For example, if the endKey is [1], then [1, "x"] will match, but not [2].) If the key is any other type, there is no effect. * A value of 2 assumes the endKey is an array and treats its final item as a prefix, using the rules above. (For example, an endKey of [1, "x"] will match [1, "xtc"] but not [1, "y"].) * A value of 3 assumes the key is an array of arrays, etc. Note that if the .descending property is also set, the search order is reversed and the above discussion applies to the startKey, _not_ the endKey.

Gets the results of the Query. The value will be null until the initial Query completes.

Gets or sets the number of initial rows to skip. Default value is 0.

Gets or sets the key of the first value to return. A null value has no effect.

Gets or sets the Document id of the first value to return. A null value has no effect. This is useful if the view contains multiple identical keys, making startKey ambiguous.

The shortest interval at which the query will update, regardless of how often the database changes. Defaults to 200ms. Increase this if the query is expensive and the database updates frequently, to limit CPU consumption.

Releases all resource used by the Query object.

Used to indicate that the options of the live query have changed since its first run.

Sends the query to the server and returns an enumerator over the result rows (Synchronous).

Runs the Query asynchronously and will notified Completed event handlers on completion.

Runs Query function asynchronously and will notified Completed event handlers on completion.

Starts observing database changes.

Stops the LiveQuery and stops observing Database changes.

Returns a new LiveQuery with identical properties to the the Query.

Blocks until the intial Query completes.

Adds or removed a LiveQuery change delegate that will be called whenever the Database changes in a way that would affect the results of the Query.

Event raised when a query has finished running.