QueryParameters

public enum QueryParameters

Query parameters for view functions from design documents.

  • Includes conflicts information in response. Ignored if include_docs isn’t true. Default is false.

    Declaration

    Swift

    case conflicts (Bool)

  • Return the documents in descending by key order. Default is false.

    Declaration

    Swift

    case descending (Bool)

  • Stop returning records when the specified key is reached.

    Declaration

    Swift

    case endKey ([Any])

  • Stop returning records when the specified document ID is reached. Requires endkey to be specified for this to have any effect.

    Declaration

    Swift

    case endKeyDocID (String)

  • Group the results using the reduce function to a group or single row. Default is false

    Declaration

    Swift

    case group (Bool)

  • Specify the group level to be used.

    Declaration

    Swift

    case groupLevel (Int)

  • Include the associated document with each row. Default is false.

    Declaration

    Swift

    case includeDocs (Bool)

  • Include the Base64-encoded content of attachments in the documents that are included if include_docs is true. Ignored if include_docs isn’t true. Default is false.

    Declaration

    Swift

    case attachments (Bool)

  • Include encoding information in attachment stubs if include_docs is true and the particular attachment is compressed. Ignored if include_docs isn’t true. Default is false.

    Declaration

    Swift

    case attachmentEncodingInfo (Bool)

  • Specifies whether the specified end key should be included in the result. Default is true.

    Declaration

    Swift

    case inclusiveEnd(Bool)

  • Limit the number of the returned documents to the specified number.

    Declaration

    Swift

    case limit (Int)

  • Use the reduction function. Default is true.

    Declaration

    Swift

    case reduce (Bool)

  • Skip this number of records before starting to return the results. Default is 0.

    Declaration

    Swift

    case skip (Int)

  • Allow the results from a stale view to be used.

    Declaration

    Swift

    case stale (StaleOptions)

  • Return records starting with the specified key.

    Declaration

    Swift

    case startKey ([Any])

  • Return records starting with the specified document ID. Requires startkey to be specified for this to have any effect.

    Declaration

    Swift

    case startKeyDocID (String)

  • Response includes an update_seq value indicating which sequence id of the database the view reflects. Default is false.

    Declaration

    Swift

    case updateSequence (Bool)

  • Return only documents where the key matches one of the keys specified in the array.

    Declaration

    Swift

    case keys ([Any])