001/* 
002 * JKNIV, whinstone one contract to access your database.
003 * 
004 * Copyright (C) 2017, the original author or authors.
005 *
006 * This library is free software; you can redistribute it and/or
007 * modify it under the terms of the GNU Lesser General Public
008 * License as published by the Free Software Foundation; either
009 * version 2.1 of the License.
010 * 
011 * This library is distributed in the hope that it will be useful,
012 * but WITHOUT ANY WARRANTY; without even the implied warranty of
013 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
014 * Lesser General Public License for more details.
015 * 
016 * You should have received a copy of the GNU Lesser General Public
017 * License along with this library; if not, write to the Free Software Foundation, Inc., 
018 * 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
019 */
020package net.sf.jkniv.whinstone.couchdb.statement;
021
022/**
023 * 
024 * <code>
025 * Query Parameters:
026 *  
027 *  conflicts (boolean) – Includes conflicts information in response. Ignored if include_docs isn’t true. Default is false.
028 *  descending (boolean) – Return the documents in descending by key order. Default is false.
029 *  endkey (string) – Stop returning records when the specified key is reached. Optional.
030 *  end_key (string) – Alias for endkey param.
031 *  endkey_docid (string) – Stop returning records when the specified document ID is reached. Optional.
032 *  end_key_doc_id (string) – Alias for endkey_docid param.
033 *  include_docs (boolean) – Include the full content of the documents in the return. Default is false.
034 *  inclusive_end (boolean) – Specifies whether the specified end key should be included in the result. Default is true.
035 *  key (string) – Return only documents that match the specified key. Optional.
036 *  keys (string) – Return only documents that match the specified keys. Optional.
037 *  limit (number) – Limit the number of the returned documents to the specified number. Optional.
038 *  skip (number) – Skip this number of records before starting to return the results. Default is 0.
039 *  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.
040 *  startkey (string) – Return records starting with the specified key. Optional.
041 *  start_key (string) – Alias for startkey param.
042 *  startkey_docid (string) – Return records starting with the specified document ID. Optional.
043 *  start_key_doc_id (string) – Alias for startkey_docid param.
044 *  update_seq (boolean) – Response includes an update_seq value indicating which sequence id of the underlying database the view reflects. Default is false.
045 *
046 * </code>
047 * @author Alisson Gomes
048 * @since 0.6.0
049 *
050 */
051public class AllDocsQueryParams
052{
053    /** (boolean) – Includes conflicts information in response. Ignored if include_docs isn’t true. Default is false. */
054    public static final String KEY_conflicts = "conflicts";
055    /** (boolean) – Return the documents in descending by key order. Default is false. */
056    public static final String KEY_descending = "descending";
057    /** (string) – Stop returning records when the specified key is reached. Optional. */
058    public static final String KEY_endkey = "endkey";
059    /** (string) – Alias for endkey param. */
060    public static final String KEY_end_key = "end_key"; 
061    /** (string) – Stop returning records when the specified document ID is reached. Optional. */
062    public static final String KEY_endkey_docid  = "endkey_docid";
063    /** (string) – Alias for endkey_docid param. */
064    public static final String KEY_end_key_doc_id  = "end_key_doc_id";
065    /** (boolean) – Include the full content of the documents in the return. Default is false. */
066    public static final String KEY_include_docs  = "include_docs";
067    /** (boolean) – Specifies whether the specified end key should be included in the result. Default is true. */
068    public static final String KEY_inclusive_end  = "inclusive_end";
069    /** (string) – Return only documents that match the specified key. Optional. */
070    public static final String KEY_key  = "key";
071    /** (string) – Return only documents that match the specified keys. Optional. */
072    public static final String KEY_keys  = "keys";
073    /** (number) – Limit the number of the returned documents to the specified number. Optional. */
074    public static final String KEY_limit  = "limit";
075    /** (number) – Skip this number of records before starting to return the results. Default is 0. */
076    public static final String KEY_skip  = "skip";
077    /** (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. */
078    public static final String KEY_stale  = "stale";
079    /** (string) – Return records starting with the specified key. Optional. */
080    public static final String KEY_startkey  = "startkey";
081    /** (string) – Alias for startkey param. */
082    public static final String KEY_start_key  = "start_key";
083    /** (string) – Return records starting with the specified document ID. Optional. */
084    public static final String KEY_startkey_docid  = "startkey_docid";
085    /** (string) – Alias for startkey_docid param. */
086    public static final String KEY_start_key_doc_id  = "start_key_doc_id";
087    /** (boolean) – Response includes an update_seq value indicating which sequence id of the underlying database the view reflects. Default is false. */
088    public static final String KEY_update_seq  = "";    
089    /** Includes conflicts information in response. Ignored if include_docs isn’t true. Default is false. */
090    
091    /*
092    private Boolean conflicts;
093    // Return the documents in descending by key order. Default is false. 
094    private Boolean descending;
095    // Stop returning records when the specified key is reached. Optional. 
096    private String endkey; 
097    // Alias for endkey param. 
098    private String end_key; 
099    // Stop returning records when the specified document ID is reached. Optional. 
100    private String endkey_docid; 
101    // Alias for endkey_docid param. 
102    private String end_key_doc_id;
103    // Include the full content of the documents in the return. Default is false. 
104    private Boolean include_docs;
105    // Specifies whether the specified end key should be included in the result. Default is true. 
106    private Boolean inclusive_end;
107    /// Return only documents that match the specified key. Optional. 
108    private String key;
109    // Return only documents that match the specified keys. Optional. 
110    private String keys;
111    // Limit the number of the returned documents to the specified number. Optional. 
112    private Long limit;
113    // Skip this number of records before starting to return the results. Default is 0. 
114    private Long skip; 
115    // 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. 
116    private String stale;
117    // Return records starting with the specified key. Optional. 
118    private String startkey;
119    // Alias for startkey param. 
120    private String start_key;
121    // Return records starting with the specified document ID. Optional. 
122    private String startkey_docid; 
123    // Alias for startkey_docid param. 
124    private String start_key_doc_id; 
125    // Response includes an update_seq value indicating which sequence id of the underlying database the view reflects. Default is false. 
126    private Boolean update_seq; 
127    */
128}