CBLIndex

@interface CBLIndex : NSObject

CBLIndex represents an index which could be a value index for regular queries or full-text search (FTS) index for full-text queries (using the match operator).


                    
                    
                    +valueIndexOn:

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

Declaration

Objective-C

+ (nonnull CBLIndex *)valueIndexOn:
    (nonnull NSArray<CBLValueIndexItem *> *)items;

Parameters


                                items

The index items.

Return Value

The value index.


                    
                    
                    +ftsIndexOn:options:

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. Setting the nil options means using the default options.

Declaration

Objective-C

+ (nonnull CBLIndex *)ftsIndexOn:(nonnull CBLFTSIndexItem *)item
                         options:(nullable CBLFTSIndexOptions *)options;

Parameters

`item`	The index item.
`options`	The index options.

Return Value

The full-text search index.