org.springframework.data.couchbase.core.query

Class Query

java.lang.Object

org.springframework.data.couchbase.core.query.Query

Direct Known Subclasses:

StringQuery

public class Query
extends Object

Author:

Michael Nitschinger, Michael Reiche

Constructor Summary

Constructors

Constructor and Description
Query()
Query(QueryCriteria criteriaDefinition)

Method Summary

Modifier and Type	Method and Description
Query	addCriteria(QueryCriteria criteriaDefinition)
void	appendSkipAndLimit(StringBuilder sb)
void	appendSort(StringBuilder sb)
void	appendString(StringBuilder sb, String whereString)
void	appendWhere(StringBuilder sb, int[] paramIndexPtr, CouchbaseConverter converter)
void	appendWhereString(StringBuilder sb, String whereString)
com.couchbase.client.java.query.QueryOptions	buildQueryOptions(com.couchbase.client.java.query.QueryScanConsistency scanConsistency) build QueryOptions from parameters and scanConsistency
String	export(int[]... paramIndexPtrHolder)
com.couchbase.client.java.query.QueryScanConsistency	getScanConsistency() queryScanConsistency
Query	limit(int limit) Limit the number of returned documents to limit.
Query	scanConsistency(com.couchbase.client.java.query.QueryScanConsistency queryScanConsistency) Sets the given scan consistency on the Query instance.
Query	setNamedParameters(com.couchbase.client.java.json.JsonObject parameters) set the named parameters on the query object There can only be named parameters or positional parameters - not both.
Query	setPositionalParameters(com.couchbase.client.java.json.JsonArray parameters) set the postional parameters on the query object There can only be named parameters or positional parameters - not both.
Query	skip(long skip) Set number of documents to skip before returning results.
String	toN1qlRemoveString(ReactiveCouchbaseTemplate template, Class domainClass)
String	toN1qlSelectString(ReactiveCouchbaseTemplate template, Class domainClass, boolean isCount)
Query	with(Pageable pageable) Sets the given pagination information on the Query instance.
Query	with(Sort sort) Adds a Sort to the Query instance.

Methods inherited from class java.lang.Object

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

Constructor Detail

Query

public Query()

Query

public Query(QueryCriteria criteriaDefinition)

Method Detail

addCriteria

public Query addCriteria(QueryCriteria criteriaDefinition)

setPositionalParameters

public Query setPositionalParameters(com.couchbase.client.java.json.JsonArray parameters)

set the postional parameters on the query object There can only be named parameters or positional parameters - not both.

Parameters:

parameters - - the positional parameters

Returns:

- the query

setNamedParameters

public Query setNamedParameters(com.couchbase.client.java.json.JsonObject parameters)

set the named parameters on the query object There can only be named parameters or positional parameters - not both.

Parameters:

parameters - - the named parameters

Returns:

- the query

skip

public Query skip(long skip)

Set number of documents to skip before returning results.

Parameters:

skip -

Returns:

limit

public Query limit(int limit)

Limit the number of returned documents to limit.

Parameters:

limit -

Returns:

with

public Query with(Pageable pageable)

Sets the given pagination information on the Query instance. Will transparently set skip and limit as well as applying the Sort instance defined with the Pageable.

Parameters:

pageable -

Returns:

getScanConsistency

public com.couchbase.client.java.query.QueryScanConsistency getScanConsistency()

queryScanConsistency

Returns:

queryScanConsistency

scanConsistency

public Query scanConsistency(com.couchbase.client.java.query.QueryScanConsistency queryScanConsistency)

Sets the given scan consistency on the Query instance.

Parameters:

queryScanConsistency -

Returns:

this

with

public Query with(Sort sort)

Adds a Sort to the Query instance.

Parameters:

sort -

Returns:

appendSkipAndLimit

public void appendSkipAndLimit(StringBuilder sb)

appendSort

public void appendSort(StringBuilder sb)

appendWhere

public void appendWhere(StringBuilder sb,
                        int[] paramIndexPtr,
                        CouchbaseConverter converter)

appendWhereString

public void appendWhereString(StringBuilder sb,
                              String whereString)

appendString

public void appendString(StringBuilder sb,
                         String whereString)

export

public String export(int[]... paramIndexPtrHolder)

toN1qlSelectString

public String toN1qlSelectString(ReactiveCouchbaseTemplate template,
                                 Class domainClass,
                                 boolean isCount)

toN1qlRemoveString

public String toN1qlRemoveString(ReactiveCouchbaseTemplate template,
                                 Class domainClass)

buildQueryOptions

public com.couchbase.client.java.query.QueryOptions buildQueryOptions(com.couchbase.client.java.query.QueryScanConsistency scanConsistency)

build QueryOptions from parameters and scanConsistency

Parameters:

scanConsistency -

Returns:

QueryOptions