org.springframework.data.couchbase.repository.query

Class StringN1qlBasedQuery

java.lang.Object

org.springframework.data.couchbase.repository.query.AbstractN1qlBasedQuery

org.springframework.data.couchbase.repository.query.StringN1qlBasedQuery

All Implemented Interfaces:

RepositoryQuery

public class StringN1qlBasedQuery
extends AbstractN1qlBasedQuery

A RepositoryQuery for Couchbase, based on N1QL and a String statement.

The statement can contain positional placeholders (eg. name = $1) that will map to the method's parameters, in the same order.

The statement can also contain SpEL expressions enclosed in #{ and }.

There are couchbase-provided variables included for the bucket namespace, the ID and CAS fields necessary for entity reconstruction or a shortcut that covers SELECT AND FROM clauses, along with a variable for WHERE clause filtering of the correct entity.

Author:

Simon Baslé, Subhashni Balakrishnan

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	StringN1qlBasedQuery.N1qlSpelValues This class is exposed to SpEL parsing through the variable #.

Field Summary

Fields

Modifier and Type	Field and Description
static String	SPEL_BUCKET Use this variable in a SpEL expression in a @Query annotation's inline statement.
static String	SPEL_ENTITY Use this variable in a SpEL expression in a @Query annotation's inline statement.
static String	SPEL_FILTER Use this variable in a SpEL expression in a @Query annotation's inline statement WHERE clause.
static String	SPEL_PREFIX
static String	SPEL_SELECT_FROM_CLAUSE Use this variable in a SpEL expression in a @Query annotation's inline statement.

Fields inherited from class org.springframework.data.couchbase.repository.query.AbstractN1qlBasedQuery

queryMethod

Constructor Summary

Constructors

Constructor and Description
StringN1qlBasedQuery(String statement, CouchbaseQueryMethod queryMethod, CouchbaseOperations couchbaseOperations, SpelExpressionParser spelParser, EvaluationContextProvider evaluationContextProvider)

Method Summary

Modifier and Type	Method and Description
static StringN1qlBasedQuery.N1qlSpelValues	createN1qlSpelValues(String bucketName, String typeField, Class<?> typeValue, boolean isCount)
protected static String	doParse(String statement, SpelExpressionParser parser, EvaluationContext evaluationContext, StringN1qlBasedQuery.N1qlSpelValues n1qlSpelValues)
protected com.couchbase.client.java.query.Statement	getCount(ParameterAccessor accessor, Object[] runtimeParameters) The statement for a count() query.
protected com.couchbase.client.java.document.json.JsonValue	getPlaceholderValues(ParameterAccessor accessor)
com.couchbase.client.java.query.Statement	getStatement(ParameterAccessor accessor, Object[] runtimeParameters, ReturnedType returnedType)
protected String	getTypeField()
protected Class<?>	getTypeValue()
protected String	parseSpel(String statement, boolean isCount, Object[] runtimeParameters) Parse the statement to detect SPEL blocks (delimited by #{ and }) and replace said expression blocks with their corresponding values.
protected boolean	useGeneratedCountQuery()

Methods inherited from class org.springframework.data.couchbase.repository.query.AbstractN1qlBasedQuery

buildQuery, execute, executeCollection, executeDependingOnType, executeEntity, executePaged, executeSingleProjection, executeSliced, executeStream, getCouchbaseOperations, getQueryMethod

Methods inherited from class java.lang.Object

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

Field Detail

SPEL_PREFIX

public static final String SPEL_PREFIX

See Also:

Constant Field Values

SPEL_SELECT_FROM_CLAUSE

public static final String SPEL_SELECT_FROM_CLAUSE

Use this variable in a SpEL expression in a @Query annotation's inline statement. This will be replaced by the correct SELECT x FROM y clause needed for entity mapping. Eg. "#{} WHERE test = true". Note this only makes sense once, as the beginning of the statement.

See Also:

Constant Field Values

SPEL_BUCKET

public static final String SPEL_BUCKET

Use this variable in a SpEL expression in a @Query annotation's inline statement. This will be replaced by the (escaped) bucket name corresponding to the repository's entity. Eg. "SELECT * FROM #{} LIMIT 3".

See Also:

Constant Field Values

SPEL_ENTITY

public static final String SPEL_ENTITY

Use this variable in a SpEL expression in a @Query annotation's inline statement. This will be replaced by the fields allowing to construct the repository's entity (SELECT clause). Eg. "SELECT #{} FROM test".

See Also:

Constant Field Values

SPEL_FILTER

public static final String SPEL_FILTER

Use this variable in a SpEL expression in a @Query annotation's inline statement WHERE clause. This will be replaced by the expression allowing to only select documents matching the entity's class. Eg. "SELECT * FROM test WHERE test = true AND #{}".

See Also:

Constant Field Values

Constructor Detail

StringN1qlBasedQuery

public StringN1qlBasedQuery(String statement,
                            CouchbaseQueryMethod queryMethod,
                            CouchbaseOperations couchbaseOperations,
                            SpelExpressionParser spelParser,
                            EvaluationContextProvider evaluationContextProvider)

Method Detail

getTypeField

protected String getTypeField()

getTypeValue

protected Class<?> getTypeValue()

createN1qlSpelValues

public static StringN1qlBasedQuery.N1qlSpelValues createN1qlSpelValues(String bucketName,
                                                                       String typeField,
                                                                       Class<?> typeValue,
                                                                       boolean isCount)

parseSpel

protected String parseSpel(String statement,
                           boolean isCount,
                           Object[] runtimeParameters)

Parse the statement to detect SPEL blocks (delimited by #{ and }) and replace said expression blocks with their corresponding values.

Parameters:

statement - the full statement into which SpEL expressions should be parsed and replaced.

runtimeParameters - the parameters passed into the method at runtime.

Returns:

the statement with the SpEL interpreted and replaced by its values.

doParse

protected static String doParse(String statement,
                                SpelExpressionParser parser,
                                EvaluationContext evaluationContext,
                                StringN1qlBasedQuery.N1qlSpelValues n1qlSpelValues)

getPlaceholderValues

protected com.couchbase.client.java.document.json.JsonValue getPlaceholderValues(ParameterAccessor accessor)

Specified by:

getPlaceholderValues in class AbstractN1qlBasedQuery

getStatement

public com.couchbase.client.java.query.Statement getStatement(ParameterAccessor accessor,
                                                              Object[] runtimeParameters,
                                                              ReturnedType returnedType)

Specified by:

getStatement in class AbstractN1qlBasedQuery

getCount

protected com.couchbase.client.java.query.Statement getCount(ParameterAccessor accessor,
                                                             Object[] runtimeParameters)

Description copied from class: AbstractN1qlBasedQuery

The statement for a count() query. This must aggregate using count with the alias CountFragment.COUNT_ALIAS.

Specified by:

getCount in class AbstractN1qlBasedQuery

See Also:

CountFragment

useGeneratedCountQuery

protected boolean useGeneratedCountQuery()

Specified by:

useGeneratedCountQuery in class AbstractN1qlBasedQuery

Returns:

true if the count statement should also be used when the return type of the QueryMethod is a primitive type.