https://github.com/aio-libs-abandoned/aioes

asyncio compatible driver for elasticsearch
https://github.com/aio-libs-abandoned/aioes

Last synced: 14 days ago
JSON representation

asyncio compatible driver for elasticsearch

• Host: GitHub
• URL: https://github.com/aio-libs-abandoned/aioes
• Owner: aio-libs-abandoned
• License: apache-2.0
• Archived: true
• Created: 2014-08-13T13:40:37.000Z (over 10 years ago)
• Default Branch: master
• Last Pushed: 2019-04-29T06:12:23.000Z (over 5 years ago)
• Last Synced: 2024-05-23T07:47:13.204Z (6 months ago)
• Language: Python
• Homepage: http://aioes.readthedocs.org
• Size: 338 KB
• Stars: 98
• Watchers: 12
• Forks: 29
• Open Issues: 16
• Metadata Files:
  • Readme: README.rst
  • Changelog: CHANGES.txt
  • License: LICENSE.txt

Awesome Lists containing this project

• awesome-asyncio - aioes - Asyncio compatible driver for elasticsearch. (Database Drivers)

README

        
asyncio client library for elasticsearch

=========================================

**aioes** is a asyncio_ compatible library for working with Elasticsearch_

.. image:: https://travis-ci.org/aio-libs/aioes.svg?branch=master

   :target: https://travis-ci.org/aio-libs/aioes

.. image:: https://codecov.io/gh/aio-libs/aioes/branch/master/graph/badge.svg

   :target: https://codecov.io/gh/aio-libs/aioes

   

The project is abandoned

========================

**aioes is not supported anymore.**

Please use official client: https://github.com/elastic/elasticsearch-py-async

or more featured https://github.com/wikibusiness/aioelasticsearch alternative.

Documentation

-------------

Read **aioes** documentation on Read The Docs: http://aioes.readthedocs.io/

Example

-------

::

    import asyncio

    from aioes import Elasticsearch

    @asyncio.coroutine

    def go():

        es = Elasticsearch(['localhost:9200'])

        ret = yield from es.create(index="my-index",

                                   doc_type="test-type",

                                   id=42,

                                   body={"str": "data",

                                         "int": 1})

        assert (ret == {'_id': '42',

                        '_index': 'my-index',

                        '_type': 'test-type',

                        '_version': 1,

                        'ok': True})

        answer = yield from es.get(index="my-index",

                                   doc_type="test-type",

                                   id=42)

        assert answer['_source'] == {'str': 'data', 'int': 1}

    loop = asyncio.get_event_loop()

    loop.run_until_complete(go())

Requirements

------------

* Python_ 3.3+

* asyncio_ or Python 3.4+

* aiohttp_ 1.3+

Tests

-----

Make sure you have an instance of Elasticsearch running on port 9200

before executing the tests.

In order for all tests to work you need to add the following lines in the

``config/elasticsearch.yml`` configuration file:

Enable groovy scripts::

  script.groovy.sandbox.enabled: true

Set a repository path::

  path.repo: ["/tmp"]

The test suite uses `py.test`, simply run::

  $ py.test

License

-------

aioes is offered under the BSD license.

.. _python: https://www.python.org/downloads/

.. _asyncio: https://pypi.python.org/pypi/asyncio

.. _aiohttp: https://pypi.python.org/pypi/aiohttp

.. _Elasticsearch: http://www.elasticsearch.org/