You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/reference/index.md
+33-12Lines changed: 33 additions & 12 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -9,8 +9,38 @@ mapped_pages:
9
9
10
10
This documentation covers the [official Python client for {{es}}](https://github.com/elastic/elasticsearch-py). The goal of the Python client is to provide common ground for all {{es}}-related code in Python. The client is designed to be unopinionated and extendable.
11
11
12
-
API reference documentation is provided on [Read the Docs](https://elasticsearch-py.readthedocs.io).
12
+
This package is composed of several modules:
13
13
14
+
#### The actual client
15
+
16
+
This module, sometimes also called the "low-level" client, implements the client support for sending requests to {{es}} servers. The entire surface of the {{es}} API is available through this module.
The bulk helpers are a set of functions that use the low-level client's bulk ingest functions, but export a high-level interface based on Python iterables to simplify the ingest of large amounts of data.
The DSL module could be thought of as a "high-level" client for {{es}}. It allows applications to manipulate documents and queries using Python classes and objects instead of primitive types such as dictionaries and lists.
@@ -51,13 +78,7 @@ The client also provides a convenient set of [helpers](client-helpers.md) for ta
51
78
To get started, try this walkthrough: [Ingest data with Python](docs-content://manage-data/ingest/ingesting-data-from-applications/ingest-data-with-python-on-elasticsearch-service.md)
The [Python DSL module](../reference/elasticsearch-dsl.md) offers a convenient and idiomatic way to write and manipulate queries.
57
-
58
-
## {{es}} version compatibility [_compatibility]
59
-
60
-
Language clients are **forward compatible**: each client version works with equivalent and later minor versions of the **same or next major** version of {{es}}. For full compatibility, the client and {{es}} minor versions should match.
81
+
## Compatibility [_compatibility]
61
82
62
83
| Client version | {{es}} `8.x`| {{es}} `9.x`| {{es}} `10.x`|
@@ -82,4 +103,4 @@ In the Python client, compatibility mode is always enabled.
82
103
83
104
:::{tip}
84
105
To support working with multiple client versions, the Python client is also released under the package names `elasticsearch8` and `elasticsearch9` (to prevent name collisions).
0 commit comments