QueryOptions Class

Creates a new QueryOptions object.

Creates a new QueryOptions object with a N1QL query statement.

Creates a new QueryOptions object with an existing QueryPlan(QueryPlan).

Gets the context identifier for the N1QL query request/response. Useful for debugging.

Gets a value indicating whether this query statement is to executed in an ad-hoc manner.

Returns true if the request is a prepared statement

Custom ITypeSerializer to use when deserializing query results.

If set to false, the client will try to perform optimizations transparently based on the server capabilities, like preparing the statement and then executing a query plan instead of the raw query.

Set the CancellationToken(CancellationToken) which will cancel the query if it is incomplete.

Client Context ID. If no client context ID is provided on this option, a UUID is generated and sent automatically so by default it is always possible to identify a query when debugging.

Provides a means of ensuring "read your own writes" or RYOW consistency on the current query.

Creates a new QueryOptions object.

Creates a new QueryOptions object with the specified statement.

Creates a query using the given plan as an optimization for the originalStatement.

Gets a IDictionaryTKey, TValue of the name/value pairs to be POSTed to the service.

Gets the JSON representation of this query for execution in a POST.

Specifies the maximum parallelism for the query. A zero or negative value means the number of logical cpus will be used as the parallelism for the query. There is also a server wide max_parallelism parameter which defaults to 1. If a request includes max_parallelism, it will be capped by the server max_parallelism. If a request does not include max_parallelism, the server wide max_parallelism will be used.

Specifies that metrics should be returned with query results.

Adds a collection of named parameters to the parameters to the statement or prepared statement.

Adds a positional parameter to the parameters to the statement or prepared statement.

Adds a list of positional parameters to the statement or prepared statement.

Adds a named parameter to the parameters to the statement or prepared statement.

Sets the number of items execution operators can batch for fetch from the KV.

Sets maximum number of items each execution operator can buffer between various operators.

Sets a N1QL statement to be executed in an optimized way using the given queryPlan.

Set the QueryProfile information to be returned along with the query results.

Adds a raw query parameter and value to the query. NOTE: This is uncommitted and may change in the future.

If a GET request, this will always be true otherwise false.

Sets maximum buffered channel size between the indexer client and the query service for index scans. This parameter controls when to use scan backfill. Use 0 or a negative number to disable.

Specifies the consistency guarantee/constraint for index scanning.

Specifies the maximum time the client is willing to wait for an index to catch up to the vector timestamp in the request. If an index has to catch up, and the ScanWait(TimeSpan) time is exceed doing so, an error is returned.

Sets the maximum time to spend on the request.

Returns a String that represents this instance.