com.couchbase.client.java.query

Class N1qlQuery

java.lang.Object

com.couchbase.client.java.query.N1qlQuery

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

AbstractN1qlQuery

public abstract class N1qlQuery
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
N1qlQuery()

Method Summary

Modifier and Type	Method and Description
abstract JsonObject	n1ql() Convert this query to a full N1QL query in Json form.
static ParameterizedN1qlQuery	parameterized(Statement statement, JsonArray positionalParams) Create a new query with positionalParameters.
static ParameterizedN1qlQuery	parameterized(Statement statement, JsonArray positionalParams, N1qlParams params) Create a new query with positionalParameters.
static ParameterizedN1qlQuery	parameterized(Statement statement, JsonObject namedParams) Create a new query with named parameters.
static ParameterizedN1qlQuery	parameterized(Statement statement, JsonObject namedParams, N1qlParams params) Create a new query with named parameters.
static ParameterizedN1qlQuery	parameterized(String statement, JsonArray positionalParams) Create a new query with positionalParameters.
static ParameterizedN1qlQuery	parameterized(String statement, JsonArray positionalParams, N1qlParams params) Create a new query with positionalParameters.
static ParameterizedN1qlQuery	parameterized(String statement, JsonObject namedParams) Create a new query with named parameters.
static ParameterizedN1qlQuery	parameterized(String statement, JsonObject namedParams, N1qlParams params) Create a new query with named parameters.
abstract N1qlParams	params() Returns the N1qlParams representing customization of the N1QL query.
static SimpleN1qlQuery	simple(Statement statement) Create a new N1qlQuery with a plain un-parameterized Statement.
static SimpleN1qlQuery	simple(Statement statement, N1qlParams params) Create a new N1qlQuery with a plain un-parameterized Statement and custom query parameters.
static SimpleN1qlQuery	simple(String statement) Create a new N1qlQuery with a plain raw statement in String form.
static SimpleN1qlQuery	simple(String statement, N1qlParams params) Create a new N1qlQuery 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

N1qlQuery

public N1qlQuery()

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 N1qlParams params()

Returns the N1qlParams representing customization of the N1QL query.

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

Returns:

the N1qlParams 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 SimpleN1qlQuery simple(Statement statement)

Create a new N1qlQuery with a plain un-parameterized Statement.

Parameters:

statement - the Statement to execute

simple

public static SimpleN1qlQuery simple(String statement)

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

Parameters:

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

simple

public static SimpleN1qlQuery simple(Statement statement,
                                     N1qlParams params)

Create a new N1qlQuery with a plain un-parameterized Statement and custom query parameters.

Parameters:

statement - the Statement to execute

params - the query parameters.

simple

public static SimpleN1qlQuery simple(String statement,
                                     N1qlParams params)

Create a new N1qlQuery 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.

parameterized

public static ParameterizedN1qlQuery parameterized(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

parameterized

public static ParameterizedN1qlQuery parameterized(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

parameterized

public static ParameterizedN1qlQuery parameterized(Statement statement,
                                                   JsonArray positionalParams,
                                                   N1qlParams 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.

parameterized

public static ParameterizedN1qlQuery parameterized(Statement statement,
                                                   JsonObject namedParams,
                                                   N1qlParams 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.

parameterized

public static ParameterizedN1qlQuery parameterized(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

parameterized

public static ParameterizedN1qlQuery parameterized(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

parameterized

public static ParameterizedN1qlQuery parameterized(String statement,
                                                   JsonArray positionalParams,
                                                   N1qlParams 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.

parameterized

public static ParameterizedN1qlQuery parameterized(String statement,
                                                   JsonObject namedParams,
                                                   N1qlParams 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.