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
+47-26Lines changed: 47 additions & 26 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -9,31 +9,43 @@ 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).
13
-
14
-
15
-
The following example shows a simple Python client use case:
This module, sometimes also called the "low-level" client, implements the support for sending requests to {{es}} servers. The client provides access to the entire surface of the {{es}} API.
34
43
44
+
*[Getting Started guide](getting-started.md)
45
+
*[Ingest data with Python walkthrough](docs-content://manage-data/ingest/ingesting-data-from-applications/ingest-data-with-python-on-elasticsearch-service.md)
@@ -45,19 +57,28 @@ The client's features include:
45
57
* Thread safety
46
58
* Pluggable architecture
47
59
48
-
The client also provides a convenient set of [helpers](client-helpers.md) for tasks like bulk indexing and reindexing.
60
+
### Bulk helpers
49
61
50
-
::::{tip}
51
-
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
-
::::
62
+
The bulk helpers are a set of functions that simplify the ingest of large amounts of data through a high-level interface based on Python iterables.
The [Python DSL module](../reference/elasticsearch-dsl.md) offers a convenient and idiomatic way to write and manipulate queries.
67
+
### ES|QL query builder
57
68
58
-
## {{es}} version compatibility [_compatibility]
69
+
This module offers an idiomatic interface to construct ES|QL queries using Python expressions.
59
70
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.
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.
@@ -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