Safe Haskell	None
Language	Haskell2010

Database.V1.Bloodhound.Internal.Aggregation

Synopsis

Documentation

type Aggregations = Map Text Aggregation Source #

emptyAggregations :: Aggregations Source #

mkAggregations :: Text -> Aggregation -> Aggregations Source #

data Aggregation Source #

Constructors

TermsAgg TermsAggregation
CardinalityAgg CardinalityAggregation
DateHistogramAgg DateHistogramAggregation
ValueCountAgg ValueCountAggregation
FilterAgg FilterAggregation
DateRangeAgg DateRangeAggregation
MissingAgg MissingAggregation
TopHitsAgg TopHitsAggregation

Instances

Eq Aggregation Source #
Methods (==) :: Aggregation -> Aggregation -> Bool # (/=) :: Aggregation -> Aggregation -> Bool #
Show Aggregation Source #
Methods showsPrec :: Int -> Aggregation -> ShowS # show :: Aggregation -> String # showList :: [Aggregation] -> ShowS #
ToJSON Aggregation Source #
Methods toJSON :: Aggregation -> Value # toEncoding :: Aggregation -> Encoding # toJSONList :: [Aggregation] -> Value # toEncodingList :: [Aggregation] -> Encoding #

data TopHitsAggregation Source #

Constructors

TopHitsAggregation
Fields taFrom :: Maybe From taSize :: Maybe Size taSort :: Maybe Sort

Instances

Eq TopHitsAggregation Source #
Methods (==) :: TopHitsAggregation -> TopHitsAggregation -> Bool # (/=) :: TopHitsAggregation -> TopHitsAggregation -> Bool #
Show TopHitsAggregation Source #
Methods showsPrec :: Int -> TopHitsAggregation -> ShowS # show :: TopHitsAggregation -> String # showList :: [TopHitsAggregation] -> ShowS #

data MissingAggregation Source #

Constructors

MissingAggregation
Fields maField :: Text

Instances

Eq MissingAggregation Source #
Methods (==) :: MissingAggregation -> MissingAggregation -> Bool # (/=) :: MissingAggregation -> MissingAggregation -> Bool #
Show MissingAggregation Source #
Methods showsPrec :: Int -> MissingAggregation -> ShowS # show :: MissingAggregation -> String # showList :: [MissingAggregation] -> ShowS #

data TermsAggregation Source #

Constructors

TermsAggregation
Fields term :: Either Text Text termInclude :: Maybe TermInclusion termExclude :: Maybe TermInclusion termOrder :: Maybe TermOrder termMinDocCount :: Maybe Int termSize :: Maybe Int termShardSize :: Maybe Int termCollectMode :: Maybe CollectionMode termExecutionHint :: Maybe ExecutionHint termAggs :: Maybe Aggregations

Instances

Eq TermsAggregation Source #
Methods (==) :: TermsAggregation -> TermsAggregation -> Bool # (/=) :: TermsAggregation -> TermsAggregation -> Bool #
Show TermsAggregation Source #
Methods showsPrec :: Int -> TermsAggregation -> ShowS # show :: TermsAggregation -> String # showList :: [TermsAggregation] -> ShowS #

data CardinalityAggregation Source #

Constructors

CardinalityAggregation
Fields cardinalityField :: FieldName precisionThreshold :: Maybe Int

Instances

Eq CardinalityAggregation Source #
Methods (==) :: CardinalityAggregation -> CardinalityAggregation -> Bool # (/=) :: CardinalityAggregation -> CardinalityAggregation -> Bool #
Show CardinalityAggregation Source #
Methods showsPrec :: Int -> CardinalityAggregation -> ShowS # show :: CardinalityAggregation -> String # showList :: [CardinalityAggregation] -> ShowS #

data DateHistogramAggregation Source #

Constructors

DateHistogramAggregation
Fields dateField :: FieldName dateInterval :: Interval dateFormat :: Maybe Text datePreZone :: Maybe Text datePostZone :: Maybe Text datePreOffset :: Maybe Text datePostOffset :: Maybe Text dateAggs :: Maybe Aggregations

Instances

Eq DateHistogramAggregation Source #
Methods (==) :: DateHistogramAggregation -> DateHistogramAggregation -> Bool # (/=) :: DateHistogramAggregation -> DateHistogramAggregation -> Bool #
Show DateHistogramAggregation Source #
Methods showsPrec :: Int -> DateHistogramAggregation -> ShowS # show :: DateHistogramAggregation -> String # showList :: [DateHistogramAggregation] -> ShowS #

data DateRangeAggregation Source #

Constructors

DateRangeAggregation
Fields draField :: FieldName draFormat :: Maybe Text draRanges :: NonEmpty DateRangeAggRange

Instances

Eq DateRangeAggregation Source #
Methods (==) :: DateRangeAggregation -> DateRangeAggregation -> Bool # (/=) :: DateRangeAggregation -> DateRangeAggregation -> Bool #
Show DateRangeAggregation Source #
Methods showsPrec :: Int -> DateRangeAggregation -> ShowS # show :: DateRangeAggregation -> String # showList :: [DateRangeAggregation] -> ShowS #
ToJSON DateRangeAggregation Source #
Methods toJSON :: DateRangeAggregation -> Value # toEncoding :: DateRangeAggregation -> Encoding # toJSONList :: [DateRangeAggregation] -> Value # toEncodingList :: [DateRangeAggregation] -> Encoding #

data DateRangeAggRange Source #

Constructors

DateRangeFrom DateMathExpr
DateRangeTo DateMathExpr
DateRangeFromAndTo DateMathExpr DateMathExpr

Instances

Eq DateRangeAggRange Source #
Methods (==) :: DateRangeAggRange -> DateRangeAggRange -> Bool # (/=) :: DateRangeAggRange -> DateRangeAggRange -> Bool #
Show DateRangeAggRange Source #
Methods showsPrec :: Int -> DateRangeAggRange -> ShowS # show :: DateRangeAggRange -> String # showList :: [DateRangeAggRange] -> ShowS #
ToJSON DateRangeAggRange Source #
Methods toJSON :: DateRangeAggRange -> Value # toEncoding :: DateRangeAggRange -> Encoding # toJSONList :: [DateRangeAggRange] -> Value # toEncodingList :: [DateRangeAggRange] -> Encoding #

data ValueCountAggregation Source #

See https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-metrics-valuecount-aggregation.html for more information.

Constructors

FieldValueCount FieldName
ScriptValueCount Script

Instances

Eq ValueCountAggregation Source #
Methods (==) :: ValueCountAggregation -> ValueCountAggregation -> Bool # (/=) :: ValueCountAggregation -> ValueCountAggregation -> Bool #
Show ValueCountAggregation Source #
Methods showsPrec :: Int -> ValueCountAggregation -> ShowS # show :: ValueCountAggregation -> String # showList :: [ValueCountAggregation] -> ShowS #

data FilterAggregation Source #

Single-bucket filter aggregations. See https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-bucket-filter-aggregation.html#search-aggregations-bucket-filter-aggregation for more information.

Constructors

FilterAggregation
Fields faFilter :: Filter faAggs :: Maybe Aggregations

Instances

Eq FilterAggregation Source #
Methods (==) :: FilterAggregation -> FilterAggregation -> Bool # (/=) :: FilterAggregation -> FilterAggregation -> Bool #
Show FilterAggregation Source #
Methods showsPrec :: Int -> FilterAggregation -> ShowS # show :: FilterAggregation -> String # showList :: [FilterAggregation] -> ShowS #

mkTermsAggregation :: Text -> TermsAggregation Source #

mkTermsScriptAggregation :: Text -> TermsAggregation Source #

mkDateHistogram :: FieldName -> Interval -> DateHistogramAggregation Source #

mkCardinalityAggregation :: FieldName -> CardinalityAggregation Source #

data TermInclusion Source #

Constructors

TermInclusion Text
TermPattern Text Text

Instances

Eq TermInclusion Source #
Methods (==) :: TermInclusion -> TermInclusion -> Bool # (/=) :: TermInclusion -> TermInclusion -> Bool #
Show TermInclusion Source #
Methods showsPrec :: Int -> TermInclusion -> ShowS # show :: TermInclusion -> String # showList :: [TermInclusion] -> ShowS #
ToJSON TermInclusion Source #
Methods toJSON :: TermInclusion -> Value # toEncoding :: TermInclusion -> Encoding # toJSONList :: [TermInclusion] -> Value # toEncodingList :: [TermInclusion] -> Encoding #

data TermOrder Source #

Constructors

TermOrder
Fields termSortField :: Text termSortOrder :: SortOrder

Instances

Eq TermOrder Source #
Methods (==) :: TermOrder -> TermOrder -> Bool # (/=) :: TermOrder -> TermOrder -> Bool #
Show TermOrder Source #
Methods showsPrec :: Int -> TermOrder -> ShowS # show :: TermOrder -> String # showList :: [TermOrder] -> ShowS #
ToJSON TermOrder Source #
Methods toJSON :: TermOrder -> Value # toEncoding :: TermOrder -> Encoding # toJSONList :: [TermOrder] -> Value # toEncodingList :: [TermOrder] -> Encoding #

data ExecutionHint Source #

Constructors

Ordinals
GlobalOrdinals
GlobalOrdinalsHash
GlobalOrdinalsLowCardinality
Map

Instances

Eq ExecutionHint Source #
Methods (==) :: ExecutionHint -> ExecutionHint -> Bool # (/=) :: ExecutionHint -> ExecutionHint -> Bool #
Show ExecutionHint Source #
Methods showsPrec :: Int -> ExecutionHint -> ShowS # show :: ExecutionHint -> String # showList :: [ExecutionHint] -> ShowS #
ToJSON ExecutionHint Source #
Methods toJSON :: ExecutionHint -> Value # toEncoding :: ExecutionHint -> Encoding # toJSONList :: [ExecutionHint] -> Value # toEncodingList :: [ExecutionHint] -> Encoding #

data DateMathExpr Source #

See https://www.elastic.co/guide/en/elasticsearch/reference/current/common-options.html#date-math for more information.

Constructors

DateMathExpr DateMathAnchor [DateMathModifier]

Instances

Eq DateMathExpr Source #
Methods (==) :: DateMathExpr -> DateMathExpr -> Bool # (/=) :: DateMathExpr -> DateMathExpr -> Bool #
Show DateMathExpr Source #
Methods showsPrec :: Int -> DateMathExpr -> ShowS # show :: DateMathExpr -> String # showList :: [DateMathExpr] -> ShowS #
ToJSON DateMathExpr Source #
Methods toJSON :: DateMathExpr -> Value # toEncoding :: DateMathExpr -> Encoding # toJSONList :: [DateMathExpr] -> Value # toEncodingList :: [DateMathExpr] -> Encoding #

data DateMathAnchor Source #

Starting point for a date range. This along with the DateMathModifiers gets you the date ES will start from.

Constructors

DMNow
DMDate Day

Instances

Eq DateMathAnchor Source #
Methods (==) :: DateMathAnchor -> DateMathAnchor -> Bool # (/=) :: DateMathAnchor -> DateMathAnchor -> Bool #
Show DateMathAnchor Source #
Methods showsPrec :: Int -> DateMathAnchor -> ShowS # show :: DateMathAnchor -> String # showList :: [DateMathAnchor] -> ShowS #

data DateMathModifier Source #

Constructors

AddTime Int DateMathUnit
SubtractTime Int DateMathUnit
RoundDownTo DateMathUnit

Instances

Eq DateMathModifier Source #
Methods (==) :: DateMathModifier -> DateMathModifier -> Bool # (/=) :: DateMathModifier -> DateMathModifier -> Bool #
Show DateMathModifier Source #
Methods showsPrec :: Int -> DateMathModifier -> ShowS # show :: DateMathModifier -> String # showList :: [DateMathModifier] -> ShowS #

data DateMathUnit Source #

Constructors

DMYear
DMMonth
DMWeek
DMDay
DMHour
DMMinute
DMSecond

Instances

Eq DateMathUnit Source #
Methods (==) :: DateMathUnit -> DateMathUnit -> Bool # (/=) :: DateMathUnit -> DateMathUnit -> Bool #
Show DateMathUnit Source #
Methods showsPrec :: Int -> DateMathUnit -> ShowS # show :: DateMathUnit -> String # showList :: [DateMathUnit] -> ShowS #

data CollectionMode Source #

Constructors

BreadthFirst
DepthFirst

Instances

Eq CollectionMode Source #
Methods (==) :: CollectionMode -> CollectionMode -> Bool # (/=) :: CollectionMode -> CollectionMode -> Bool #
Show CollectionMode Source #
Methods showsPrec :: Int -> CollectionMode -> ShowS # show :: CollectionMode -> String # showList :: [CollectionMode] -> ShowS #
ToJSON CollectionMode Source #
Methods toJSON :: CollectionMode -> Value # toEncoding :: CollectionMode -> Encoding # toJSONList :: [CollectionMode] -> Value # toEncodingList :: [CollectionMode] -> Encoding #

type AggregationResults = Map Text Value Source #

class BucketAggregation a where Source #

Minimal complete definition

key, docCount, aggs

Methods

key :: a -> BucketValue Source #

docCount :: a -> Int Source #

aggs :: a -> Maybe AggregationResults Source #

Instances

BucketAggregation DateRangeResult Source #
Methods key :: DateRangeResult -> BucketValue Source # docCount :: DateRangeResult -> Int Source # aggs :: DateRangeResult -> Maybe AggregationResults Source #
BucketAggregation DateHistogramResult Source #
Methods key :: DateHistogramResult -> BucketValue Source # docCount :: DateHistogramResult -> Int Source # aggs :: DateHistogramResult -> Maybe AggregationResults Source #
BucketAggregation TermsResult Source #
Methods key :: TermsResult -> BucketValue Source # docCount :: TermsResult -> Int Source # aggs :: TermsResult -> Maybe AggregationResults Source #

data BucketValue Source #

Constructors

TextValue Text
ScientificValue Scientific
BoolValue Bool

Instances

Show BucketValue Source #
Methods showsPrec :: Int -> BucketValue -> ShowS # show :: BucketValue -> String # showList :: [BucketValue] -> ShowS #
FromJSON BucketValue Source #
Methods parseJSON :: Value -> Parser BucketValue # parseJSONList :: Value -> Parser [BucketValue] #

data Bucket a Source #

Constructors

Bucket
Fields buckets :: [a]

Instances

Show a => Show (Bucket a) Source #
Methods showsPrec :: Int -> Bucket a -> ShowS # show :: Bucket a -> String # showList :: [Bucket a] -> ShowS #
FromJSON a => FromJSON (Bucket a) Source #
Methods parseJSON :: Value -> Parser (Bucket a) # parseJSONList :: Value -> Parser [Bucket a] #

data TermsResult Source #

Constructors

TermsResult
Fields termKey :: BucketValue termsDocCount :: Int termsAggs :: Maybe AggregationResults

Instances

Show TermsResult Source #
Methods showsPrec :: Int -> TermsResult -> ShowS # show :: TermsResult -> String # showList :: [TermsResult] -> ShowS #
FromJSON TermsResult Source #
Methods parseJSON :: Value -> Parser TermsResult # parseJSONList :: Value -> Parser [TermsResult] #
BucketAggregation TermsResult Source #
Methods key :: TermsResult -> BucketValue Source # docCount :: TermsResult -> Int Source # aggs :: TermsResult -> Maybe AggregationResults Source #

data DateHistogramResult Source #

Constructors

DateHistogramResult
Fields dateKey :: Int dateKeyStr :: Maybe Text dateDocCount :: Int dateHistogramAggs :: Maybe AggregationResults

Instances

Show DateHistogramResult Source #
Methods showsPrec :: Int -> DateHistogramResult -> ShowS # show :: DateHistogramResult -> String # showList :: [DateHistogramResult] -> ShowS #
FromJSON DateHistogramResult Source #
Methods parseJSON :: Value -> Parser DateHistogramResult # parseJSONList :: Value -> Parser [DateHistogramResult] #
BucketAggregation DateHistogramResult Source #
Methods key :: DateHistogramResult -> BucketValue Source # docCount :: DateHistogramResult -> Int Source # aggs :: DateHistogramResult -> Maybe AggregationResults Source #

data DateRangeResult Source #

Constructors

DateRangeResult
Fields dateRangeKey :: Text dateRangeFrom :: Maybe UTCTime dateRangeFromAsString :: Maybe Text dateRangeTo :: Maybe UTCTime dateRangeToAsString :: Maybe Text dateRangeDocCount :: Int dateRangeAggs :: Maybe AggregationResults

Instances

Eq DateRangeResult Source #
Methods (==) :: DateRangeResult -> DateRangeResult -> Bool # (/=) :: DateRangeResult -> DateRangeResult -> Bool #
Show DateRangeResult Source #
Methods showsPrec :: Int -> DateRangeResult -> ShowS # show :: DateRangeResult -> String # showList :: [DateRangeResult] -> ShowS #
FromJSON DateRangeResult Source #
Methods parseJSON :: Value -> Parser DateRangeResult # parseJSONList :: Value -> Parser [DateRangeResult] #
BucketAggregation DateRangeResult Source #
Methods key :: DateRangeResult -> BucketValue Source # docCount :: DateRangeResult -> Int Source # aggs :: DateRangeResult -> Maybe AggregationResults Source #

toTerms :: Text -> AggregationResults -> Maybe (Bucket TermsResult) Source #

toDateHistogram :: Text -> AggregationResults -> Maybe (Bucket DateHistogramResult) Source #

toMissing :: Text -> AggregationResults -> Maybe MissingResult Source #

toTopHits :: FromJSON a => Text -> AggregationResults -> Maybe (TopHitResult a) Source #

toAggResult :: FromJSON a => Text -> AggregationResults -> Maybe a Source #

data MissingResult Source #

Constructors

MissingResult
Fields missingDocCount :: Int

Instances

Show MissingResult Source #
Methods showsPrec :: Int -> MissingResult -> ShowS # show :: MissingResult -> String # showList :: [MissingResult] -> ShowS #
FromJSON MissingResult Source #
Methods parseJSON :: Value -> Parser MissingResult # parseJSONList :: Value -> Parser [MissingResult] #

data TopHitResult a Source #

Constructors

TopHitResult
Fields tarHits :: SearchHits a

Instances

Show a => Show (TopHitResult a) Source #
Methods showsPrec :: Int -> TopHitResult a -> ShowS # show :: TopHitResult a -> String # showList :: [TopHitResult a] -> ShowS #
FromJSON a => FromJSON (TopHitResult a) Source #
Methods parseJSON :: Value -> Parser (TopHitResult a) # parseJSONList :: Value -> Parser [TopHitResult a] #

data SearchHits a Source #

Constructors

SearchHits
Fields hitsTotal :: Int maxScore :: Score hits :: [Hit a]

Instances

Eq a => Eq (SearchHits a) Source #
Methods (==) :: SearchHits a -> SearchHits a -> Bool # (/=) :: SearchHits a -> SearchHits a -> Bool #
Show a => Show (SearchHits a) Source #
Methods showsPrec :: Int -> SearchHits a -> ShowS # show :: SearchHits a -> String # showList :: [SearchHits a] -> ShowS #
Semigroup (SearchHits a) Source #
Methods (<>) :: SearchHits a -> SearchHits a -> SearchHits a # sconcat :: NonEmpty (SearchHits a) -> SearchHits a # stimes :: Integral b => b -> SearchHits a -> SearchHits a #
Monoid (SearchHits a) Source #
Methods mempty :: SearchHits a # mappend :: SearchHits a -> SearchHits a -> SearchHits a # mconcat :: [SearchHits a] -> SearchHits a #
FromJSON a => FromJSON (SearchHits a) Source #
Methods parseJSON :: Value -> Parser (SearchHits a) # parseJSONList :: Value -> Parser [SearchHits a] #

data Hit a Source #

Constructors

Hit
Fields hitIndex :: IndexName hitType :: MappingName hitDocId :: DocId hitScore :: Score hitSource :: Maybe a hitHighlight :: Maybe HitHighlight

Instances

Eq a => Eq (Hit a) Source #
Methods (==) :: Hit a -> Hit a -> Bool # (/=) :: Hit a -> Hit a -> Bool #
Show a => Show (Hit a) Source #
Methods showsPrec :: Int -> Hit a -> ShowS # show :: Hit a -> String # showList :: [Hit a] -> ShowS #
FromJSON a => FromJSON (Hit a) Source #
Methods parseJSON :: Value -> Parser (Hit a) # parseJSONList :: Value -> Parser [Hit a] #

getNamedSubAgg :: Object -> [Text] -> Maybe AggregationResults Source #