Packages

case class ViewOptions(namespace: Option[DesignDocumentNamespace] = None, reduce: Option[Boolean] = None, limit: Option[Int] = None, group: Option[Boolean] = None, groupLevel: Option[Int] = None, inclusiveEnd: Option[Boolean] = None, skip: Option[Int] = None, onError: Option[ViewErrorMode] = None, debug: Option[Boolean] = None, order: Option[ViewOrdering] = None, key: Option[String] = None, startKeyDocId: Option[String] = None, endKeyDocId: Option[String] = None, endKey: Option[String] = None, startKey: Option[String] = None, keys: Option[String] = None, retryStrategy: Option[RetryStrategy] = None, timeout: Option[Duration] = None, scanConsistency: Option[ViewScanConsistency] = None, parentSpan: Option[RequestSpan] = None) extends Product with Serializable

Customize the execution of a view.

Since

1.0.0

Linear Supertypes
Serializable, Serializable, Product, Equals, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. ViewOptions
  2. Serializable
  3. Serializable
  4. Product
  5. Equals
  6. AnyRef
  7. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new ViewOptions(namespace: Option[DesignDocumentNamespace] = None, reduce: Option[Boolean] = None, limit: Option[Int] = None, group: Option[Boolean] = None, groupLevel: Option[Int] = None, inclusiveEnd: Option[Boolean] = None, skip: Option[Int] = None, onError: Option[ViewErrorMode] = None, debug: Option[Boolean] = None, order: Option[ViewOrdering] = None, key: Option[String] = None, startKeyDocId: Option[String] = None, endKeyDocId: Option[String] = None, endKey: Option[String] = None, startKey: Option[String] = None, keys: Option[String] = None, retryStrategy: Option[RetryStrategy] = None, timeout: Option[Duration] = None, scanConsistency: Option[ViewScanConsistency] = None, parentSpan: Option[RequestSpan] = None)

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  6. def debug(value: Boolean): ViewOptions

    Enable debugging on view queries.

    Enable debugging on view queries.

    returns

    this for further chaining

  7. def endKey(value: Any): ViewOptions

    Specifies the key to stop returning results at.

    Specifies the key to stop returning results at.

    returns

    this for further chaining

  8. def endKeyDocId(value: String): ViewOptions

    Specifies the document id to stop returning results at within a number of results should endKey have multiple entries within the index.

    Specifies the document id to stop returning results at within a number of results should endKey have multiple entries within the index.

    returns

    this for further chaining

  9. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  10. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  11. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  12. def group(value: Boolean): ViewOptions

    Group the results using the reduce function to a group or single row.

    Group the results using the reduce function to a group or single row.

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

    returns

    this for further chaining

  13. def groupLevel(level: Int): ViewOptions

    Specifies the depth within the key to group results.

    Specifies the depth within the key to group results.

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

    returns

    this for further chaining

  14. def inclusiveEnd(value: Boolean): ViewOptions

    Specifies whether the specified end key should be included in the result.

    Specifies whether the specified end key should be included in the result.

    returns

    this for further chaining

  15. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  16. def key(value: Any): ViewOptions

    Specifies a specific key to fetch from the index.

    Specifies a specific key to fetch from the index.

    returns

    this for further chaining

  17. def keys(values: Iterable[Any]): ViewOptions

    Specifies a specific set of keys to fetch from the index.

    Specifies a specific set of keys to fetch from the index.

    returns

    this for further chaining

  18. def limit(value: Int): ViewOptions

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

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

    returns

    this for further chaining

  19. def namespace(value: DesignDocumentNamespace): ViewOptions

    Sets in which namespace the view exists.

    Sets in which namespace the view exists.

    returns

    this for further chaining

  20. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  21. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  22. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  23. def onError(value: ViewErrorMode): ViewOptions

    Sets the response in the event of an error.

    Sets the response in the event of an error.

    returns

    this for further chaining

  24. def order(value: ViewOrdering): ViewOptions

    Specifies the results ordering.

    Specifies the results ordering. See ViewOrdering for details.

    returns

    this for further chaining

  25. def parentSpan(value: RequestSpan): ViewOptions

    Sets the parent RequestSpan.

    Sets the parent RequestSpan.

    returns

    a copy of this with the change applied, for chaining.

    Annotations
    @Volatile()
  26. def reduce(value: Boolean): ViewOptions

    Explicitly enable/disable the reduce function on the query.

    Explicitly enable/disable the reduce function on the query.

    returns

    this for further chaining

  27. def retryStrategy(strategy: RetryStrategy): ViewOptions

    Sets what retry strategy to use if the operation fails.

    Sets what retry strategy to use if the operation fails.

    strategy

    the retry strategy to use

    returns

    a copy of this with the change applied, for chaining.

  28. def scanConsistency(scanConsistency: ViewScanConsistency): ViewOptions

    Sets what scan consistency to use.

    Sets what scan consistency to use. See ViewScanConsistency for details.

    scanConsistency

    the scan consistency to use

    returns

    a copy of this with the change applied, for chaining.

  29. def skip(value: Int): ViewOptions

    Skip this number of records before starting to return the results.

    Skip this number of records before starting to return the results.

    returns

    this for further chaining

  30. def startKey(value: Any): ViewOptions

    Specifies the key to skip to before beginning to return results.

    Specifies the key to skip to before beginning to return results.

    returns

    this for further chaining

  31. def startKeyDocId(value: String): ViewOptions

    Specifies the document id to start returning results at within a number of results should startKey have multiple entries within the index.

    Specifies the document id to start returning results at within a number of results should startKey have multiple entries within the index.

    returns

    this for further chaining

  32. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  33. def timeout(timeout: Duration): ViewOptions

    When to timeout the operation.

    When to timeout the operation.

    returns

    this for further chaining

  34. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  35. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  36. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Ungrouped