Skip to content

Commit 8207ede

Browse files
deprecation notice in the docs
1 parent c656395 commit 8207ede

File tree

1 file changed

+21
-0
lines changed

1 file changed

+21
-0
lines changed

docs/index.rst

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,27 @@
11
Elasticsearch DSL
22
=================
33

4+
.. note::
5+
6+
As of release 8.18.0, the Elasticsearch DSL package is part of the official
7+
`Elasticsearch Python client <https://github.com/elastic/elasticsearch-py>`_,
8+
so a separate install is not needed anymore. To migrate, follow these steps:
9+
10+
- Uninstall the ``elasticsearch-dsl`` package
11+
- Make sure you have version 8.18.0 or newer of the ``elasticsearch`` package
12+
installed
13+
- Replace ``elasticsearch_dsl`` with ``elasticsearch.dsl`` in your imports
14+
15+
To prevent applications from breaking unexpectedly due to this change, the
16+
8.18.0 release of the ``elasticsearch-dsl`` package automatically redirects
17+
all imports to the corresponding modules of the Python client package.
18+
19+
This documentation site applies to releases before 8.18.0. For newer releases
20+
use the following links:
21+
22+
- `8.x releases starting with 8.18.0 <https://www.elastic.co/guide/en/elasticsearch/client/python-api/8.18/elasticsearch-dsl.html>`_
23+
- `9.x releases <https://www.elastic.co/docs/reference/elasticsearch-py/elasticsearch-dsl>`_
24+
425
Elasticsearch DSL is a high-level library whose aim is to help with writing and
526
running queries against Elasticsearch. It is built on top of the official
627
low-level client (`elasticsearch-py <https://github.com/elastic/elasticsearch-py>`_).

0 commit comments

Comments
 (0)