eland.Series

class eland.Series(es_client: Optional[Elasticsearch] = None, es_index_pattern: Optional[str] = None, name: Optional[str] = None, es_index_field: Optional[str] = None, _query_compiler: Optional[QueryCompiler] = None)

pandas.Series like API that proxies into Elasticsearch index(es).

Parameters

es_clientelasticsearch.Elasticsearch

A reference to a Elasticsearch python client

es_index_patternstr

An Elasticsearch index pattern. This can contain wildcards.

es_index_fieldstr

The field to base the series on

See also

pandas.Series

Notes

If the Elasticsearch index is deleted or index mappings are changed after this object is created, the object is not rebuilt and so inconsistencies can occur.

Examples

>>> ed.Series(es_client='localhost', es_index_pattern='flights', name='Carrier')
0         Kibana Airlines
1        Logstash Airways
2        Logstash Airways
3         Kibana Airlines
4         Kibana Airlines
               ...
13054    Logstash Airways
13055    Logstash Airways
13056    Logstash Airways
13057            JetBeats
13058            JetBeats
Name: Carrier, Length: 13059, dtype: object

Series eland.Series.index