Module Expr Str ClassDef bases NameLoad body Expr Str FunctionDef arguments args NameParam NameParam defaults body Expr Str Return Call NameLoad Dict Str NameLoad decorator_list NameLoad FunctionDef arguments args NameParam NameParam defaults body Expr Str Return Call NameLoad Dict Str NameLoad decorator_list NameLoad FunctionDef arguments args NameParam NameParam defaults body Expr Str Return Call NameLoad keyword Dict Str NameLoad decorator_list NameLoad FunctionDef arguments args NameParam NameParam NameParam defaults NameLoad body Expr Str Assign NameStore Call NameLoad keyword Dict Str NameLoad If CompareIsNot NameLoad NameLoad body Assign SubscriptStore SubscriptLoad NameLoad Index Str Index Str NameLoad Return NameLoad decorator_list NameLoad FunctionDef arguments args NameParam NameParam defaults body Expr Str Return Call NameLoad keyword Dict Str NameLoad decorator_list NameLoad FunctionDef arguments args NameParam NameParam defaults body Expr Str Return Call NameLoad keyword Dict Str NameLoad decorator_list NameLoad FunctionDef arguments args NameParam NameParam NameParam NameParam defaults body Expr Str Return Call NameLoad keyword Dict NameLoad Dict Str Str NameLoad NameLoad decorator_list NameLoad FunctionDef arguments args NameParam NameParam NameParam NameParam NameParam defaults NameLoad body Expr Str Assign NameStore Call NameLoad keyword Dict Str NameLoad NameLoad NameLoad If CompareIsNot NameLoad NameLoad body Assign SubscriptStore SubscriptLoad NameLoad Index Str Index Str NameLoad Return NameLoad decorator_list NameLoad FunctionDef arguments args NameParam NameParam NameParam NameParam NameParam NameParam defaults NameLoad body Expr Str Assign NameStore Call NameLoad keyword Dict Str Str NameLoad NameLoad NameLoad NameLoad If CompareIsNot NameLoad NameLoad body Assign SubscriptStore SubscriptLoad NameLoad Index Str Index Str NameLoad Return NameLoad decorator_list NameLoad FunctionDef arguments args NameParam NameParam NameParam defaults body Expr Str Return Call NameLoad keyword Dict NameLoad Dict Str NameLoad decorator_list NameLoad FunctionDef arguments args NameParam NameParam NameParam defaults body Expr Str Return Call NameLoad keyword Dict Str Str NameLoad NameLoad decorator_list NameLoad FunctionDef arguments args NameParam defaults body Expr Str Return Call NameLoad keyword Dict decorator_list NameLoad FunctionDef arguments args NameParam NameParam defaults body Expr Str Return Call NameLoad keyword Dict Str NameLoad decorator_list NameLoad FunctionDef arguments args NameParam NameParam defaults body Expr Str Return Call NameLoad Dict Str NameLoad decorator_list NameLoad FunctionDef arguments args NameParam NameParam NameParam NameParam NameParam NameParam defaults NameLoad NameLoad body Expr Str Assign NameStore Call NameLoad keyword Dict NameLoad Dict Str Str NameLoad NameLoad If CompareIsNot NameLoad NameLoad body Assign SubscriptStore SubscriptLoad SubscriptLoad NameLoad Index Str Index NameLoad Index Str NameLoad If CompareIsNot NameLoad NameLoad body Assign SubscriptStore SubscriptLoad SubscriptLoad NameLoad Index Str Index NameLoad Index Str NameLoad Return NameLoad decorator_list NameLoad FunctionDef arguments args NameParam NameParam defaults body Expr Str Return Call NameLoad Dict Str NameLoad decorator_list NameLoad FunctionDef arguments args NameParam NameParam NameParam defaults body Expr Str Return Call NameLoad keyword Dict NameLoad NameLoad decorator_list NameLoad FunctionDef arguments args NameParam NameParam defaults body Expr Str Return Call NameLoad keyword NameLoad decorator_list NameLoad FunctionDef arguments args NameParam NameParam NameParam NameParam NameParam NameParam defaults NameLoad NameLoad NameLoad NameLoad body Expr Str Assign NameStore Call NameLoad Dict Str Dict NameLoad Dict If CompareIsNot NameLoad NameLoad body Assign SubscriptStore SubscriptLoad SubscriptLoad NameLoad Index Str Index NameLoad Index Str NameLoad If CompareIsNot NameLoad NameLoad body Assign SubscriptStore SubscriptLoad SubscriptLoad NameLoad Index Str Index NameLoad Index Str NameLoad If CompareIsNot NameLoad NameLoad body Assign SubscriptStore SubscriptLoad SubscriptLoad NameLoad Index Str Index NameLoad Index Str NameLoad If CompareIsNot NameLoad NameLoad body Assign SubscriptStore SubscriptLoad SubscriptLoad NameLoad Index Str Index NameLoad Index Str NameLoad Return NameLoad decorator_list NameLoad FunctionDef arguments args NameParam NameParam defaults body Expr Str Return Call NameLoad keyword NameLoad decorator_list NameLoad FunctionDef arguments args NameParam NameParam NameParam defaults body Expr Str Return Call NameLoad keyword Dict NameLoad NameLoad decorator_list NameLoad decorator_list
N/A N/A 
@author Luke Campbell <LCampbell@ASAScience.com>
@file filter
@date 05/24/12 09:32
@description Filters for searching
 ElasticFilter N/A dict N/A N/A 
    Wrapper for ElasticSearch filters
     and_filter N/A N/A cls query N/A N/A N/A 
        http://www.elasticsearch.org/guide/reference/query-dsl/and-filter.html
        A filter that matches documents using AND boolean operator on other queries. This filter is more performant then bool filter. Can be placed within queries that accept a filter.
         N/A N/A cls N/A and query N/A classmethod bool_filter N/A N/A cls query N/A N/A N/A 
        http://www.elasticsearch.org/guide/reference/query-dsl/bool-filter.html
        A filter that matches documents matching boolean combinations of other queries. Similar in concept to Boolean query, except that the clauses are other filters. Can be placed within queries that accept a filter.
         N/A N/A cls N/A bool query N/A classmethod exists N/A N/A cls field N/A N/A N/A 
        http://www.elasticsearch.org/guide/reference/query-dsl/exists-filter.html
        Filters documents where a specific field has a value in them.
        > filter = elasticpy.ElasticFilter().exists(field='user')
        > filter.query()
          {'exists' : {'field' : 'user' } }
         N/A N/A cls exists N/A field field N/A classmethod ids N/A N/A cls values itype N/A None N/A N/A 
        http://www.elasticsearch.org/guide/reference/query-dsl/ids-filter.html
Filters documents that only have the provided ids. Note, this filter does not require the _id field to be indexed since it works using the _uid field.

         N/A instance N/A cls ids N/A values values N/A N/A itype None N/A N/A N/A N/A instance N/A ids N/A type itype N/A instance N/A classmethod limit N/A N/A cls value N/A N/A N/A 
        http://www.elasticsearch.org/guide/reference/query-dsl/limit-filter.html
        A limit filter limits the number of documents (per shard) to execute on.
         N/A N/A cls limit N/A value value N/A classmethod type N/A N/A cls value N/A N/A N/A 
        http://www.elasticsearch.org/guide/reference/query-dsl/type-filter.html
Filters documents matching the provided document / mapping type. Note, this filter can work even when the _type field is not indexed (using the _uid field).
         N/A N/A cls type N/A value value N/A classmethod geo_bounding_box N/A N/A cls field top_left bottom_right N/A N/A N/A 
        http://www.elasticsearch.org/guide/reference/query-dsl/geo-bounding-box-filter.html

        > bounds = ElasticFilter().geo_bounding_box('pin.location', [40.73, -74.1], [40.717, -73.99])
        > bounds = ElasticFilter().geo_bounding_box('pin.location', dict(lat=40.73, lon=-74.1), dict(lat=40.717, lon=-73.99))
        > bounds = ElasticFilter().geo_bounding_box('pin.location', "40.73, -74.1", "40.717, -73.99")
        And geohash
        > bounds = ElasticFilter().geo_bounding_box('pin.location', "drm3btev3e86", "drm3btev3e86")

         N/A N/A cls geo_bounding_box N/A field N/A top_left bottom_right top_left bottom_right N/A classmethod geo_distance N/A N/A cls field center distance distance_type N/A None N/A N/A 
        http://www.elasticsearch.org/guide/reference/query-dsl/geo-distance-filter.html
        Filters documents that include only hits that exists within a specific distance from a geo point.
        field - Field name
        center - Center point (Geo point)
        distance - String for the distance
        distance_type - (arc | plane) How to compute the distance. Can either be arc (better precision) or plane (faster). Defaults to arc
        > bounds = ElasticFilter().geo_distance('pin.location', [40.73, -74.1], '300km')
         N/A instance N/A cls geo_distance N/A distance field distance center N/A N/A distance_type None N/A N/A N/A N/A instance N/A geo_distance N/A distance_type distance_type N/A instance N/A classmethod geo_distance_range N/A N/A cls field center from_distance to_distance distance_type N/A None N/A N/A 
        http://www.elasticsearch.org/guide/reference/query-dsl/geo-distance-range-filter.html
        Filters documents that exists within a range from a specific point


         N/A instance N/A cls geo_distance_range N/A from to field from_distance to_distance center N/A N/A distance_type None N/A N/A N/A N/A instance N/A geo_distance_range N/A distance_type distance_type N/A instance N/A classmethod geo_polygon N/A N/A cls field points N/A N/A N/A 
        http://www.elasticsearch.org/guide/reference/query-dsl/geo-polygon-filter.html
        A filter allowing to include hits that only fall within a polygon of points.
        Points are in geo-point format

        > filter = ElasticFilter().geo_polygon('pin.location', [[40, -70], [30, -80], [20, -90]])
         N/A N/A cls geo_polygon N/A field N/A points points N/A classmethod has_child N/A N/A cls child_type query N/A N/A N/A 
        http://www.elasticsearch.org/guide/reference/query-dsl/has-child-filter.html
        The has_child filter accepts a query and the child type to run against, and results in parent documents that have child docs matching the query.

        > query = ElasticQuery().term(tag='something')
        > filter = ElasticFilter().has_child('blog_tag', query)

         N/A N/A cls has_child N/A type query child_type query N/A classmethod match_all N/A N/A cls N/A N/A N/A 
        http://www.elasticsearch.org/guide/reference/query-dsl/match-all-filter.html
        A filter that matches on all documents.
        > filter = ElasticFilter().match_all()
         N/A N/A cls match_all N/A N/A classmethod missing N/A N/A cls field N/A N/A N/A 
        http://www.elasticsearch.org/guide/reference/query-dsl/missing-filter.html
        Filters documents where a specific field has no value in them.

         N/A N/A cls missing N/A field field N/A classmethod not_filter N/A N/A cls query N/A N/A N/A 
        http://www.elasticsearch.org/guide/reference/query-dsl/not-filter.html
        A filter that filters out matched documents using a query. This filter is more performant then bool filter. Can be placed within queries that accept a filter.

         N/A N/A cls N/A not query N/A classmethod numeric_range N/A N/A cls field from_value to_value include_lower include_upper N/A None None N/A N/A 
        http://www.elasticsearch.org/guide/reference/query-dsl/numeric-range-filter.html
        Filters documents with fields that have values within a certain numeric range. Similar to range filter, except that it works only with numeric values, and the filter execution works differently.
         N/A instance N/A cls numeric_range N/A field N/A from to from_value to_value N/A N/A include_lower None N/A N/A N/A N/A N/A instance N/A numeric_range N/A field N/A include_lower include_lower N/A N/A include_upper None N/A N/A N/A N/A N/A instance N/A numeric_range N/A field N/A include_upper include_upper N/A instance N/A classmethod or_filter N/A N/A cls query N/A N/A N/A 
        http://www.elasticsearch.org/guide/reference/query-dsl/or-filter.html

        A filter that matches documents using OR boolean operator on other queries. This filter is more performant then bool filter. Can be placed within queries that accept a filter.

        > term1 = ElasticQuery().term(lastname='Campbell')
        > term2 = ElasticQuery().term(firstname='Luke')
        > filter = ElasticFilter().or_filter([term1, term2])
         N/A N/A cls N/A or query N/A classmethod prefix N/A N/A cls field pre N/A N/A N/A 
        http://www.elasticsearch.org/guide/reference/query-dsl/prefix-filter.html
        Filters documents that have fields containing terms with a specified prefix (not analyzed). Similar to phrase query, except that it acts as a filter. Can be placed within queries that accept a filter.
         N/A N/A cls prefix N/A field pre N/A classmethod query N/A N/A cls query N/A N/A N/A 
        http://www.elasticsearch.org/guide/reference/query-dsl/query-filter.html
        Wraps any query to be used as a filter. Can be placed within queries that accept a filter.
         N/A N/A cls query query N/A classmethod range N/A N/A cls field from_value to_value include_lower include_upper N/A None None None None N/A N/A 
        http://www.elasticsearch.org/guide/reference/query-dsl/range-filter.html

        Filters documents with fields that have terms within a certain range. Similar to range query, except that it acts as a filter. Can be placed within queries that accept a filter.
         N/A instance N/A cls N/A range N/A field N/A N/A N/A from_value None N/A N/A N/A N/A N/A instance N/A range N/A field N/A from from_value N/A N/A to_value None N/A N/A N/A N/A N/A instance N/A range N/A field N/A to to_value N/A N/A include_lower None N/A N/A N/A N/A N/A instance N/A range N/A field N/A include_lower include_lower N/A N/A include_upper None N/A N/A N/A N/A N/A instance N/A range N/A field N/A include_upper include_upper N/A instance N/A classmethod script N/A N/A cls script N/A N/A N/A 
        http://www.elasticsearch.org/guide/reference/query-dsl/script-filter.html
        A filter allowing to define scripts as filters.

        > script = 'doc["num1"].value > 1'
        > filter = ElasticFilter().script(script)
         N/A N/A cls script script N/A classmethod term N/A N/A cls field value N/A N/A N/A 
        http://www.elasticsearch.org/guide/reference/query-dsl/term-filter.html
        Filters documents that have fields that contain a term (not analyzed). Similar to term query, except that it acts as a filter.
         N/A N/A cls term N/A field value N/A classmethod N/A