Represents a request for a N1QL query
Namespace: Couchbase.N1QLAssembly: Couchbase.NetClient (in Couchbase.NetClient.dll) Version: 2.0.0.0 (2.0.0.0)
SyntaxThe IQueryRequest type exposes the following members.
Methods| 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.
|
| 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.
|
| 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.
|
| GetQueryParameters | |
| GetRequestUri |
Gets the constructed Uri for making the request.
|
| HttpMethod |
The HTTP method type to use.
|
| Metrics |
Specifies that metrics should be returned with query results.
|
| Prepared |
Sets a N1QL statement to be executed.
|
| 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.
|
| ScanVector |
Specify the lower bound vector timestamp when using at_plus scan consistency.
|
| 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.
|
| Timeout |
Sets the maximum time to spend on the request.
|
Properties| Name | Description | |
|---|---|---|
 | IsPost |
The HTTP method type to use.
|
| IsPrepared |
Returns true if the request is a prepared statement
|
See Also