QueryByKeyList

public struct QueryByKeyList: QueryParameters

Query parameter structure to use when querying a known list of keys.

  • Declaration

    Swift

    public var sortOrder: QuerySortOrder = .ascending

  • Declaration

    Swift

    public var rowLimit: UInt = 0

  • Declaration

    Swift

    public var startRow: UInt = 0

  • Declaration

    Swift

    public var includeDocuments: Bool = false

  • Array of index keys to match. Only matching keys will be included in the result set.

    Declaration

    Swift

    public var keys: [Any]

  • Initializes a QueryByKeyList structure with default options.

    Since the default keys array is empty, running a query with only the default parameters will result in no index rows being returned.

    Declaration

    Swift

    public init(keys: [Any] = [])

    Parameters

    keys

    Array of index keys to match. Defaults to an empty array.