object SearchSort
Base class for all FTS sort options in querying.
- Since
1.0.0
- Alphabetic
- By Inheritance
- SearchSort
- AnyRef
- Any
- Hide All
- Show All
- Public
- Protected
Type Members
- case class FieldSort(field: String, typ: Option[FieldSortType] = None, mode: Option[FieldSortMode] = None, missing: Option[FieldSortMissing] = None, descending: Option[Boolean] = None) extends SearchSort with Product with Serializable
Sort by a field in the rows.
Sort by a field in the rows.
- field
the name of the field to sort on
- typ
the type of the field. If left at the default
None
, it will default on the server toAuto
- mode
the sort mode. If left at the default
None
, it will default on the server toDefault
- missing
the missing mode. If left at the default
None
, it will default on the server toLast
- descending
whether the search results should be sorted in descending order. If None (the default) is specified, it is not sent and left to the server default.
- case class GeoDistanceSort(location: Seq[Float], field: String, descending: Option[Boolean] = None, unit: Option[String] = None) extends SearchSort with Product with Serializable
Sort by a geo location distance.
Sort by a geo location distance.
- location
should be a two-value Seq containing the longitude and latitude (in that order) to centre the search on
- field
the name of the field to sort on
- descending
whether the search results should be sorted in descending order. If None (the default) is specified, it is not sent and left to the server default.
- unit
the unit multipler to use for sorting. Acceptable values are: "inch", "yards", "feet", "kilometers", "nauticalmiles", "millimeters", "centimeters", "miles" and "meters". Standard abbreviations for those ("ft", "km", "mi") may also be used. If left at default
None
, it is not sent and left to the server default.
- Since
1.0.0
- case class IdSort(descending: Option[Boolean] = None) extends SearchSort with Product with Serializable
Sort by the document ID.
Sort by the document ID.
- descending
whether the search results should be sorted in descending order. If None (the default) is specified, it is not sent and left to the server default.
- Since
1.0.0
- case class ScoreSort(descending: Option[Boolean] = None) extends SearchSort with Product with Serializable
Sort by the hit score.
Sort by the hit score.
- descending
whether the search results should be sorted in descending order. If None (the default) is specified, it is not sent and left to the server default.
- Since
1.0.0
Value Members
- final def !=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def ##: Int
- Definition Classes
- AnyRef → Any
- final def ==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @IntrinsicCandidate() @native()
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def equals(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef → Any
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @IntrinsicCandidate() @native()
- def hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @IntrinsicCandidate() @native()
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- final def ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @IntrinsicCandidate() @native()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @IntrinsicCandidate() @native()
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- def toString(): String
- Definition Classes
- AnyRef → Any
- final def wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
Deprecated Value Members
- def finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.Throwable]) @Deprecated
- Deprecated
(Since version 9)