Package com.cloudant.client.api.query

This package provides access to the query API.

See: Description

Interface Summary

Interface	Description
Field
Index<F extends Field>
Selector	Interface that identifies all Operations and Expressions that can form the basis of a selector.

Class Summary

Class	Description
EmptyExpression
ExecutionStats
Expression	Expressions are used to evaluate true/false criteria to select documents.
Indexes	Class modelling the indexes defined for a database.
JsonIndex	Class model of a JSON index definition.
JsonIndex.Builder	Class for building a definition for a JSON type index.
JsonIndex.Field	Model of a field in a JSON index including the field name and sort order.
Operation	An Operation allows Expressions or other Operations to be combined using logical operators or negated.
PredicatedOperation	A PredicatedOperation allows multiple predicates (such as "equals 5") to be combined.
PredicateExpression	PredicateExpressions are the same as ordinary Expressions, but instead of taking a field name as one of their arguments, they are combined with a PredicatedOperation.
QueryBuilder	Helper class for building query selector strings.
QueryResult<T>
Sort
TextIndex	Class model of a text index definition.
TextIndex.Builder	Class for building a definition for a text type index.
TextIndex.Field	Model of a field in the text index including the field name and type.

Enum Summary

Enum	Description
Sort.Order
Type

Package com.cloudant.client.api.query Description

This package provides access to the query API.

Overview

This package contains classes which make it easier to interact with the query API in the following ways:

• A class for building complex queries which makes the construction of the query JSON easier.
• Classes for building complex selectors, used in the construction of queries (above), and in the construction of partial indexes, which makes the construction of the selector JSON easier.
• Classes for reading the results of queries.

For a worked example showing the construction of queries, see Database.query(java.lang.String, java.lang.Class).

For worked examples showing the construction of partial indexes, see Database.createIndex(java.lang.String).