AllDocsQueryParams (jkniv 0.6.6 API)

java.lang.Object
- net.sf.jkniv.whinstone.couchdb.statement.AllDocsQueryParams

```
public class AllDocsQueryParams
extends Object
```
Query Parameters: conflicts (boolean) – Includes conflicts information in response. Ignored if include_docs isn’t true. Default is false. descending (boolean) – Return the documents in descending by key order. Default is false. endkey (string) – Stop returning records when the specified key is reached. Optional. end_key (string) – Alias for endkey param. endkey_docid (string) – Stop returning records when the specified document ID is reached. Optional. end_key_doc_id (string) – Alias for endkey_docid param. include_docs (boolean) – Include the full content of the documents in the return. Default is false. inclusive_end (boolean) – Specifies whether the specified end key should be included in the result. Default is true. key (string) – Return only documents that match the specified key. Optional. keys (string) – Return only documents that match the specified keys. Optional. limit (number) – Limit the number of the returned documents to the specified number. Optional. skip (number) – Skip this number of records before starting to return the results. Default is 0. stale (string) – Allow the results from a stale view to be used, without triggering a rebuild of all views within the encompassing design doc. Supported values: ok and update_after. Optional. startkey (string) – Return records starting with the specified key. Optional. start_key (string) – Alias for startkey param. startkey_docid (string) – Return records starting with the specified document ID. Optional. start_key_doc_id (string) – Alias for startkey_docid param. update_seq (boolean) – Response includes an update_seq value indicating which sequence id of the underlying database the view reflects. Default is false.

Since:

0.6.0

Author:

Alisson Gomes

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`KEY_conflicts` (boolean) – Includes conflicts information in response.
`static String`	`KEY_descending` (boolean) – Return the documents in descending by key order.
`static String`	`KEY_end_key` (string) – Alias for endkey param.
`static String`	`KEY_end_key_doc_id` (string) – Alias for endkey_docid param.
`static String`	`KEY_endkey` (string) – Stop returning records when the specified key is reached.
`static String`	`KEY_endkey_docid` (string) – Stop returning records when the specified document ID is reached.
`static String`	`KEY_include_docs` (boolean) – Include the full content of the documents in the return.
`static String`	`KEY_inclusive_end` (boolean) – Specifies whether the specified end key should be included in the result.
`static String`	`KEY_key` (string) – Return only documents that match the specified key.
`static String`	`KEY_keys` (string) – Return only documents that match the specified keys.
`static String`	`KEY_limit` (number) – Limit the number of the returned documents to the specified number.
`static String`	`KEY_skip` (number) – Skip this number of records before starting to return the results.
`static String`	`KEY_stale` (string) – Allow the results from a stale view to be used, without triggering a rebuild of all views within the encompassing design doc.
`static String`	`KEY_start_key` (string) – Alias for startkey param.
`static String`	`KEY_start_key_doc_id` (string) – Alias for startkey_docid param.
`static String`	`KEY_startkey` (string) – Return records starting with the specified key.
`static String`	`KEY_startkey_docid` (string) – Return records starting with the specified document ID.
`static String`	`KEY_update_seq` (boolean) – Response includes an update_seq value indicating which sequence id of the underlying database the view reflects.

Constructor Summary

Constructors
Constructor and Description

AllDocsQueryParams()

Constructors
Constructor and Description
`AllDocsQueryParams()`

Method Summary
- Methods inherited from class java.lang.Object
  clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - KEY_conflicts
```
public static final String KEY_conflicts
```
    (boolean) – Includes conflicts information in response. Ignored if include_docs isn’t true. Default is false.
    
    See Also:
    
    Constant Field Values
  - KEY_descending
```
public static final String KEY_descending
```
    (boolean) – Return the documents in descending by key order. Default is false.
    
    See Also:
    
    Constant Field Values
  - KEY_endkey
```
public static final String KEY_endkey
```
    (string) – Stop returning records when the specified key is reached. Optional.
    
    See Also:
    
    Constant Field Values
  - KEY_end_key
```
public static final String KEY_end_key
```
    (string) – Alias for endkey param.
    
    See Also:
    
    Constant Field Values
  - KEY_endkey_docid
```
public static final String KEY_endkey_docid
```
    (string) – Stop returning records when the specified document ID is reached. Optional.
    
    See Also:
    
    Constant Field Values
  - KEY_end_key_doc_id
```
public static final String KEY_end_key_doc_id
```
    (string) – Alias for endkey_docid param.
    
    See Also:
    
    Constant Field Values
  - KEY_include_docs
```
public static final String KEY_include_docs
```
    (boolean) – Include the full content of the documents in the return. Default is false.
    
    See Also:
    
    Constant Field Values
  - KEY_inclusive_end
```
public static final String KEY_inclusive_end
```
    (boolean) – Specifies whether the specified end key should be included in the result. Default is true.
    
    See Also:
    
    Constant Field Values
  - KEY_key
```
public static final String KEY_key
```
    (string) – Return only documents that match the specified key. Optional.
    
    See Also:
    
    Constant Field Values
  - KEY_keys
```
public static final String KEY_keys
```
    (string) – Return only documents that match the specified keys. Optional.
    
    See Also:
    
    Constant Field Values
  - KEY_limit
```
public static final String KEY_limit
```
    (number) – Limit the number of the returned documents to the specified number. Optional.
    
    See Also:
    
    Constant Field Values
  - KEY_skip
```
public static final String KEY_skip
```
    (number) – Skip this number of records before starting to return the results. Default is 0.
    
    See Also:
    
    Constant Field Values
  - KEY_stale
```
public static final String KEY_stale
```
    (string) – Allow the results from a stale view to be used, without triggering a rebuild of all views within the encompassing design doc. Supported values: ok and update_after. Optional.
    
    See Also:
    
    Constant Field Values
  - KEY_startkey
```
public static final String KEY_startkey
```
    (string) – Return records starting with the specified key. Optional.
    
    See Also:
    
    Constant Field Values
  - KEY_start_key
```
public static final String KEY_start_key
```
    (string) – Alias for startkey param.
    
    See Also:
    
    Constant Field Values
  - KEY_startkey_docid
```
public static final String KEY_startkey_docid
```
    (string) – Return records starting with the specified document ID. Optional.
    
    See Also:
    
    Constant Field Values
  - KEY_start_key_doc_id
```
public static final String KEY_start_key_doc_id
```
    (string) – Alias for startkey_docid param.
    
    See Also:
    
    Constant Field Values
  - KEY_update_seq
```
public static final String KEY_update_seq
```
    (boolean) – Response includes an update_seq value indicating which sequence id of the underlying database the view reflects. Default is false.
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - AllDocsQueryParams
```
public AllDocsQueryParams()
```

Class AllDocsQueryParams

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

KEY_conflicts

KEY_descending

KEY_endkey

KEY_end_key

KEY_endkey_docid

KEY_end_key_doc_id

KEY_include_docs

KEY_inclusive_end

KEY_key

KEY_keys

KEY_limit

KEY_skip

KEY_stale

KEY_startkey

KEY_start_key

KEY_startkey_docid

KEY_start_key_doc_id

KEY_update_seq

Constructor Detail

AllDocsQueryParams