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
+46-30Lines changed: 46 additions & 30 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -9,31 +9,18 @@ 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
14
15
15
-
The following example shows a simple Python client use case:
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 can be reached through this module.
32
17
18
+
*[Features](#_features)
19
+
*[Getting Started guide](getting-started.md)
20
+
*[Ingest data with Python](docs-content://manage-data/ingest/ingesting-data-from-applications/ingest-data-with-python-on-elasticsearch-service.md) walkthrough
@@ -45,19 +32,48 @@ The client's features include:
45
32
* Thread safety
46
33
* Pluggable architecture
47
34
48
-
The client also provides a convenient set of [helpers](client-helpers.md) for tasks like bulk indexing and reindexing.
35
+
### Bulk helpers
36
+
37
+
The bulk helpers are a set of functions that use the low-level client's bulk ingest support through a high-level interface based on Python iterables that simplifies the ingest of large amounts of data.
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)
52
-
::::
44
+
This module offers an idiomatic interface to construct ES|QL queries using Python expressions.
The [Python DSL module](../reference/elasticsearch-dsl.md) offers a convenient and idiomatic way to write and manipulate queries.
49
+
### DSL module
57
50
58
-
## {{es}} version compatibility [_compatibility]
51
+
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.
59
52
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.
@@ -82,4 +98,4 @@ In the Python client, compatibility mode is always enabled.
82
98
83
99
:::{tip}
84
100
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