Struct tantivy::aggregation::DistributedAggregationCollector

pub struct DistributedAggregationCollector { /* private fields */ }

Collector for distributed aggregations.

The collector collects all aggregations by the underlying aggregation request.

Purpose

AggregationCollector returns IntermediateAggregationResults and not the final AggregationResults, so that results from different indices can be merged and then converted into the final AggregationResults via the into_final_result() method.

Implementations

impl DistributedAggregationCollector

pub fn from_aggs(agg: Aggregations, limits: AggregationLimits) -> Self

Create collector from aggregation request.

Aggregation fails when the limits in AggregationLimits is exceeded. (memory limit and bucket limit)

Trait Implementations

impl Collector for DistributedAggregationCollector

type Fruit = IntermediateAggregationResults

Fruit is the type for the result of our collection. e.g. usize for the Count collector.

type Child = AggregationSegmentCollector

Type of the SegmentCollector associated with this collector.

fn for_segment( &self, segment_local_id: SegmentOrdinal, reader: &SegmentReader ) -> Result<Self::Child>

set_segment is called before beginning to enumerate on this segment.

fn requires_scoring(&self) -> bool

Returns true iff the collector requires to compute scores for documents.

fn merge_fruits( &self, segment_fruits: Vec<<Self::Child as SegmentCollector>::Fruit> ) -> Result<Self::Fruit>

Combines the fruit associated with the collection of each segments into one fruit.

fn collect_segment( &self, weight: &dyn Weight, segment_ord: u32, reader: &SegmentReader ) -> Result<<Self::Child as SegmentCollector>::Fruit>

Created a segment collector and