QueryByKeyRange

public struct QueryByKeyRange: QueryParameters

Query parameter structure to use when querying a range 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

  • The first key in the view index to return in the result set. If nil, then the result set will start with the start of the index.

    Declaration

    Swift

    public var startKey: Any?

  • The last key in the view index to return in the result set. If nil, then the result set will end with the end of the index.

    Declaration

    Swift

    public var endKey: Any?

  • Initializes a QueryByKeyRange structure

    Since the default startKey and endKey values are nil, running a query with only the default parameters will result in all index rows being returned.

    Declaration

    Swift

    public init(startKey: Any? = nil, endKey: Any? = nil)

    Parameters

    startKey

    The first key in the view index to return in the result set. Defaults to nil.
    endKey

    The last key in the view index to return in the result set. Defaults to nil.