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, Mark Paluch

Field Summary

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, QueryMethodEvaluationContextProvider evaluationContextProvider)

Method Summary

Modifier and Type	Method and Description
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 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

Constructor Detail

StringN1qlBasedQuery

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

Method Detail

getTypeField

protected String getTypeField()

getTypeValue

protected Class<?> getTypeValue()

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.