CBLValueIndexConfiguration

@interface CBLValueIndexConfiguration : CBLIndexConfiguration

Configuration for creating value indexes.

  • A predicate expression defining conditions for indexing documents. Only documents satisfying the predicate are included, enabling partial indexes.

    Declaration

    Objective-C

    @property (nonatomic, readonly, nullable) NSString *where;

  • Initializes a value index by using an array of expression strings.

    Declaration

    Objective-C

    - (nonnull instancetype)initWithExpression:
    (nonnull NSArray<NSString *> *)expressions;

    Parameters

    expressions

    The array of expression strings.

    Return Value

    The value index configuration object.

  • Initializes a value index with an array of expression strings and an optional where clause for a partial index.

    Declaration

    Objective-C

    - (nonnull instancetype)initWithExpression:
                            (nonnull NSArray<NSString *> *)expressions
                                     where:(nullable NSString *)where;

    Parameters

    expressions

    The array of expression strings.
    where

    Optional where clause for partial indexing.

    Return Value

    The value index configuration object.