Represents a request for a N1QL query
Namespace: Couchbase.N1QLAssembly: Couchbase.NetClient (in Couchbase.NetClient.dll) Version: 0.0.0.0 (0.0.0.0)

The IQueryRequest type exposes the following members.

Name | Description | |
---|---|---|
![]() | AddCredentials |
Adds a set of credentials to the list of credentials, in the form of user/password
|
![]() | AddNamedParameter(KeyValuePair<String, Object>[]) |
Adds a collection of named parameters to the parameters to the statement or prepared statement.
|
![]() | AddNamedParameter(String, Object) |
Adds a named parameter to the parameters to the statement or prepared statement.
|
![]() | AddPositionalParameter(Object) |
Adds a positional parameter to the parameters to the statement or prepared statement.
|
![]() | AddPositionalParameter(Object[]) |
Adds a list of positional parameters to the statement or prepared statement.
|
![]() | AdHoc |
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.
|
![]() | BaseUri |
The base Uri used to create the request e.g. http://localhost:8093/query
|
![]() | ClientContextId |
A piece of data supplied by the client that is echoed in the response, if present. N1QL makes no assumptions about the meaning of this data and just logs and echoes it.
|
![]() | Compression |
Compression format to use for response data on the wire. Possible values are ZIP, RLE, LZMA, LZO, NONE.
|
![]() | ConsistentWith |
Provides a means of ensuring "read your own wites" or RYOW consistency on the current query.
|
![]() | Encoding |
Specifies the desired character encoding for the query results.
|
![]() | Format |
Desired format for the query results.
|
![]() | GetBaseUri |
Gets the Uri for the Query service
|
![]() | GetFormValues |
Gets a IDictionary<TKey, TValue> of the name/value pairs to be POSTed to the service if Post is used.
|
![]() | GetFormValuesAsJson |
Gets the JSON representation of this query for execution in a POST.
|
![]() | GetOriginalStatement |
Gets the raw, unprepared N1QL statement.
|
![]() | GetPreparedPayload |
Gets the prepared payload for this N1QL statement if IsPrepared() is true,
null otherwise.
|
![]() | MaxServerParallelism |
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.
|
![]() | Metrics |
Specifies that metrics should be returned with query results.
|
![]() | Prepared |
Sets a N1QL statement to be executed in an optimized way using the given queryPlan.
|
![]() | Pretty |
Pretty print the output.
|
![]() | ReadOnly |
If a GET request, this will always be true otherwise false.
|
![]() | ScanConsistency |
Specifies the consistency guarantee/constraint for index scanning.
|
![]() | ScanWait |
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.
|
![]() | Signature |
Includes a header for the results schema in the response.
|
![]() | Statement |
Sets a N1QL statement to be executed.
|
![]() | TimedOut |
True if the request exceeded it's QueryRequestTimeout |
![]() | Timeout |
Sets the maximum time to spend on the request.
|

Name | Description | |
---|---|---|
![]() | CurrentContextId |
Gets the context identifier for the N1QL query request/response. Useful for debugging.
|
![]() | HasBeenRetried |
Gets a value indicating whether this instance has been retried (if it's been optimized
and prepared then the server marked it as stale/not runnable).
|
![]() | IsAdHoc |
Gets a value indicating whether this query statement is to executed in an ad-hoc manner.
|
![]() | IsPrepared |
Returns true if the request is not ad-hoc and has been optimized using Prepared(QueryPlan, String).
|
![]() | Lifespan |
Sets the lifespan of the query request; used to check if the request exceeded the maximum time
configured for it in QueryRequestTimeout |
