pandagg.mapping module¶
-
class
pandagg.mapping.
Mapping
(*args, **kwargs)[source]¶ Bases:
pandagg.tree._tree.Tree
-
KEY
= None¶
-
get
(key)[source]¶ Get a node by its id. :param nid: str, identifier of node to fetch :rtype: lighttree.node.Node
-
node_class
¶ alias of
pandagg.node.mapping.abstract.Field
-
validate_agg_node
(agg_node, exc=True)[source]¶ Ensure if node has field or path that it exists in mapping, and that required aggregation type if allowed on this kind of field. :param agg_node: AggNode you want to validate on this mapping :param exc: boolean, if set to True raise exception if invalid :rtype: boolean
-
-
class
pandagg.mapping.
IMapping
(*args, **kwargs)[source]¶ Bases:
lighttree.interactive.TreeBasedObj
Interactive wrapper upon mapping tree, allowing field navigation and quick access to single clause aggregations computation.
-
class
pandagg.mapping.
Text
(**body)[source]¶ Bases:
pandagg.node.mapping.abstract.UnnamedRegularField
-
KEY
= 'text'¶
-
-
class
pandagg.mapping.
Keyword
(**body)[source]¶ Bases:
pandagg.node.mapping.abstract.UnnamedRegularField
-
KEY
= 'keyword'¶
-
-
class
pandagg.mapping.
Long
(**body)[source]¶ Bases:
pandagg.node.mapping.abstract.UnnamedRegularField
-
KEY
= 'long'¶
-
-
class
pandagg.mapping.
Integer
(**body)[source]¶ Bases:
pandagg.node.mapping.abstract.UnnamedRegularField
-
KEY
= 'integer'¶
-
-
class
pandagg.mapping.
Short
(**body)[source]¶ Bases:
pandagg.node.mapping.abstract.UnnamedRegularField
-
KEY
= 'short'¶
-
-
class
pandagg.mapping.
Byte
(**body)[source]¶ Bases:
pandagg.node.mapping.abstract.UnnamedRegularField
-
KEY
= 'byte'¶
-
-
class
pandagg.mapping.
Double
(**body)[source]¶ Bases:
pandagg.node.mapping.abstract.UnnamedRegularField
-
KEY
= 'double'¶
-
-
class
pandagg.mapping.
HalfFloat
(**body)[source]¶ Bases:
pandagg.node.mapping.abstract.UnnamedRegularField
-
KEY
= 'half_float'¶
-
-
class
pandagg.mapping.
ScaledFloat
(**body)[source]¶ Bases:
pandagg.node.mapping.abstract.UnnamedRegularField
-
KEY
= 'scaled_float'¶
-
-
class
pandagg.mapping.
Date
(**body)[source]¶ Bases:
pandagg.node.mapping.abstract.UnnamedRegularField
-
KEY
= 'date'¶
-
-
class
pandagg.mapping.
DateNanos
(**body)[source]¶ Bases:
pandagg.node.mapping.abstract.UnnamedRegularField
-
KEY
= 'date_nanos'¶
-
-
class
pandagg.mapping.
Boolean
(**body)[source]¶ Bases:
pandagg.node.mapping.abstract.UnnamedRegularField
-
KEY
= 'boolean'¶
-
-
class
pandagg.mapping.
Binary
(**body)[source]¶ Bases:
pandagg.node.mapping.abstract.UnnamedRegularField
-
KEY
= 'binary'¶
-
-
class
pandagg.mapping.
IntegerRange
(**body)[source]¶ Bases:
pandagg.node.mapping.abstract.UnnamedRegularField
-
KEY
= 'integer_range'¶
-
-
class
pandagg.mapping.
Float
(**body)[source]¶ Bases:
pandagg.node.mapping.abstract.UnnamedRegularField
-
KEY
= 'float'¶
-
-
class
pandagg.mapping.
FloatRange
(**body)[source]¶ Bases:
pandagg.node.mapping.abstract.UnnamedRegularField
-
KEY
= 'float_range'¶
-
-
class
pandagg.mapping.
LongRange
(**body)[source]¶ Bases:
pandagg.node.mapping.abstract.UnnamedRegularField
-
KEY
= 'long_range'¶
-
-
class
pandagg.mapping.
DoubleRange
(**body)[source]¶ Bases:
pandagg.node.mapping.abstract.UnnamedRegularField
-
KEY
= 'double_range'¶
-
-
class
pandagg.mapping.
DateRange
(**body)[source]¶ Bases:
pandagg.node.mapping.abstract.UnnamedRegularField
-
KEY
= 'date_range'¶
-
-
class
pandagg.mapping.
Object
(**body)[source]¶ Bases:
pandagg.node.mapping.abstract.UnnamedComplexField
-
KEY
= 'object'¶
-
-
class
pandagg.mapping.
Nested
(**body)[source]¶ Bases:
pandagg.node.mapping.abstract.UnnamedComplexField
-
KEY
= 'nested'¶
-
-
class
pandagg.mapping.
GeoPoint
(**body)[source]¶ Bases:
pandagg.node.mapping.abstract.UnnamedRegularField
For lat/lon points
-
KEY
= 'geo_point'¶
-
-
class
pandagg.mapping.
GeoShape
(**body)[source]¶ Bases:
pandagg.node.mapping.abstract.UnnamedRegularField
For complex shapes like polygons
-
KEY
= 'geo_shape'¶
-
-
class
pandagg.mapping.
IP
(**body)[source]¶ Bases:
pandagg.node.mapping.abstract.UnnamedRegularField
for IPv4 and IPv6 addresses
-
KEY
= 'IP'¶
-
-
class
pandagg.mapping.
Completion
(**body)[source]¶ Bases:
pandagg.node.mapping.abstract.UnnamedRegularField
To provide auto-complete suggestions
-
KEY
= 'completion'¶
-
-
class
pandagg.mapping.
TokenCount
(**body)[source]¶ Bases:
pandagg.node.mapping.abstract.UnnamedRegularField
To count the number of tokens in a string
-
KEY
= 'token_count'¶
-
-
class
pandagg.mapping.
MapperMurMur3
(**body)[source]¶ Bases:
pandagg.node.mapping.abstract.UnnamedRegularField
To compute hashes of values at index-time and store them in the index
-
KEY
= 'murmur3'¶
-
-
class
pandagg.mapping.
MapperAnnotatedText
(**body)[source]¶ Bases:
pandagg.node.mapping.abstract.UnnamedRegularField
To index text containing special markup (typically used for identifying named entities)
-
KEY
= 'annotated-text'¶
-
-
class
pandagg.mapping.
Percolator
(**body)[source]¶ Bases:
pandagg.node.mapping.abstract.UnnamedRegularField
Accepts queries from the query-dsl
-
KEY
= 'percolator'¶
-
-
class
pandagg.mapping.
Join
(**body)[source]¶ Bases:
pandagg.node.mapping.abstract.UnnamedRegularField
Defines parent/child relation for documents within the same index
-
KEY
= 'join'¶
-
-
class
pandagg.mapping.
RankFeature
(**body)[source]¶ Bases:
pandagg.node.mapping.abstract.UnnamedRegularField
Record numeric feature to boost hits at query time.
-
KEY
= 'rank_feature'¶
-
-
class
pandagg.mapping.
RankFeatures
(**body)[source]¶ Bases:
pandagg.node.mapping.abstract.UnnamedRegularField
Record numeric features to boost hits at query time.
-
KEY
= 'rank_features'¶
-
-
class
pandagg.mapping.
DenseVector
(**body)[source]¶ Bases:
pandagg.node.mapping.abstract.UnnamedRegularField
Record dense vectors of float values.
-
KEY
= 'dense_vector'¶
-
-
class
pandagg.mapping.
SparseVector
(**body)[source]¶ Bases:
pandagg.node.mapping.abstract.UnnamedRegularField
Record sparse vectors of float values.
-
KEY
= 'sparse_vector'¶
-
-
class
pandagg.mapping.
SearchAsYouType
(**body)[source]¶ Bases:
pandagg.node.mapping.abstract.UnnamedRegularField
A text-like field optimized for queries to implement as-you-type completion
-
KEY
= 'search_as_you_type'¶
-
-
class
pandagg.mapping.
Alias
(**body)[source]¶ Bases:
pandagg.node.mapping.abstract.UnnamedRegularField
Defines an alias to an existing field.
-
KEY
= 'alias'¶
-
-
class
pandagg.mapping.
Flattened
(**body)[source]¶ Bases:
pandagg.node.mapping.abstract.UnnamedRegularField
Allows an entire JSON object to be indexed as a single field.
-
KEY
= 'flattened'¶
-
-
class
pandagg.mapping.
Shape
(**body)[source]¶ Bases:
pandagg.node.mapping.abstract.UnnamedRegularField
For arbitrary cartesian geometries.
-
KEY
= 'shape'¶
-
-
class
pandagg.mapping.
Histogram
(**body)[source]¶ Bases:
pandagg.node.mapping.abstract.UnnamedRegularField
For pre-aggregated numerical values for percentiles aggregations.
-
KEY
= 'histogram'¶
-
-
class
pandagg.mapping.
Index
(**body)[source]¶ Bases:
pandagg.node.mapping.abstract.UnnamedField
The index to which the document belongs.
-
KEY
= '_index'¶
-
-
class
pandagg.mapping.
Type
(**body)[source]¶ Bases:
pandagg.node.mapping.abstract.UnnamedField
The document’s mapping type.
-
KEY
= '_type'¶
-
-
class
pandagg.mapping.
Id
(**body)[source]¶ Bases:
pandagg.node.mapping.abstract.UnnamedField
The document’s ID.
-
KEY
= '_id'¶
-
-
class
pandagg.mapping.
FieldNames
(**body)[source]¶ Bases:
pandagg.node.mapping.abstract.UnnamedField
All fields in the document which contain non-null values.
-
KEY
= '_field_names'¶
-
-
class
pandagg.mapping.
Source
(**body)[source]¶ Bases:
pandagg.node.mapping.abstract.UnnamedField
The original JSON representing the body of the document.
-
KEY
= '_source'¶
-
-
class
pandagg.mapping.
Size
(**body)[source]¶ Bases:
pandagg.node.mapping.abstract.UnnamedField
The size of the _source field in bytes, provided by the mapper-size plugin.
-
KEY
= '_size'¶
-
-
class
pandagg.mapping.
Ignored
(**body)[source]¶ Bases:
pandagg.node.mapping.abstract.UnnamedField
All fields in the document that have been ignored at index time because of ignore_malformed.
-
KEY
= '_ignored'¶
-
-
class
pandagg.mapping.
Routing
(**body)[source]¶ Bases:
pandagg.node.mapping.abstract.UnnamedField
A custom routing value which routes a document to a particular shard.
-
KEY
= '_routing'¶
-
-
class
pandagg.mapping.
Meta
(**body)[source]¶ Bases:
pandagg.node.mapping.abstract.UnnamedField
Application specific metadata.
-
KEY
= '_meta'¶
-