IQueryRequest InterfaceCouchbase .NET SDK 2.3.3
Represents a request for a N1QL query

Namespace: Couchbase.N1QL
Assembly: Couchbase.NetClient (in Couchbase.NetClient.dll) Version: 0.0.0.0 (0.0.0.0)
Syntax
public interface IQueryRequest

Return Value

Type: 

The IQueryRequest type exposes the following members.

Methods
  NameDescription
Public methodAddCredentials
Adds a set of credentials to the list of credentials, in the form of user/password
Public methodAddNamedParameter(KeyValuePair<String, Object>[])
Adds a collection of named parameters to the parameters to the statement or prepared statement.
Public methodAddNamedParameter(String, Object)
Adds a named parameter to the parameters to the statement or prepared statement.
Public methodAddPositionalParameter(Object)
Adds a positional parameter to the parameters to the statement or prepared statement.
Public methodAddPositionalParameter(Object[])
Adds a list of positional parameters to the statement or prepared statement.
Public methodAdHoc
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.
Public methodBaseUri
The base Uri used to create the request e.g. http://localhost:8093/query
Public methodClientContextId
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.
Public methodCompression
Compression format to use for response data on the wire. Possible values are ZIP, RLE, LZMA, LZO, NONE.
Public methodConsistentWith
Provides a means of ensuring "read your own wites" or RYOW consistency on the current query.
Public methodEncoding
Specifies the desired character encoding for the query results.
Public methodFormat
Desired format for the query results.
Public methodGetBaseUri
Gets the Uri for the Query service
Public methodGetFormValues
Public methodGetFormValuesAsJson
Gets the JSON representation of this query for execution in a POST.
Public methodGetOriginalStatement
Gets the raw, unprepared N1QL statement.
Public methodGetPreparedPayload
Gets the prepared payload for this N1QL statement if IsPrepared() is true, null otherwise.
Public methodMaxServerParallelism
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.
Public methodMetrics
Specifies that metrics should be returned with query results.
Public methodPrepared
Sets a N1QL statement to be executed in an optimized way using the given queryPlan.
Public methodPretty
Pretty print the output.
Public methodReadOnly
If a GET request, this will always be true otherwise false.
Public methodScanConsistency
Specifies the consistency guarantee/constraint for index scanning.
Public methodScanWait
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.
Public methodSignature
Includes a header for the results schema in the response.
Public methodStatement
Sets a N1QL statement to be executed.
Public methodTimedOut
True if the request exceeded it's QueryRequestTimeout
Public methodTimeout
Sets the maximum time to spend on the request.
Top
Properties
  NameDescription
Public propertyCurrentContextId
Gets the context identifier for the N1QL query request/response. Useful for debugging.
Public propertyHasBeenRetried
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).
Public propertyIsAdHoc
Gets a value indicating whether this query statement is to executed in an ad-hoc manner.
Public propertyIsPrepared
Returns true if the request is not ad-hoc and has been optimized using Prepared(QueryPlan, String).
Public propertyLifespan
Sets the lifespan of the query request; used to check if the request exceeded the maximum time configured for it in QueryRequestTimeout
Top
See Also