Package com.couchbase.lite

Class QueryIndex

java.lang.Object

com.couchbase.lite.QueryIndex

public class QueryIndex
extends Object

QueryIndex object represents an existing index in the collection.

Method Summary

Modifier and Type	Method	Description
IndexUpdater	beginUpdate(int limit)	ENTERPRISE EDITION API
Collection	getCollection()
String	getName()

Methods inherited from class java.lang.Object

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

Method Details

getCollection

@NonNull
public Collection getCollection()

getName

@NonNull
public String getName()

beginUpdate

@Nullable
public IndexUpdater beginUpdate(int limit)
                         throws CouchbaseLiteException

ENTERPRISE EDITION API

Finds new or updated documents for which vectors need to be (re)computed and return an IndexUpdater object used for setting the computed vectors for updating the index.The limit parameter is for setting the max number of vectors to be computed. index.

The limit parameter sets the maximum number of documents for which the index will be updated.

If index is up-to-date, null will be returned.

If the index is not lazy or not a vector index, a CouchbaseLiteException will be thrown.

Note:

The index updater is not guaranteed to find all unindexed documents at once. It may return fewer than the limit, even if more documents exist. It is guaranteed to make progress byreturning some unindexed documents if there are any. The intention is that the beginUpdate() will be periodically called to update the index until null is returned, indicating that the index is up-to-date.

Throws:

CouchbaseLiteException