com.couchbase.client.java.query

Class Query

java.lang.Object

com.couchbase.client.java.query.Query

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

AbstractQuery

public abstract class Query
extends Object
implements Serializable

Contract to describe N1QL queries. Queries are formed of a mandatory Statement and optionally can have other components, as described in each implementation of this.

Also exposes factory methods for different kinds of queries.

Since:

2.1

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
Query()

Method Summary

Modifier and Type	Method and Description
abstract JsonObject	n1ql() Convert this query to a full N1QL query in Json form.
static ParametrizedQuery	parametrized(Statement statement, JsonArray positionalParams) Create a new query with positionalParameters.
static ParametrizedQuery	parametrized(Statement statement, JsonArray positionalParams, QueryParams params) Create a new query with positionalParameters.
static ParametrizedQuery	parametrized(Statement statement, JsonObject namedParams) Create a new query with named parameters.
static ParametrizedQuery	parametrized(Statement statement, JsonObject namedParams, QueryParams params) Create a new query with named parameters.
static ParametrizedQuery	parametrized(String statement, JsonArray positionalParams) Create a new query with positionalParameters.
static ParametrizedQuery	parametrized(String statement, JsonArray positionalParams, QueryParams params) Create a new query with positionalParameters.
static ParametrizedQuery	parametrized(String statement, JsonObject namedParams) Create a new query with named parameters.
static ParametrizedQuery	parametrized(String statement, JsonObject namedParams, QueryParams params) Create a new query with named parameters.
abstract QueryParams	params() Returns the QueryParams representing customization of the N1QL query.
static PreparedQuery	prepared(QueryPlan plan) Create a new prepared query without parameters (the original statement shouldn’t contain parameter placeholders).
static PreparedQuery	prepared(QueryPlan plan, JsonArray positionalParams) Create a new prepared query with positionalParameters.
static PreparedQuery	prepared(QueryPlan plan, JsonArray positionalParams, QueryParams params) Create a new prepared query with positionalParameters.
static PreparedQuery	prepared(QueryPlan plan, JsonObject namedParams) Create a new prepared query with named parameters.
static PreparedQuery	prepared(QueryPlan plan, JsonObject namedParams, QueryParams params) Create a new prepared query with named parameters.
static PreparedQuery	prepared(QueryPlan plan, QueryParams params) Create a new prepared query without parameters (the original statement shouldn’t contain parameter placeholders).
static SimpleQuery	simple(Statement statement) Create a new Query with a plain un-parametrized Statement.
static SimpleQuery	simple(Statement statement, QueryParams params) Create a new Query with a plain un-parametrized Statement and custom query parameters.
static SimpleQuery	simple(String statement) Create a new Query with a plain raw statement in String form.
static SimpleQuery	simple(String statement, QueryParams params) Create a new Query with a plain raw statement in String form and custom query parameters.
abstract Statement	statement() Returns the Statement from this query.

Methods inherited from class java.lang.Object

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

Constructor Detail

Query

public Query()

Method Detail

statement

public abstract Statement statement()

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

Returns:

the statement that forms the base of this query

params

public abstract QueryParams params()

Returns the QueryParams representing customization of the N1QL query.

Note that this is different from named or positional parameters (which relate to the statement).

Returns:

the QueryParams for this query, null if none.

n1ql

public abstract JsonObject n1ql()

Convert this query to a full N1QL query in Json form.

Returns:

the json representation of this query (including all relevant parameters)

simple

public static SimpleQuery simple(Statement statement)

Create a new Query with a plain un-parametrized Statement.

Parameters:

statement - the Statement to execute

simple

public static SimpleQuery simple(String statement)

Create a new Query with a plain raw statement in String form.

Parameters:

statement - the raw statement string to execute (eg. “SELECT * FROM default”).

simple

public static SimpleQuery simple(Statement statement,
                                 QueryParams params)

Create a new Query with a plain un-parametrized Statement and custom query parameters.

Parameters:

statement - the Statement to execute

params - the query parameters.

simple

public static SimpleQuery simple(String statement,
                                 QueryParams params)

Create a new Query with a plain raw statement in String form and custom query parameters.

Parameters:

statement - the raw statement string to execute (eg. “SELECT * FROM default”).

params - the query parameters.

parametrized

public static ParametrizedQuery parametrized(Statement statement,
                                             JsonArray positionalParams)

Create a new query with positionalParameters. Note that the JsonArray should not be mutated until n1ql() is called since it backs the creation of the query string.

Parameters:

statement - the Statement to execute (containing positional placeholders)

positionalParams - the values for the positional placeholders in statement

parametrized

public static ParametrizedQuery parametrized(Statement statement,
                                             JsonObject namedParams)

Create a new query with named parameters. Note that the JsonObject should not be mutated until n1ql() is called since it backs the creation of the query string.

Parameters:

statement - the Statement to execute (containing named placeholders)

namedParams - the values for the named placeholders in statement

parametrized

public static ParametrizedQuery parametrized(Statement statement,
                                             JsonArray positionalParams,
                                             QueryParams params)

Create a new query with positionalParameters. Note that the JsonArray should not be mutated until n1ql() is called since it backs the creation of the query string.

Parameters:

statement - the Statement to execute (containing positional placeholders)

positionalParams - the values for the positional placeholders in statement

params - the query parameters.

parametrized

public static ParametrizedQuery parametrized(Statement statement,
                                             JsonObject namedParams,
                                             QueryParams params)

Create a new query with named parameters. Note that the JsonObject should not be mutated until n1ql() is called since it backs the creation of the query string.

Parameters:

statement - the Statement to execute (containing named placeholders)

namedParams - the values for the named placeholders in statement

params - the query parameters.

parametrized

public static ParametrizedQuery parametrized(String statement,
                                             JsonArray positionalParams)

Create a new query with positionalParameters. Note that the JsonArray should not be mutated until n1ql() is called since it backs the creation of the query string.

Parameters:

statement - the raw statement to execute (containing positional placeholders)

positionalParams - the values for the positional placeholders in statement

parametrized

public static ParametrizedQuery parametrized(String statement,
                                             JsonObject namedParams)

Create a new query with named parameters. Note that the JsonObject should not be mutated until n1ql() is called since it backs the creation of the query string.

Parameters:

statement - the raw statement to execute (containing named placeholders)

namedParams - the values for the named placeholders in statement

parametrized

public static ParametrizedQuery parametrized(String statement,
                                             JsonArray positionalParams,
                                             QueryParams params)

Create a new query with positionalParameters. Note that the JsonArray should not be mutated until n1ql() is called since it backs the creation of the query string.

Parameters:

statement - the raw statement to execute (containing positional placeholders)

positionalParams - the values for the positional placeholders in statement

params - the query parameters.

parametrized

public static ParametrizedQuery parametrized(String statement,
                                             JsonObject namedParams,
                                             QueryParams params)

Create a new query with named parameters. Note that the JsonObject should not be mutated until n1ql() is called since it backs the creation of the query string.

Parameters:

statement - the raw statement to execute (containing named placeholders)

namedParams - the values for the named placeholders in statement

params - the query parameters.

prepared

public static PreparedQuery prepared(QueryPlan plan)

Create a new prepared query without parameters (the original statement shouldn’t contain parameter placeholders).

Parameters:

plan - the prepared QueryPlan to execute (containing no placeholders).

prepared

public static PreparedQuery prepared(QueryPlan plan,
                                     JsonArray positionalParams)

Create a new prepared query with positionalParameters. Note that the JsonArray should not be mutated until n1ql() is called since it backs the creation of the query string.

Parameters:

plan - the prepared QueryPlan to execute (containing positional placeholders).

positionalParams - the values for the positional placeholders in statement.

prepared

public static PreparedQuery prepared(QueryPlan plan,
                                     JsonObject namedParams)

Create a new prepared query with named parameters. Note that the JsonObject should not be mutated until n1ql() is called since it backs the creation of the query string.

Parameters:

plan - the prepared QueryPlan to execute (containing named placeholders).

namedParams - the values for the named placeholders in statement.

prepared

public static PreparedQuery prepared(QueryPlan plan,
                                     QueryParams params)

Create a new prepared query without parameters (the original statement shouldn’t contain parameter placeholders).

Parameters:

plan - the prepared QueryPlan to execute (containing no placeholders).

params - the query parameters.

prepared

public static PreparedQuery prepared(QueryPlan plan,
                                     JsonArray positionalParams,
                                     QueryParams params)

Create a new prepared query with positionalParameters. Note that the JsonArray should not be mutated until n1ql() is called since it backs the creation of the query string.

Parameters:

plan - the prepared QueryPlan to execute (containing positional placeholders).

positionalParams - the values for the positional placeholders in statement.

params - the query parameters.

prepared

public static PreparedQuery prepared(QueryPlan plan,
                                     JsonObject namedParams,
                                     QueryParams params)

Create a new prepared query with named parameters. Note that the JsonObject should not be mutated until n1ql() is called since it backs the creation of the query string.

Parameters:

plan - the prepared QueryPlan to execute (containing named placeholders).

namedParams - the values for the named placeholders in statement.

params - the query parameters.