FullTextIndexConfiguration

public struct FullTextIndexConfiguration : IndexConfiguration, IndexConfigConvertable

Configuration for creating full-text indexes.

  • Gets the expressions to use to create the index.

    Declaration

    Swift

    public let expressions: [String]

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

    Declaration

    Swift

    public let `where`: String?

  • Set the true value to ignore accents/diacritical marks. The default value is FullTextIndexConfiguration.defaultIgnoreAccents.

    Declaration

    Swift

    public let ignoreAccents: Bool

  • The language code which is an ISO-639 language such as “en”, “fr”, etc. Setting the language code affects how word breaks and word stems are parsed. Without setting the value, the current locale’s language will be used. Setting a nil or “” value to disable the language features.

    Declaration

    Swift

    public let language: String?

  • Initializes a full-text index using an array of N1QL expression strings, with an optional where clause for partial indexing.

    Declaration

    Swift

    public init(_ expressions: [String], where: String? = nil, ignoreAccents: Bool? = FullTextIndexConfiguration.defaultIgnoreAccents, language: String? = nil)

  • [false] Accents and ligatures are not ignored when indexing via full text search

    Declaration

    Swift

    static let defaultIgnoreAccents: Bool