QueryIndex

public class QueryIndex

QueryIndex object representing an existing index in the collection.

  • The collection.

    Declaration

    Swift

    public let collection: Collection

  • The index name.

    Declaration

    Swift

    public var name: String { get }

  • ENTERPRISE EDITION ONLY

    For updating lazy vector indexes only. Finds new or updated documents for which vectors need to be (re)computed and return an IndexUpdater 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.

    Declaration

    Swift

    public func beginUpdate(limit: UInt64) throws -> IndexUpdater?

    Parameters

    limit

    The limit per update.

    Return Value

    IndexUpdater object if there are updates to be done, or nil if the index is up-to-date.