Interface IQueryIndex

An interface representing an existing index in a collection

Inherited Members

System.IDisposable.Dispose()

Namespace: Couchbase.Lite.Query

Assembly: Couchbase.Lite.dll

Syntax

public interface IQueryIndex : IDisposable

Properties

Collection

The collection that this index belongs to

Declaration

Collection Collection { get; }

Property Value

Type	Description
Collection

Name

The name of the index

Declaration

string Name { get; }

Property Value

Type	Description
System.String

Methods

BeginUpdate(UInt64)

For updating lazy vector indexes.

Finds new or updated documents for which vectors need to be (re)computed and return an IIndexUpdater 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.

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

Declaration

IIndexUpdater BeginUpdate(ulong limit)

Parameters

Type	Name	Description
System.UInt64	limit	The max number of vectors to be computed

Returns

Type	Description
IIndexUpdater	The object used for setting the computed vectors

Remarks

NOTE: This is an enterprise edition feature

Exceptions

Type	Condition
CouchbaseLiteException	Thrown if the index is not lazy or not a vector index