Database.V1.Bloodhound.Internal.Sort

Documentation

type Sort = [SortSpec]

Sort is a synonym for a list of SortSpecs. Sort behavior is order dependent with later sorts acting as tie-breakers for earlier sorts.

data SortSpec

The two main kinds of SortSpec are DefaultSortSpec and GeoDistanceSortSpec. The latter takes a SortOrder, GeoPoint, and DistanceUnit to express "nearness" to a single geographical point as a sort specification.

http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/search-request-sort.html#search-request-sort

Constructors

DefaultSortSpec DefaultSort

GeoDistanceSortSpec SortOrder GeoPoint DistanceUnit

Instances

Eq SortSpec

Methods

(==) :: SortSpec -> SortSpec -> Bool

(/=) :: SortSpec -> SortSpec -> Bool

Show SortSpec

Methods

showsPrec :: Int -> SortSpec -> ShowS

show :: SortSpec -> String

showList :: [SortSpec] -> ShowS

ToJSON SortSpec

Methods

toJSON :: SortSpec -> Value

toEncoding :: SortSpec -> Encoding

toJSONList :: [SortSpec] -> Value

toEncodingList :: [SortSpec] -> Encoding

data DefaultSort

DefaultSort is usually the kind of SortSpec you'll want. There's a mkSort convenience function for when you want to specify only the most common parameters.

http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/search-request-sort.html#search-request-sort

Constructors

DefaultSort

Fields

• sortFieldName :: FieldName
• sortOrder :: SortOrder
• ignoreUnmapped :: Bool
• sortMode :: Maybe SortMode
• missingSort :: Maybe Missing
• nestedFilter :: Maybe Filter

Instances

Eq DefaultSort

Methods

(==) :: DefaultSort -> DefaultSort -> Bool

(/=) :: DefaultSort -> DefaultSort -> Bool

Show DefaultSort

Methods

showsPrec :: Int -> DefaultSort -> ShowS

show :: DefaultSort -> String

showList :: [DefaultSort] -> ShowS

data SortOrder

SortOrder is Ascending or Descending, as you might expect. These get encoded into "asc" or "desc" when turned into JSON.

http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/search-request-sort.html#search-request-sort

Constructors

Ascending

Descending

Instances

Eq SortOrder

Methods

(==) :: SortOrder -> SortOrder -> Bool

(/=) :: SortOrder -> SortOrder -> Bool

Show SortOrder

Methods

showsPrec :: Int -> SortOrder -> ShowS

show :: SortOrder -> String

showList :: [SortOrder] -> ShowS

ToJSON SortOrder

Methods

toJSON :: SortOrder -> Value

toEncoding :: SortOrder -> Encoding

toJSONList :: [SortOrder] -> Value

toEncodingList :: [SortOrder] -> Encoding

data SortMode

SortMode prescribes how to handle sorting array/multi-valued fields.

http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/search-request-sort.html#_sort_mode_option

Constructors

SortMin

SortMax

SortSum

SortAvg

Instances

Eq SortMode

Methods

(==) :: SortMode -> SortMode -> Bool

(/=) :: SortMode -> SortMode -> Bool

Show SortMode

Methods

showsPrec :: Int -> SortMode -> ShowS

show :: SortMode -> String

showList :: [SortMode] -> ShowS

ToJSON SortMode

Methods

toJSON :: SortMode -> Value

toEncoding :: SortMode -> Encoding

toJSONList :: [SortMode] -> Value

toEncodingList :: [SortMode] -> Encoding

data Missing

Missing prescribes how to handle missing fields. A missing field can be sorted last, first, or using a custom value as a substitute.

http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/search-request-sort.html#_missing_values

Constructors

LastMissing

FirstMissing

CustomMissing Text

Instances

Eq Missing

Methods

(==) :: Missing -> Missing -> Bool

(/=) :: Missing -> Missing -> Bool

Show Missing

Methods

showsPrec :: Int -> Missing -> ShowS

show :: Missing -> String

showList :: [Missing] -> ShowS

ToJSON Missing

Methods

toJSON :: Missing -> Value

toEncoding :: Missing -> Encoding

toJSONList :: [Missing] -> Value

toEncodingList :: [Missing] -> Encoding

mkSort :: FieldName -> SortOrder -> DefaultSort