pandagg.node.aggs.bucket module

Not implemented aggregations include: - children agg - geo-distance - geo-hash grid - ipv4 - sampler - significant terms

class pandagg.node.aggs.bucket.Composite(keyed=None, key_path='key', meta=None, **body)

Bases: pandagg.node.aggs.abstract.MultipleBucketAgg

KEY = 'composite'

get_filter(key)

Provide filter to get documents belonging to document of given key.

class pandagg.node.aggs.bucket.DateHistogram(field, interval=None, calendar_interval=None, fixed_interval=None, meta=None, keyed=False, key_as_string=True, **body)

Bases: pandagg.node.aggs.abstract.MultipleBucketAgg

KEY = 'date_histogram'

VALUE_ATTRS = ['doc_count']

WHITELISTED_MAPPING_TYPES = ['date']

get_filter(key)

Provide filter to get documents belonging to document of given key.

class pandagg.node.aggs.bucket.DateRange(field, key_as_string=True, meta=None, **body)

Bases: pandagg.node.aggs.bucket.Range

KEY = 'date_range'

KEY_SEP = '::'

VALUE_ATTRS = ['doc_count']

WHITELISTED_MAPPING_TYPES = ['date']

class pandagg.node.aggs.bucket.Filter(filter=None, meta=None, **body)

Bases: pandagg.node.aggs.abstract.UniqueBucketAgg

KEY = 'filter'

VALUE_ATTRS = ['doc_count']

get_filter(key)

Provide filter to get documents belonging to document of given key.

class pandagg.node.aggs.bucket.Filters(filters, other_bucket=False, other_bucket_key=None, meta=None, **body)

Bases: pandagg.node.aggs.abstract.MultipleBucketAgg

DEFAULT_OTHER_KEY = '_other_'

IMPLICIT_KEYED = True

KEY = 'filters'

VALUE_ATTRS = ['doc_count']

get_filter(key)

Provide filter to get documents belonging to document of given key.

class pandagg.node.aggs.bucket.Global(meta=None)

Bases: pandagg.node.aggs.abstract.UniqueBucketAgg

KEY = 'global'

VALUE_ATTRS = ['doc_count']

get_filter(key)

Provide filter to get documents belonging to document of given key.

class pandagg.node.aggs.bucket.Histogram(field, interval, meta=None, **body)

Bases: pandagg.node.aggs.abstract.MultipleBucketAgg

KEY = 'histogram'

VALUE_ATTRS = ['doc_count']

WHITELISTED_MAPPING_TYPES = ['long', 'integer', 'short', 'byte', 'double', 'float', 'half_float', 'scaled_float', 'ip', 'token_count', 'date', 'boolean']

get_filter(key)

Provide filter to get documents belonging to document of given key.

class pandagg.node.aggs.bucket.MatchAll(meta=None, **body)

Bases: pandagg.node.aggs.bucket.Filter

class pandagg.node.aggs.bucket.Missing(field, meta=None, **body)

Bases: pandagg.node.aggs.abstract.UniqueBucketAgg

BLACKLISTED_MAPPING_TYPES = []

KEY = 'missing'

VALUE_ATTRS = ['doc_count']

get_filter(key)

Provide filter to get documents belonging to document of given key.

class pandagg.node.aggs.bucket.Nested(path, meta=None, **body)

Bases: pandagg.node.aggs.abstract.UniqueBucketAgg

KEY = 'nested'

VALUE_ATTRS = ['doc_count']

WHITELISTED_MAPPING_TYPES = ['nested']

get_filter(key)

Provide filter to get documents belonging to document of given key.

class pandagg.node.aggs.bucket.Range(field, ranges, keyed=False, meta=None, **body)

Bases: pandagg.node.aggs.abstract.MultipleBucketAgg

KEY = 'range'

KEY_SEP = '-'

VALUE_ATTRS = ['doc_count']

WHITELISTED_MAPPING_TYPES = ['long', 'integer', 'short', 'byte', 'double', 'float', 'half_float', 'scaled_float', 'ip', 'token_count', 'date', 'boolean']

from_key

get_filter(key)

Provide filter to get documents belonging to document of given key.

to_key

class pandagg.node.aggs.bucket.ReverseNested(path=None, meta=None, **body)

Bases: pandagg.node.aggs.abstract.UniqueBucketAgg

KEY = 'reverse_nested'

VALUE_ATTRS = ['doc_count']

WHITELISTED_MAPPING_TYPES = ['nested']

get_filter(key)

Provide filter to get documents belonging to document of given key.

class pandagg.node.aggs.bucket.Terms(field, missing=None, size=None, meta=None, **body)

Bases: pandagg.node.aggs.abstract.MultipleBucketAgg

Terms aggregation.

BLACKLISTED_MAPPING_TYPES = []

KEY = 'terms'

VALUE_ATTRS = ['doc_count', 'doc_count_error_upper_bound', 'sum_other_doc_count']

get_filter(key)

Provide filter to get documents belonging to document of given key.