com.cloudant.sync.query

Class IndexManager

java.lang.Object

com.cloudant.sync.query.IndexManager

public class IndexManager
extends java.lang.Object

Main interface to Cloudant query. Use the manager to: - create indexes - delete indexes - execute queries - update indexes (usually done automatically)

API Status: Public

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	INDEX_METADATA_TABLE_NAME

Constructor Summary

Constructors

Constructor and Description
IndexManager(Datastore datastore) Constructs a new IndexManager which indexes documents in 'datastore'

Method Summary

Modifier and Type	Method and Description
void	close()
boolean	deleteIndexNamed(java.lang.String indexName) Delete an index.
java.lang.String	ensureIndexed(java.util.List<java.lang.Object> fieldNames) Add a single, possibly compound, index for the given field names.
java.lang.String	ensureIndexed(java.util.List<java.lang.Object> fieldNames, java.lang.String indexName) Add a single, possibly compound, index for the given field names.
java.lang.String	ensureIndexed(java.util.List<java.lang.Object> fieldNames, java.lang.String indexName, IndexType indexType) Add a single, possibly compound, index for the given field names.
java.lang.String	ensureIndexed(java.util.List<java.lang.Object> fieldNames, java.lang.String indexName, IndexType indexType, java.util.Map<java.lang.String,java.lang.String> indexSettings) Add a single, possibly compound, index for the given field names.
QueryResult	find(java.util.Map<java.lang.String,java.lang.Object> query)
QueryResult	find(java.util.Map<java.lang.String,java.lang.Object> query, long skip, long limit, java.util.List<java.lang.String> fields, java.util.List<java.util.Map<java.lang.String,java.lang.String>> sortDocument)
boolean	isTextSearchEnabled()
java.util.Map<java.lang.String,java.lang.Object>	listIndexes() Get a list of indexes and their definitions as a Map.
boolean	updateAllIndexes() Update all indexes.

Methods inherited from class java.lang.Object

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

Field Detail

INDEX_METADATA_TABLE_NAME

public static final java.lang.String INDEX_METADATA_TABLE_NAME

See Also:

Constant Field Values

Constructor Detail

IndexManager

public IndexManager(Datastore datastore)

Constructs a new IndexManager which indexes documents in 'datastore'

Parameters:

datastore - The Datastore to index

Method Detail

close

public void close()

listIndexes

public java.util.Map<java.lang.String,java.lang.Object> listIndexes()

Get a list of indexes and their definitions as a Map. Returns: { indexName: { type: json, name: indexName, fields: [field1, field2] }

Returns:

Map of indexes in the database.

ensureIndexed

public java.lang.String ensureIndexed(java.util.List<java.lang.Object> fieldNames)

Add a single, possibly compound, index for the given field names. This method generates a name for the new index.

Parameters:

fieldNames - List of field names in the sort format

Returns:

name of created index

ensureIndexed

public java.lang.String ensureIndexed(java.util.List<java.lang.Object> fieldNames,
                                      java.lang.String indexName)

Add a single, possibly compound, index for the given field names. This function generates a name for the new index.

Parameters:

fieldNames - List of field names in the sort format

indexName - Name of index to create or null to generate an index name.

Returns:

name of created index

ensureIndexed

public java.lang.String ensureIndexed(java.util.List<java.lang.Object> fieldNames,
                                      java.lang.String indexName,
                                      IndexType indexType)

Add a single, possibly compound, index for the given field names. This function generates a name for the new index.

Parameters:

fieldNames - List of field names in the sort format

indexName - Name of index to create or null to generate an index name.

indexType - The type of index (json or text currently supported)

Returns:

name of created index

ensureIndexed

public java.lang.String ensureIndexed(java.util.List<java.lang.Object> fieldNames,
                                      java.lang.String indexName,
                                      IndexType indexType,
                                      java.util.Map<java.lang.String,java.lang.String> indexSettings)

Add a single, possibly compound, index for the given field names. This function generates a name for the new index.

Parameters:

fieldNames - List of field names in the sort format

indexName - Name of index to create or null to generate an index name.

indexType - The type of index (json or text currently supported)

indexSettings - The optional settings to be applied to an index Only text indexes support settings - Ex. { "tokenize" : "simple" }

Returns:

name of created index

deleteIndexNamed

public boolean deleteIndexNamed(java.lang.String indexName)

Delete an index.

Parameters:

indexName - Name of index to delete

Returns:

deletion status as true/false

updateAllIndexes

public boolean updateAllIndexes()

Update all indexes.

Returns:

update status as true/false

find

public QueryResult find(java.util.Map<java.lang.String,java.lang.Object> query)

find

public QueryResult find(java.util.Map<java.lang.String,java.lang.Object> query,
                        long skip,
                        long limit,
                        java.util.List<java.lang.String> fields,
                        java.util.List<java.util.Map<java.lang.String,java.lang.String>> sortDocument)

isTextSearchEnabled

public boolean isTextSearchEnabled()