Packages

case class SearchOptions(limit: Option[Int] = None, skip: Option[Int] = None, explain: Option[Boolean] = None, highlightStyle: Option[HighlightStyle] = None, highlightFields: Option[Seq[String]] = None, fields: Option[Seq[String]] = None, sort: Option[JsonArray] = None, facets: Option[Map[String, SearchFacet]] = None, serverSideTimeout: Option[Duration] = None, deferredError: Option[RuntimeException] = None, scanConsistency: Option[SearchScanConsistency] = None, timeout: Option[Duration] = None, retryStrategy: Option[RetryStrategy] = None, parentSpan: Option[RequestSpan] = None, raw: Option[Map[String, Any]] = None) extends Product with Serializable

Options to be used with a Full Text Search query.

Linear Supertypes
Serializable, Serializable, Product, Equals, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. SearchOptions
  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 SearchOptions(limit: Option[Int] = None, skip: Option[Int] = None, explain: Option[Boolean] = None, highlightStyle: Option[HighlightStyle] = None, highlightFields: Option[Seq[String]] = None, fields: Option[Seq[String]] = None, sort: Option[JsonArray] = None, facets: Option[Map[String, SearchFacet]] = None, serverSideTimeout: Option[Duration] = None, deferredError: Option[RuntimeException] = None, scanConsistency: Option[SearchScanConsistency] = None, timeout: Option[Duration] = None, retryStrategy: Option[RetryStrategy] = None, parentSpan: Option[RequestSpan] = None, raw: Option[Map[String, Any]] = 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. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  7. def explain(value: Boolean): SearchOptions

    Activates the explanation of each result hit in the response.

    Activates the explanation of each result hit in the response. The default is false.

    returns

    this SearchOptions for chaining.

  8. def facets(facets: Map[String, SearchFacet]): SearchOptions

    Sets the search facets, which allow aggregating information collected on a particular result-set.

    Sets the search facets, which allow aggregating information collected on a particular result-set.

    facets

    the facets to use

    returns

    this SearchOptions for chaining.

  9. def fields(fields: Seq[String]): SearchOptions

    Configures the list of fields for which the whole value should be included in the response.

    Configures the list of fields for which the whole value should be included in the response. If empty, no field values are included.

    This drives the inclusion of the com.couchbase.client.scala.search.result.SearchRow.fieldsAs fields in each SearchRow hit.

    Note that to be highlighted, the fields must be stored in the FTS index.

    returns

    this SearchOptions for chaining.

  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 highlight(style: Option[HighlightStyle], fields: Option[Seq[String]]): SearchOptions

    Configures the highlighting of matches in the response.

    Configures the highlighting of matches in the response.

    Highlighting is disabled by default.

    This drives the inclusion of the fragments in each com.couchbase.client.scala.search.result.SearchRow row.

    Note that to be highlighted, the fields must be stored in the FTS index.

    Both style and fields are optional.

    style

    the HighlightStyle to apply.

    fields

    the optional fields on which to highlight. If none, all fields where there is a match are highlighted.

    returns

    this SearchOptions for chaining.

  13. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  14. def limit(limit: Int): SearchOptions

    Add a limit to the query on the number of rows it can return.

    Add a limit to the query on the number of rows it can return.

    If not set, the default is 10.

    limit

    the maximum number of rows to return.

    returns

    this SearchOptions for chaining.

  15. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  16. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  17. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  18. def parentSpan(value: RequestSpan): SearchOptions

    Sets the parent RequestSpan.

    Sets the parent RequestSpan.

    returns

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

    Annotations
    @Volatile()
  19. def raw(raw: Map[String, Any]): SearchOptions

    Allows providing custom JSON key/value pairs for advanced usage.

    Allows providing custom JSON key/value pairs for advanced usage.

    If available, it is recommended to use the methods on this object to customize the query. This method should only be used if no such setter can be found (i.e. if an undocumented property should be set or you are using an older client and a new server-configuration property has been added to the cluster).

    Note that the values will be passed through a JSON encoder, so do not provide already encoded JSON as the value. If you want to pass objects or arrays, you can use JsonObject and JsonArray respectively.

    returns

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

  20. def scanConsistency(scanConsistency: SearchScanConsistency): SearchOptions

    Sets the consistency to consider for this FTS query.

    Sets the consistency to consider for this FTS query. See SearchScanConsistency for documentation.

    returns

    this SearchOptions for chaining.

  21. def skip(skip: Int): SearchOptions

    Set the number of rows to skip (eg.

    Set the number of rows to skip (eg. for pagination).

    If not set, the default is 0.

    skip

    the number of results to skip.

    returns

    this SearchOptions for chaining.

  22. def sort(fields: Seq[SearchSort]): SearchOptions

    Configures the list of fields (including special fields) which are used for sorting purposes.

    Configures the list of fields (including special fields) which are used for sorting purposes. If empty, the default sorting (descending by score) is used by the server.

    See com.couchbase.client.scala.search.sort.SearchSort for the various sorting options.

    If no sort is provided, it is equal to sort("-_score"), since the server will sort it by score in descending order.

    fields

    the fields that should take part in the sorting.

    returns

    this SearchOptions for chaining.

  23. def sortByFields(fields: Seq[String]): SearchOptions

    Configures the list of fields (including special fields) which are used for sorting purposes.

    Configures the list of fields (including special fields) which are used for sorting purposes. If empty, the default sorting (descending by score) is used by the server.

    The list of sort fields can include actual fields (like "firstname" but then they must be stored in the index, configured in the server side mapping). Fields provided first are considered first and in a "tie" case the next sort field is considered. So sorting by "firstname" and then "lastname" will first sort ascending by the firstname and if the names are equal then sort ascending by lastname. Special fields like "_id" and "_score" can also be used. If prefixed with "-" the sort order is set to descending.

    If no sort is provided, it is equal to sort("-_score"), since the server will sort it by score in descending order.

    fields

    the fields that should take part in the sorting.

    returns

    this SearchOptions for chaining.

  24. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  25. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  26. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  27. 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