opensearch-dsl

What it is and what it does

opensearch-dsl-py is a high-level Python client for OpenSearch that provides a domain-specific language for constructing and executing queries. It wraps opensearch-py and offers an object-oriented interface for building complex search queries, filters, and aggregations against OpenSearch clusters.

The package is now deprecated and abandoned. The maintainers explicitly recommend switching to opensearch-py, which has absorbed the DSL functionality. It depends on six, python-dateutil, opensearch-py, and ipaddress, and supports Python 2.7 and Python 3.4 through 3.9. The repository is archived and has not received updates since January 2024.

Use it for:

• Building OpenSearch queries programmatically using a Pythonic DSL instead of raw JSON.
• Mapping Python objects to OpenSearch documents with automatic serialization and deserialization.
• Constructing aggregations and filters in a readable way for search applications.
• Maintaining legacy systems that already depend on opensearch-dsl-py.

Worth the install?

AI-flagged interpretation of the facts on this page — verify before relying

A Python client library for building and executing queries against OpenSearch using a domain-specific language interface built on top of opensearch-py.

No. The package is explicitly deprecated and abandoned as of version 2.1.0, with the maintainers recommending migration to opensearch-py. Unless you are maintaining legacy code that already depends on it, you should use opensearch-py directly instead. Starting new projects with this package is not advisable.

Install

opensearch-dsl on PyPI

pip install opensearch-dsl

uv add opensearch-dsl

poetry add opensearch-dsl

Installing opensearch-dsl

Before you install

Low install friction with a pure-Python wheel distribution. However, the package is abandoned as of version 2.1.0 (last release 2023-03-21, last commit 2024-01-18, repository archived); the maintainers explicitly recommend migrating to opensearch-py instead.

License in practice

Licensed under Apache-2.0 (permissive), so commercial use and modification are permitted without restriction, though you should review the license terms if redistribution is planned.

Quickstart

pip install opensearch-dsl==2.1.0

from opensearch_dsl import Search
from opensearch_py import OpenSearch

client = OpenSearch()
s = Search(using=client, index='my_index')
results = s.execute()

Requires a running OpenSearch cluster. The package is abandoned and not recommended for new projects.

Verify before relying

• Whether opensearch-py now fully replaces the DSL functionality or if specific use cases still require this package.
• Compatibility with OpenSearch versions released after the package's final release in March 2023.
• Whether the deprecated package will receive security updates or bug fixes.

Package facts

Evidence: opensearch_dsl-2.1.0-py2.py3-none-any.whl

Tags

More Database packages