pandagg.node.agg.bucket module

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

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

Bases: pandagg.node.agg.abstract.MultipleBucketAgg

KEY = 'date_histogram'
VALUE_ATTRS = ['doc_count']
WHITELISTED_MAPPING_TYPES = ['date']
get_filter(key)[source]

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

class pandagg.node.agg.bucket.DateRange(name, field, key_as_string=True, aggs=None, meta=None, **body)[source]

Bases: pandagg.node.agg.bucket.Range

KEY = 'date_range'
KEY_SEP = '::'
VALUE_ATTRS = ['doc_count']
WHITELISTED_MAPPING_TYPES = ['date']
class pandagg.node.agg.bucket.Filter(name, filter, meta=None, aggs=None, **body)[source]

Bases: pandagg.node.agg.abstract.UniqueBucketAgg

KEY = 'filter'
VALUE_ATTRS = ['doc_count']
get_filter(key)[source]

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

class pandagg.node.agg.bucket.Filters(name, filters, other_bucket=False, other_bucket_key=None, meta=None, aggs=None, **body)[source]

Bases: pandagg.node.agg.abstract.MultipleBucketAgg

DEFAULT_OTHER_KEY = '_other_'
IMPLICIT_KEYED = True
KEY = 'filters'
VALUE_ATTRS = ['doc_count']
get_filter(key)[source]

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

class pandagg.node.agg.bucket.Global(name, meta=None, aggs=None)[source]

Bases: pandagg.node.agg.abstract.UniqueBucketAgg

KEY = 'global'
VALUE_ATTRS = ['doc_count']
get_filter(key)[source]

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

class pandagg.node.agg.bucket.Histogram(name, field, interval, meta=None, aggs=None, **body)[source]

Bases: pandagg.node.agg.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)[source]

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

class pandagg.node.agg.bucket.MatchAll(name, meta=None, aggs=None)[source]

Bases: pandagg.node.agg.bucket.Filter

class pandagg.node.agg.bucket.Missing(name, field, meta=None, aggs=None, **body)[source]

Bases: pandagg.node.agg.abstract.UniqueBucketAgg

BLACKLISTED_MAPPING_TYPES = []
KEY = 'missing'
VALUE_ATTRS = ['doc_count']
get_filter(key)[source]

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

class pandagg.node.agg.bucket.Nested(name, path, meta=None, aggs=None)[source]

Bases: pandagg.node.agg.abstract.UniqueBucketAgg

KEY = 'nested'
VALUE_ATTRS = ['doc_count']
WHITELISTED_MAPPING_TYPES = ['nested']
get_filter(key)[source]

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

class pandagg.node.agg.bucket.Range(name, field, ranges, keyed=False, meta=None, aggs=None, **body)[source]

Bases: pandagg.node.agg.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)[source]

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

to_key
class pandagg.node.agg.bucket.ReverseNested(name, path=None, meta=None, aggs=None, **body)[source]

Bases: pandagg.node.agg.abstract.UniqueBucketAgg

KEY = 'reverse_nested'
VALUE_ATTRS = ['doc_count']
WHITELISTED_MAPPING_TYPES = ['nested']
get_filter(key)[source]

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

class pandagg.node.agg.bucket.Terms(name, field, missing=None, size=None, aggs=None, meta=None, **body)[source]

Bases: pandagg.node.agg.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)[source]

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