pandagg.query module

class pandagg.query.Query(from_=None, mapping=None, identifier=None, client=None, index_name=None)

Bases: pandagg.tree._tree.Tree

Tree combination of query nodes.

Mapping declaration is optional, but doing so validates query validity.

add_node(node, pid=None)

Add a new node object to the tree and make the parent as the root by default.

The ‘node’ parameter refers to an instance of Class::Node.

bind(client, index_name=None)

bool(*args, **kwargs)

boost(*args, **kwargs)

constant_score(*args, **kwargs)

classmethod deserialize(from_)

dis_max(*args, **kwargs)

execute(index=None, **kwargs)

filter(*args, **kwargs)

function_score(*args, **kwargs)

has_child(*args, **kwargs)

has_parent(*args, **kwargs)

must(*args, **kwargs)

must_not(*args, **kwargs)

nested(*args, **kwargs)

node_class

alias of pandagg.node.query.abstract.QueryClause

parent_id(*args, **kwargs)

pinned_query(*args, **kwargs)

query(q, parent=None, child=None, parent_param=None, child_param=None, mode='add')

Place query below a given parent.

query_dict(from_=None, named=False)

Return None if no query clause.

script_score(*args, **kwargs)

set_mapping(mapping)

should(*args, **kwargs)

class pandagg.query.Exists(field, _name=None)

Bases: pandagg.node.query.abstract.LeafQueryClause

KEY = 'exists'

tag

The readable node name for human. This attribute can be accessed and modified with . and = operator respectively.

class pandagg.query.Fuzzy(field, _name=None, **body)

Bases: pandagg.node.query.abstract.SingleFieldQueryClause

KEY = 'fuzzy'

class pandagg.query.Ids(values, _name=None)

Bases: pandagg.node.query.abstract.LeafQueryClause

KEY = 'ids'

serialize(named=False)

tag

The readable node name for human. This attribute can be accessed and modified with . and = operator respectively.

class pandagg.query.Prefix(field, _name=None, **body)

Bases: pandagg.node.query.abstract.SingleFieldQueryClause

KEY = 'prefix'

class pandagg.query.Range(field, _name=None, **body)

Bases: pandagg.node.query.abstract.SingleFieldQueryClause

KEY = 'range'

class pandagg.query.Regexp(field, _name=None, **body)

Bases: pandagg.node.query.abstract.SingleFieldQueryClause

KEY = 'regexp'

class pandagg.query.Term(field, value, _name=None, **body)

Bases: pandagg.node.query.abstract.SingleFieldQueryClause

KEY = 'term'

SHORT_TAG = 'value'

class pandagg.query.Terms(field, terms, _name=None, **body)

Bases: pandagg.node.query.abstract.LeafQueryClause

KEY = 'terms'

classmethod deserialize(**body)

tag

The readable node name for human. This attribute can be accessed and modified with . and = operator respectively.

class pandagg.query.TermsSet(field, _name=None, **body)

Bases: pandagg.node.query.abstract.SingleFieldQueryClause

KEY = 'terms_set'

class pandagg.query.Type(field, _name=None, **body)

Bases: pandagg.node.query.abstract.SingleFieldQueryClause

KEY = 'type'

class pandagg.query.Wildcard(field, _name=None, **body)

Bases: pandagg.node.query.abstract.SingleFieldQueryClause

KEY = 'wildcard'

class pandagg.query.Intervals(field, _name=None, **body)

Bases: pandagg.node.query.abstract.SingleFieldQueryClause

KEY = 'intervals'

class pandagg.query.Match(field, _name=None, **body)

Bases: pandagg.node.query.abstract.SingleFieldQueryClause

KEY = 'match'

SHORT_TAG = 'query'

class pandagg.query.MatchBoolPrefix(field, _name=None, **body)

Bases: pandagg.node.query.abstract.SingleFieldQueryClause

KEY = 'match_bool_prefix'

SHORT_TAG = 'query'

class pandagg.query.MatchPhrase(field, _name=None, **body)

Bases: pandagg.node.query.abstract.SingleFieldQueryClause

KEY = 'match_phrase'

SHORT_TAG = 'query'

class pandagg.query.MatchPhrasePrefix(field, _name=None, **body)

Bases: pandagg.node.query.abstract.SingleFieldQueryClause

KEY = 'match_phrase_prefix'

SHORT_TAG = 'query'

class pandagg.query.MultiMatch(fields, _name=None, **body)

Bases: pandagg.node.query.abstract.MultiFieldsQueryClause

KEY = 'multi_match'

class pandagg.query.Common(field, _name=None, **body)

Bases: pandagg.node.query.abstract.SingleFieldQueryClause

KEY = 'common'

class pandagg.query.QueryString(_name=None, **body)

Bases: pandagg.node.query.abstract.LeafQueryClause

KEY = 'query_string'

class pandagg.query.SimpleQueryString(_name=None, **body)

Bases: pandagg.node.query.abstract.LeafQueryClause

KEY = 'simple_string'

class pandagg.query.Bool(*args, **kwargs)

Bases: pandagg.node.query.compound.CompoundClause

DEFAULT_OPERATOR

alias of pandagg.node.query._parameter_clause.Must

KEY = 'bool'

PARAMS_WHITELIST = ['should', 'must', 'must_not', 'filter', 'boost', 'minimum_should_match']

class pandagg.query.Boosting(*args, **kwargs)

Bases: pandagg.node.query.compound.CompoundClause

DEFAULT_OPERATOR

alias of pandagg.node.query._parameter_clause.Positive

KEY = 'boosting'

PARAMS_WHITELIST = ['positive', 'negative', 'negative_boost']

class pandagg.query.ConstantScore(*args, **kwargs)

Bases: pandagg.node.query.compound.CompoundClause

DEFAULT_OPERATOR

alias of pandagg.node.query._parameter_clause.Filter

KEY = 'constant_score'

PARAMS_WHITELIST = ['filter', 'boost']

class pandagg.query.FunctionScore(*args, **kwargs)

Bases: pandagg.node.query.compound.CompoundClause

DEFAULT_OPERATOR

alias of pandagg.node.query._parameter_clause.QueryP

KEY = 'function_score'

PARAMS_WHITELIST = ['query', 'boost', 'random_score', 'boost_mode', 'functions', 'max_boost', 'score_mode', 'min_score']

class pandagg.query.DisMax(*args, **kwargs)

Bases: pandagg.node.query.compound.CompoundClause

DEFAULT_OPERATOR

alias of pandagg.node.query._parameter_clause.Queries

KEY = 'dis_max'

PARAMS_WHITELIST = ['queries', 'tie_breaker']

class pandagg.query.Nested(*args, **kwargs)

Bases: pandagg.node.query.compound.CompoundClause

DEFAULT_OPERATOR

alias of pandagg.node.query._parameter_clause.QueryP

KEY = 'nested'

PARAMS_WHITELIST = ['path', 'query', 'score_mode', 'ignore_unmapped']

class pandagg.query.HasParent(*args, **kwargs)

Bases: pandagg.node.query.compound.CompoundClause

DEFAULT_OPERATOR

alias of pandagg.node.query._parameter_clause.QueryP

KEY = 'has_parent'

PARAMS_WHITELIST = ['query', 'parent_type', 'score', 'ignore_unmapped']

class pandagg.query.HasChild(*args, **kwargs)

Bases: pandagg.node.query.compound.CompoundClause

DEFAULT_OPERATOR

alias of pandagg.node.query._parameter_clause.QueryP

KEY = 'has_child'

PARAMS_WHITELIST = ['query', 'type', 'max_children', 'min_children', 'score_mode', 'ignore_unmapped']

class pandagg.query.ParentId(*args, **kwargs)

Bases: pandagg.node.query.compound.CompoundClause

KEY = 'parent_id'

class pandagg.query.Shape(_name=None, **body)

Bases: pandagg.node.query.abstract.LeafQueryClause

KEY = 'shape'

class pandagg.query.GeoShape(field, _name=None, **body)

Bases: pandagg.node.query.abstract.SingleFieldQueryClause

KEY = 'geo_shape'

class pandagg.query.GeoPolygone(field, _name=None, **body)

Bases: pandagg.node.query.abstract.SingleFieldQueryClause

KEY = 'geo_polygon'

class pandagg.query.GeoDistance(field, location, distance, _name=None, **body)

Bases: pandagg.node.query.abstract.LeafQueryClause

KEY = 'geo_distance'

classmethod deserialize(**body)

tag

The readable node name for human. This attribute can be accessed and modified with . and = operator respectively.

class pandagg.query.GeoBoundingBox(field, _name=None, **body)

Bases: pandagg.node.query.abstract.SingleFieldQueryClause

KEY = 'geo_bounding_box'

class pandagg.query.DistanceFeature(field, _name=None, **body)

Bases: pandagg.node.query.abstract.SingleFieldQueryClause

FLAT = True

KEY = 'distance_feature'

class pandagg.query.MoreLikeThis(fields, _name=None, **body)

Bases: pandagg.node.query.abstract.MultiFieldsQueryClause

KEY = 'more_like_this'

class pandagg.query.Percolate(field, _name=None, **body)

Bases: pandagg.node.query.abstract.SingleFieldQueryClause

FLAT = True

KEY = 'percolate'

class pandagg.query.RankFeature(field, _name=None, **body)

Bases: pandagg.node.query.abstract.SingleFieldQueryClause

FLAT = True

KEY = 'rank_feature'

class pandagg.query.Script(_name=None, **body)

Bases: pandagg.node.query.abstract.LeafQueryClause

KEY = 'script'

class pandagg.query.Wrapper(_name=None, **body)

Bases: pandagg.node.query.abstract.LeafQueryClause

KEY = 'wrapper'

class pandagg.query.ScriptScore(*args, **kwargs)

Bases: pandagg.node.query.compound.CompoundClause

DEFAULT_OPERATOR

alias of pandagg.node.query._parameter_clause.QueryP

KEY = 'script_score'

PARAMS_WHITELIST = ['query', 'script', 'min_score']

class pandagg.query.PinnedQuery(*args, **kwargs)

Bases: pandagg.node.query.compound.CompoundClause

DEFAULT_OPERATOR

alias of pandagg.node.query._parameter_clause.Organic

KEY = 'pinned'

PARAMS_WHITELIST = ['ids', 'organic']