Skip to content

Commit 43b64ab

Browse files
Expand the overview section of the docs
1 parent 06f25a0 commit 43b64ab

File tree

1 file changed

+33
-11
lines changed

1 file changed

+33
-11
lines changed

docs/reference/index.md

Lines changed: 33 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,37 @@ This documentation covers the [official Python client for {{es}}](https://github
1111

1212
API reference documentation is provided on [Read the Docs](https://elasticsearch-py.readthedocs.io).
1313

14+
This client is composed of several modules:
15+
16+
#### The actual client
17+
18+
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.
19+
20+
* [Features](#_features)
21+
* [Reference documentation](https://elasticsearch-py.readthedocs.io/en/stable/es_api.html)
22+
23+
#### Bulk helpers**
24+
25+
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.
26+
27+
* [User guide](https://www.elastic.co/docs/reference/elasticsearch/clients/python/client-helpers#bulk-helpers)
28+
* [Reference documentation](https://elasticsearch-py.readthedocs.io/en/stable/api_helpers.html)
29+
30+
#### ES|QL query builder**
31+
32+
This module offers an idiomatic interface to construct ES|QL queries based on Python expressions.
33+
34+
* [User guide](https://www.elastic.co/docs/reference/elasticsearch/clients/python/esql-query-builder)
35+
* [Reference documentation](https://elasticsearch-py.readthedocs.io/en/stable/esql.html)
36+
37+
#### DSL module
38+
39+
The DSL module could be thought of as a high-level client for {{es}}. It allows applications to manipulate documents and queries using classes and objects instead of primitive types such as dictionaries and lists.
40+
41+
* [User guide](https://www.elastic.co/docs/reference/elasticsearch/clients/python/elasticsearch-dsl)
42+
* [Reference documentation](https://elasticsearch-py.readthedocs.io/en/stable/dsl.html)
43+
44+
## Example [_example]
1445

1546
The following example shows a simple Python client use case:
1647

@@ -30,9 +61,6 @@ The following example shows a simple Python client use case:
3061
{'any': 'data', 'timestamp': '2013-05-12T19:45:31.804229'}
3162
```
3263

33-
34-
35-
3664
## Features [_features]
3765

3866
The client's features include:
@@ -51,13 +79,7 @@ The client also provides a convenient set of [helpers](client-helpers.md) for ta
5179
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)
5280
::::
5381

54-
### Elasticsearch Python DSL [_elasticsearch_python_dsl]
55-
56-
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.
82+
## Compatibility [_compatibility]
6183

6284
| Client version | {{es}} `8.x` | {{es}} `9.x` | {{es}} `10.x` |
6385
|----------------|---------------------------------|---------------------------------|----------------------------------|
@@ -82,4 +104,4 @@ In the Python client, compatibility mode is always enabled.
82104

83105
:::{tip}
84106
To support working with multiple client versions, the Python client is also released under the package names `elasticsearch8` and `elasticsearch9` (to prevent name collisions).
85-
:::
107+
:::

0 commit comments

Comments
 (0)