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 left to the server (which sorts descending by 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 left to the server (which sorts descending by 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 defaults on the server side to "meters".
- 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 left to the server (which sorts descending by 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 left to the server (which sorts descending by default)
- Since
1.0.0