Package com.couchbase.lite

Class IndexBuilder

java.lang.Object

com.couchbase.lite.IndexBuilder

public final class IndexBuilder
extends java.lang.Object

IndexBuilder used for building database index objects. Use Database.createIndex(IndexConfiguration, String)

Method Summary

Modifier and Type	Method	Description
static FullTextIndex	fullTextIndex(FullTextIndexItem... items)	Create a full-text search index with the given index item and options.
static PredictiveIndex	predictiveIndex(java.lang.String model, Expression input, java.util.List<java.lang.String> properties)	ENTERPRISE EDITION API
static ValueIndex	valueIndex(ValueIndexItem... items)	Create a value index with the given index items.

Methods inherited from class java.lang.Object

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

Method Detail

predictiveIndex

@NonNull
public static PredictiveIndex predictiveIndex(@NonNull
                                              java.lang.String model,
                                              @NonNull
                                              Expression input,
                                              @Nullable
                                              java.util.List<java.lang.String> properties)

ENTERPRISE EDITION API

Create a predictive index with the given predictive model name, input specification to the predictive model, and the properties of the prediction result.

The input given specification should be matched to the input specification given to the query prediction() function so that the predictive index can be matched and used in query.

The predictive index is different from the normal index in that the predictive index will also cache the prediction result along with creating the value index of the specified properties. If the properties are not specified, the predictive index will only cache the prediction result so that the prediction model will not be called again after indexing. If multiple properties are specified, a compound value index will be created from the given properties.

Parameters:

model - The predictive model name.

input - The input specification that should be matched with the input specification given to the query prediction function.

properties - The prediction result's properties to be indexed.

Returns:

The predictive index.

valueIndex

@NonNull
public static ValueIndex valueIndex(@NonNull
                                    ValueIndexItem... items)

Create a value index with the given index items. The index items are a list of the properties or expressions to be indexed.

Parameters:

items - The index items

Returns:

The value index

fullTextIndex

@NonNull
public static FullTextIndex fullTextIndex(@NonNull
                                          FullTextIndexItem... items)

Create a full-text search index with the given index item and options. Typically the index item is the property that is used to perform the match operation against with.

Parameters:

items - The index items.

Returns:

The full-text search index.