Skip to main content

This is an adapter for elasticsearch-py providing a transport layer based on Python’s asyncio module. All API calls now return a future wrapping the response.

Sniffing (when requested) is also done via a scheduled coroutine.

Example for python 3.5+

import asyncio
from elasticsearch_async import AsyncElasticsearch

client = AsyncElasticsearch(hosts=['localhost', 'other-host'])

async def print_info():
    info = await client.info()
    print(info)

loop = asyncio.get_event_loop()
loop.run_until_complete(print_info())
loop.run_until_complete(client.transport.close())
loop.close()

Example for python 3.4

import asyncio
from elasticsearch_async import AsyncElasticsearch

client = AsyncElasticsearch(hosts=['localhost', 'other-host'])

@asyncio.coroutine
def print_info():
    info = yield from client.info()
    print(info)

loop = asyncio.get_event_loop()
loop.run_until_complete(print_info())
loop.run_until_complete(client.transport.close())
loop.close()

Example with SSL Context

import asyncio
from elasticsearch_async import AsyncElasticsearch
from elasticsearch.connection.http_urllib3 import create_ssl_context

context = create_ssl_context(cafile="/certs/ca/ca.crt")

client = AsyncElasticsearch(
    hosts=['elasticsearch-xpack'],
    ssl_context=context,
    http_auth=('elastic', 'changeme')
)

@asyncio.coroutine
def print_info():
    info = yield from client.info()
    print(info)

loop = asyncio.get_event_loop()
loop.run_until_complete(print_info())
loop.run_until_complete(client.transport.close())
loop.close()

AsyncElasticsearch introduces one extra parameter loop which can be used to pass in an event loop you wish the client to use. By default asyncio.get_event_loop() will be used.

Installation

elasticsearch-async is available via PyPI so you can install it using pip

pip install elasticsearch-async

License

Copyright 2015 Elasticsearch

Licensed under the Apache License, Version 2.0 (the “License”); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an “AS IS” BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Release files for elasticsearch-async 6.2.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for elasticsearch-async 6.2.0
File Size Uploaded
elasticsearch-async-6.2.0.tar.gz 11.3 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for elasticsearch-async 6.2.0
File Interpreter ABI Platform
elasticsearch_async-6.2.0-py2-none-any.whl Python 2 none any Details

Total release size: 19.2 kB

Release files / elasticsearch-async-6.2.0.tar.gz

Download URL elasticsearch-async-6.2.0.tar.gz
Size 11.3 kB
Tags Source
SHA-256 checksum
How to use checksums
2534f3ec80da275723cabd6d354c83eb4b4f6241ad1432b48c2c05fb12175ab1
BLAKE2b-256 checksum
How to use checksums
e34380b154f47f281ccdb3dc7d717b47094c4f32f493fdcc80391a592dc89f0f
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via Python-urllib/2.7

Release files / elasticsearch_async-6.2.0-py2-none-any.whl

Download URL elasticsearch_async-6.2.0-py2-none-any.whl
Size 8.0 kB
Tags Python 2
SHA-256 checksum
How to use checksums
281f5a7193811a9eb60669734d297bde13feeb745fd33c0c8af537e939aa887f
BLAKE2b-256 checksum
How to use checksums
4c345dee3d33f2bb096f984b7d8aa99060a5abb8373c56756372057eb81db099
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via Python-urllib/2.7

Release history Release notifications | RSS feed

This release

6.2.0 This release

2 release files

6.1.0

2 release files

6.0.0

2 release files

5.2.0

2 release files

5.1.0

2 release files

5.0.0

2 release files

2.0.0

2 release files

1.0.0

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page