CBLQueryIndex

@interface CBLQueryIndex : NSObject

CBLQueryIndex object representing an existing index in the collection.

  • The collection.

    Declaration

    Objective-C

    @property (nonatomic, readonly) CBLCollection *_Nonnull collection;

  • The index name.

    Declaration

    Objective-C

    @property (nonatomic, readonly) NSString *_Nonnull name;

  • ENTERPRISE EDITION ONLY

    For updating lazy vector indexes only. Finds new or updated documents for which vectors need to be (re)computed and return a CBLIndexUpdater 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, nil will be returned. If the index is not lazy, an error will be returned.

    Declaration

    Objective-C

    - (nullable CBLIndexUpdater *)
    beginUpdateWithLimit:(uint64_t)limit
                   error:(NSError *_Nullable *_Nullable)error;

    Parameters

    limit

    The limit per update.
    error

    On return, the error if any.

    Return Value

    CBLIndexUpdater object if there are updates to be done, or nil if the index is up-to-date or if an error occurred.

  • Unavailable

    Not available

    Declaration

    Objective-C

    - (nonnull instancetype)init;