Elasticsearch-py is the official low-level Python client for Elasticsearch. It provides a Pythonic way to interact with Elasticsearch, allowing developers to perform various operations such as indexing, searching, and managing Elasticsearch clusters directly from their Python applications.

Pros

• Officially maintained by Elastic, ensuring compatibility and up-to-date features
• Supports both synchronous and asynchronous operations
• Comprehensive documentation and examples
• Flexible configuration options for connection pooling and retry mechanisms

Cons

• Lower-level API compared to some higher-level alternatives
• Requires more boilerplate code for complex operations
• Learning curve for users new to Elasticsearch concepts
• Limited built-in query DSL helpers (though this is by design for flexibility)

Code Examples

1. Connecting to Elasticsearch and indexing a document:

from elasticsearch import Elasticsearch

es = Elasticsearch("http://localhost:9200")
doc = {"title": "Example Document", "content": "This is a test document."}
response = es.index(index="my_index", document=doc)
print(response['result'])

2. Performing a search query:

from elasticsearch import Elasticsearch

es = Elasticsearch("http://localhost:9200")
query = {
    "query": {
        "match": {
            "content": "test document"
        }
    }
}
response = es.search(index="my_index", body=query)
for hit in response['hits']['hits']:
    print(hit['_source'])

3. Using the async client:

import asyncio
from elasticsearch import AsyncElasticsearch

async def main():
    es = AsyncElasticsearch("http://localhost:9200")
    response = await es.info()
    print(response)
    await es.close()

asyncio.run(main())

Getting Started

To get started with elasticsearch-py, follow these steps:

1. Install the library:

   pip install elasticsearch
   

2. Import and create an Elasticsearch client:

   from elasticsearch import Elasticsearch
   
   es = Elasticsearch("http://localhost:9200")
   

3. Perform operations:

   # Index a document
   doc = {"title": "Hello", "content": "World"}
   es.index(index="test_index", document=doc)
   
   # Search for documents
   result = es.search(index="test_index", query={"match": {"content": "World"}})
   print(result['hits']['hits'])
   

For more detailed information and advanced usage, refer to the official documentation.