CBLIndexBuilder

@interface CBLIndexBuilder : NSObject

/**
 Create a value index with the given index items. The index items are a list of
 the properties or expressions to be indexed.
 
 @param items The index items.
 @return The value index.
 */
+ (CBLValueIndex*) valueIndexWithItems: (NSArray<CBLValueIndexItem*>*)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. Setting the nil options
 means using the default options.
 
 @param items The index items.
 @return The full-text search index.
 */
+ (CBLFullTextIndex*) fullTextIndexWithItems: (NSArray<CBLFullTextIndexItem*>*)items;

/** Not available */
- (instancetype) init NS_UNAVAILABLE;

@end

Undocumented

  • 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 CBLValueIndex *)valueIndexWithItems:
        (nonnull NSArray<CBLValueIndexItem *> *)items;

    Swift

    class func valueIndex(with items: [CBLValueIndexItem]) -> CBLValueIndex

    Parameters

    items

    The index items.

    Return Value

    The value index.

  • 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 CBLFullTextIndex *)fullTextIndexWithItems:
        (nonnull NSArray<CBLFullTextIndexItem *> *)items;

    Swift

    class func fullTextIndex(with items: [CBLFullTextIndexItem]) -> CBLFullTextIndex

    Parameters

    items

    The index items.

    Return Value

    The full-text search index.

  • Not available

    Declaration

    Objective-C

    - (nonnull instancetype)init;