Uses of Class
com.couchbase.client.java.query.N1qlParams

Packages that use N1qlParams

Package	Description
com.couchbase.client.java.query

Uses of N1qlParams in com.couchbase.client.java.query

Methods in com.couchbase.client.java.query that return N1qlParams

Modifier and Type	Method and Description
N1qlParams	N1qlParams.adhoc(boolean adhoc) Allows to specify if this query is adhoc or not.
static N1qlParams	N1qlParams.build() Start building a N1qlParams, allowing to customize an N1QL request.
N1qlParams	N1qlParams.consistency(ScanConsistency consistency) Sets scan consistency.
N1qlParams	N1qlParams.consistentWith(Document... documents) Sets the Documents resulting of a mutation this query should be consistent with.
N1qlParams	N1qlParams.consistentWith(DocumentFragment... fragments) Sets the DocumentFragments resulting of a mutation this query should be consistent with.
N1qlParams	N1qlParams.consistentWith(MutationState mutationState) Sets the MutationState this query should be consistent with.
N1qlParams	N1qlParams.disableMetrics(boolean disableMetrics) If set to true (false being the default), the metrics object will not be returned from N1QL and as a result be more efficient.
N1qlParams	N1qlParams.maxParallelism(int maxParallelism) Allows to override the default maximum parallelism for the query execution on the server side.
abstract N1qlParams	N1qlQuery.params() Returns the N1qlParams representing customization of the N1QL query.
N1qlParams	AbstractN1qlQuery.params()
N1qlParams	N1qlParams.pipelineBatch(int pipelineBatch) Advanced: Controls the number of items execution operators can batch for Fetch from the KV.
N1qlParams	N1qlParams.pipelineCap(int pipelineCap) Advanced: Maximum number of items each execution operator can buffer between various operators.
N1qlParams	N1qlParams.pretty(boolean pretty) If set to false, the server will be instructed to remove extra whitespace from the JSON response in order to save bytes.
N1qlParams	N1qlParams.profile(N1qlProfile profile) Specifies if there should be a profile section returned with the request results.
N1qlParams	N1qlParams.rawParam(String name, Object value) Allows to specify an arbitrary, raw N1QL param.
N1qlParams	N1qlParams.readonly(boolean readonly) If set to true, it will signal the query engine on the server that only non-data modifying requests are allowed.
N1qlParams	N1qlParams.scanCap(int scanCap) Advanced: Maximum buffered channel size between the indexer client and the query service for index scans.
N1qlParams	N1qlParams.scanWait(long wait, TimeUnit unit) If the NOT_BOUNDED scan consistency has been chosen, does nothing.
N1qlParams	N1qlParams.serverSideTimeout(long timeout, TimeUnit unit) Sets a maximum timeout for processing on the server side.
N1qlParams	N1qlParams.withContextId(String clientContextId) Adds a client context ID to the request, that will be sent back in the response, allowing clients to meaningfully trace requests/responses when many are exchanged.
N1qlParams	N1qlParams.withCredentials(List<Credential> credentials) Allows to add a list of credentials (in the form of Credential objects) to this request.
N1qlParams	N1qlParams.withCredentials(String login, String password) Allows to add a credential username/password pair to this request.

Methods in com.couchbase.client.java.query with parameters of type N1qlParams

Modifier and Type	Method and Description
static ParameterizedN1qlQuery	N1qlQuery.parameterized(Statement statement, JsonArray positionalParams, N1qlParams params) Create a new query with positionalParameters.
static ParameterizedN1qlQuery	N1qlQuery.parameterized(Statement statement, JsonObject namedParams, N1qlParams params) Create a new query with named parameters.
static ParameterizedN1qlQuery	N1qlQuery.parameterized(String statement, JsonArray positionalParams, N1qlParams params) Create a new query with positionalParameters.
static ParameterizedN1qlQuery	N1qlQuery.parameterized(String statement, JsonObject namedParams, N1qlParams params) Create a new query with named parameters.
static SimpleN1qlQuery	N1qlQuery.simple(Statement statement, N1qlParams params) Create a new N1qlQuery with a plain un-parameterized Statement and custom query parameters.
static SimpleN1qlQuery	N1qlQuery.simple(String statement, N1qlParams params) Create a new N1qlQuery with a plain raw statement in String form and custom query parameters.

Constructors in com.couchbase.client.java.query with parameters of type N1qlParams

Constructor and Description
AbstractN1qlQuery(Statement statement, N1qlParams params)
PreparedN1qlQuery(PreparedPayload plan, JsonArray positionalParams, N1qlParams params)
PreparedN1qlQuery(PreparedPayload plan, JsonObject namedParams, N1qlParams params)
PreparedN1qlQuery(PreparedPayload plan, N1qlParams params)