Skip to content

Commit 7fb50fd

Browse files
Expand the overview section of the docs
1 parent 06f25a0 commit 7fb50fd

File tree

1 file changed

+33
-12
lines changed

1 file changed

+33
-12
lines changed

docs/reference/index.md

Lines changed: 33 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -9,8 +9,38 @@ mapped_pages:
99

1010
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.
1111

12-
API reference documentation is provided on [Read the Docs](https://elasticsearch-py.readthedocs.io).
12+
This package is composed of several modules:
1313

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.
17+
18+
* [Features](#_features)
19+
* [Getting Started guide](getting-started.md)
20+
* [Reference documentation](https://elasticsearch-py.readthedocs.io/en/stable/es_api.html)
21+
22+
#### Bulk helpers
23+
24+
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.
25+
26+
* [User guide](client-helpers.md#bulk-helpers)
27+
* [Reference documentation](https://elasticsearch-py.readthedocs.io/en/stable/api_helpers.html)
28+
29+
#### ES|QL query builder
30+
31+
This module offers an idiomatic interface to construct ES|QL queries based on Python expressions.
32+
33+
* [User guide](esql-query-builder.md)
34+
* [Reference documentation](https://elasticsearch-py.readthedocs.io/en/stable/esql.html)
35+
36+
#### DSL module
37+
38+
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.
39+
40+
* [User guide](elasticsearch-dsl.md)
41+
* [Reference documentation](https://elasticsearch-py.readthedocs.io/en/stable/dsl.html)
42+
43+
## Example [_example]
1444

1545
The following example shows a simple Python client use case:
1646

@@ -30,9 +60,6 @@ The following example shows a simple Python client use case:
3060
{'any': 'data', 'timestamp': '2013-05-12T19:45:31.804229'}
3161
```
3262

33-
34-
35-
3663
## Features [_features]
3764

3865
The client's features include:
@@ -51,13 +78,7 @@ The client also provides a convenient set of [helpers](client-helpers.md) for ta
5178
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)
5279
::::
5380

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.
81+
## Compatibility [_compatibility]
6182

6283
| Client version | {{es}} `8.x` | {{es}} `9.x` | {{es}} `10.x` |
6384
|----------------|---------------------------------|---------------------------------|----------------------------------|
@@ -82,4 +103,4 @@ In the Python client, compatibility mode is always enabled.
82103

83104
:::{tip}
84105
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-
:::
106+
:::

0 commit comments

Comments
 (0)