Indexable

public protocol Indexable

The Indexable interface defines a set of functions for managing the query indexes.

  • Return all index names, or nil if an error occurred.

    Declaration

    Swift

    func indexes() throws -> [String]

  • Create an index with the index name and config.

    Declaration

    Swift

    func createIndex(withName name: String, config: IndexConfiguration) throws

  • Create an index with the index and index name.

    Declaration

    Swift

    func createIndex(_ index: Index, name: String) throws

  • Delete an index by name.

    Declaration

    Swift

    func deleteIndex(forName name: String) throws

  • Return an index object, or nil if the index doesn’t exist.

    Declaration

    Swift

    func index(withName name: String) throws -> QueryIndex?