com.couchbase.client.java.query

Class PreparedQuery

java.lang.Object

com.couchbase.client.java.query.Query

com.couchbase.client.java.query.AbstractQuery

com.couchbase.client.java.query.ParametrizedQuery

com.couchbase.client.java.query.PreparedQuery

public class PreparedQuery
extends ParametrizedQuery

Represent a N1QL query, with a parametrized prepared statement plan (for which the values must be passed according to the type and number of placeholders).

Positional placeholders (in the form of either “$1” “$2” or just simple “?”) are filled by the values taken from a JsonArray.

Named placeholders (in the form of “$param1”, “$myOtherParam”, etc…) are filled by the values taken from a JsonObject. If in this JsonObject attributes don’t have the $ prefix, it is added upon building the query.

Since:

2.1

Method Summary

Modifier and Type	Method and Description
QueryPlan	statement() Returns the Statement from this query.
protected String	statementType() The type of the statement, used as JSON name in the final JSON form of the query
protected Object	statementValue() The JSON representation for the underlying Statement in the final JSON form of the query

Methods inherited from class com.couchbase.client.java.query.ParametrizedQuery

statementParameters

Methods inherited from class com.couchbase.client.java.query.AbstractQuery

n1ql, params, populateParameters

Methods inherited from class com.couchbase.client.java.query.Query

parametrized, parametrized, parametrized, parametrized, parametrized, parametrized, parametrized, parametrized, prepared, prepared, prepared, prepared, prepared, prepared, simple, simple, simple, simple

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

statementType

protected String statementType()

Description copied from class: AbstractQuery

The type of the statement, used as JSON name in the final JSON form of the query

Overrides:

statementType in class ParametrizedQuery

statementValue

protected Object statementValue()

Description copied from class: AbstractQuery

The JSON representation for the underlying Statement in the final JSON form of the query

Overrides:

statementValue in class ParametrizedQuery

statement

public QueryPlan statement()

Description copied from class: Query

Returns the Statement from this query. Note that this is the only mandatory part of a N1QL query.

Overrides:

statement in class AbstractQuery

Returns:

the statement that forms the base of this query