ArrayIndexConfiguration

public struct ArrayIndexConfiguration : IndexConfiguration, IndexConfigConvertable

Configuration for indexing property values within nested arrays in documents, intended for use with the UNNEST query.

  • Path to the array, which can be nested.

    Declaration

    Swift

    public let path: String

  • The expressions representing the values within the array to be indexed.

    Declaration

    Swift

    public let expressions: [String]?

  • Initializes the configuration with paths to the nested array and the optional expressions for the values within the arrays to be indexed.

    Note

    Note Use “[]” to represent a property that is an array of each nested array level. For a single array or the last level array, the “[]” is optional. For instance, use “contacts[].phones” to specify an array of phones within each contact.

    Declaration

    Swift

    public init(path: String, expressions: [String]? = nil)