com.cloudant.client.api.query

Class QueryBuilder

java.lang.Object

com.cloudant.client.api.query.QueryBuilder

public class QueryBuilder
extends java.lang.Object

Helper class for building query selector strings.

Example usage to return the name and year of movies starring Alec Guinness since 1960 with the results sorted by year descending:

 
 String query = db.query(new QueryBuilder(and(
   gt("Movie_year", 1960),
   eq("Person_name", "Alec Guinness"))).
   sort(Sort.desc("Movie_year")).
   fields("Movie_name", "Movie_year").
   build();
 
 

The resulting string can then be used to query the database using either Database.query(String, Class) (which deserialises the results) or CloudantClient.executeRequest(HttpConnection) (which can be used to make a "raw" request by POSTing the string to the /_find endpoint).

See Also:

Selector

Constructor Summary

Constructors

Constructor and Description
QueryBuilder(Selector selector) Construct a QueryBuilder object for use with Database.query(String, Class)

Method Summary

Modifier and Type	Method and Description
QueryBuilder	bookmark(java.lang.String bookmark) Set the bookmark option for the query builder.
java.lang.String	build() Build string representation of query for use with Database.query(String, Class).
QueryBuilder	executionStats(boolean executionStats) Set the executionStats option for the query builder.
QueryBuilder	fields(java.lang.String... fields) Set the fields option for the query builder.
QueryBuilder	limit(long limit) Set the limit option for the query builder.
QueryBuilder	skip(long skip) Set the skip option for the query builder.
QueryBuilder	sort(Sort... sort) Set the sort option for the query builder.
QueryBuilder	stable(boolean stable) Set the stable option for the query builder.
QueryBuilder	update(boolean update) Set the update option for the query builder.
QueryBuilder	useIndex(java.lang.String designDocument) Instruct a query to use a specific index.
QueryBuilder	useIndex(java.lang.String designDocument, java.lang.String indexName) Instruct a query to use a specific index.

Methods inherited from class java.lang.Object

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

Constructor Detail

QueryBuilder

public QueryBuilder(Selector selector)

Construct a QueryBuilder object for use with Database.query(String, Class)

Obtain a selector from an Operation or Expression.

Parameters:

selector - Selector object describing criteria used to select documents.

See Also:

selector syntax, Database.query(String, Class), Selector

Method Detail

fields

public QueryBuilder fields(java.lang.String... fields)

Set the fields option for the query builder.

Parameters:

fields - List specifying which fields of each document should be returned. If it is omitted, the entire document is returned.

Returns:

QueryBuilder object for method chaining.

sort

public QueryBuilder sort(Sort... sort)

Set the sort option for the query builder.

Parameters:

sort - List specifying sort order of returned documents.

Returns:

QueryBuilder object for method chaining.

limit

public QueryBuilder limit(long limit)

Set the limit option for the query builder.

Parameters:

limit - Maximum number of results returned. Default is 25.

Returns:

QueryBuilder object for method chaining.

skip

public QueryBuilder skip(long skip)

Set the skip option for the query builder.

Parameters:

skip - Skip the first n results, where n is the value specified.

Returns:

QueryBuilder object for method chaining.

bookmark

public QueryBuilder bookmark(java.lang.String bookmark)

Set the bookmark option for the query builder.

Parameters:

bookmark - A string that enables you to specify which page of results you require. Used for paging through result sets. Every query returns an opaque string under the bookmark key that can then be passed back in a query to get the next page of results. If any part of the selector query changes between requests, the results are undefined.

Returns:

QueryBuilder object for method chaining.

update

public QueryBuilder update(boolean update)

Set the update option for the query builder.

Parameters:

update - Whether to update the index prior to returning the result. Default is true.

Returns:

QueryBuilder object for method chaining.

stable

public QueryBuilder stable(boolean stable)

Set the stable option for the query builder.

Parameters:

stable - Whether or not the view results should be returned from a "stable" set of shards.

Returns:

QueryBuilder object for method chaining.

executionStats

public QueryBuilder executionStats(boolean executionStats)

Set the executionStats option for the query builder.

Parameters:

executionStats - Include execution statistics in the query response. Defailt is false

Returns:

QueryBuilder object for method chaining.

useIndex

public QueryBuilder useIndex(java.lang.String designDocument)

Instruct a query to use a specific index.

Parameters:

designDocument - Design document to use.

Returns:

QueryBuilder object for method chaining.

useIndex

public QueryBuilder useIndex(java.lang.String designDocument,
                             java.lang.String indexName)

Instruct a query to use a specific index.

Parameters:

designDocument - Design document to use.

indexName - Index name to use.

Returns:

QueryBuilder object for method chaining.

build

public java.lang.String build()

Build string representation of query for use with Database.query(String, Class).

Returns:

String representation of query.