Class ViewOptions

    • Method Detail

      • viewOptions

        public static ViewOptions viewOptions()
      • reduce

        public ViewOptions reduce​(boolean reduce)
        Explicitly enable/disable the reduce function on the query.
        Parameters:
        reduce - if reduce should be enabled or not.
        Returns:
        the ViewOptions object for proper chaining.
      • limit

        public ViewOptions limit​(int limit)
        Limit the number of the returned documents to the specified number.
        Parameters:
        limit - the number of documents to return.
        Returns:
        the ViewOptions object for proper chaining.
      • group

        public ViewOptions group​(boolean group)
        Group the results using the reduce function to a group or single row.

        Important: this setter and groupLevel(int) should not be used together in the same ViewOptions. It is sufficient to only set the grouping level only and use this setter in cases where you always want the highest group level implictly.

        Returns:
        the ViewOptions object for proper chaining.
      • groupLevel

        public ViewOptions groupLevel​(int grouplevel)
        Specify the group level to be used.

        Important: group(boolean) and this setter should not be used together in the same ViewOptions. It is sufficient to only use this setter and use group(boolean) in cases where you always want the highest group level implicitly.

        Parameters:
        grouplevel - How deep the grouping level should be.
        Returns:
        the ViewOptions object for proper chaining.
      • inclusiveEnd

        public ViewOptions inclusiveEnd​(boolean inclusive)
        Specifies whether the specified end key should be included in the result.
        Returns:
        the ViewOptions object for proper chaining.
      • skip

        public ViewOptions skip​(int skip)
        Skip this number of records before starting to return the results.
        Parameters:
        skip - The number of records to skip.
        Returns:
        the ViewOptions object for proper chaining.
      • scanConsistency

        public ViewOptions scanConsistency​(ViewScanConsistency scanConsistency)
        Sets the scan consistency (staleness) of a view query.
        Parameters:
        scanConsistency - Which consistency mode should be used.
        Returns:
        the ViewOptions object for proper chaining.
      • onError

        public ViewOptions onError​(ViewErrorMode viewErrorMode)
        Sets the response in the event of an error.

        See the "OnError" enum for more details on the available options.

        Parameters:
        viewErrorMode - The appropriate error handling type.
        Returns:
        the ViewOptions object for proper chaining.
      • debug

        public ViewOptions debug​(boolean debug)
        Enable debugging on view queries.
        Returns:
        the ViewOptions object for proper chaining.
      • startKey

        public ViewOptions startKey​(double key)
      • startKey

        public ViewOptions startKey​(boolean key)
      • toString

        public String toString()
        A string representation of this ViewQuery, suitable for logging and other human consumption. If the keys(JsonArray) parameter is too large, it is truncated in this dump.

        see the export() ()} for the parameter representation of the ViewQuery execution URL.

        Overrides:
        toString in class Object