QueryParameters

public protocol QueryParameters

Protocol for common Query parameters

  • Sort order to use in this query

    Declaration

    Swift

    var sortOrder: QuerySortOrder

  • Maximum number of rows to return, used with startRow to perform pagin of large result sets.

    Zero rowLimit indicates no limit. All rows from the startRow will be returned.

    Declaration

    Swift

    var rowLimit: UInt

  • First row to return from the result set, used with rowLimit to perform paging of large result sets.

    Declaration

    Swift

    var startRow: UInt

  • Query results should pre-fetch the entire document.

    Caution:

    Returning entire documents impacts performance of the query. Including the document in the query results is more efficent if it is known at query time that every document returned will be needed. However, if only some documents from the query results will be needed, it is more efficent to request those specific documents after the query is run.

    Declaration

    Swift

    var includeDocuments: Bool