Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Removing low-level and high-level client terminology #298

Merged
merged 1 commit into from
Feb 21, 2023
Merged

Removing low-level and high-level client terminology #298

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 0 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,8 +24,6 @@ OpenSearch Python Client
of elasticsearch-py licensed under the [Apache v2.0 License](https://github.com/opensearch-project/opensearch-py/blob/main/LICENSE.txt).
For more information, see [opensearch.org](https://opensearch.org/) and the [API Doc](https://opensearch-project.github.io/opensearch-py/).

This is the low-level client. A high-level Python client is in the works, and will be available soon.

## User Guide

To get started with the OpenSearch Python Client, see [User Guide](https://github.com/opensearch-project/opensearch-py/blob/main/USER_GUIDE.md).
Expand Down
8 changes: 4 additions & 4 deletions USER_GUIDE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@
- [Deleting an index](#deleting-an-index)
- [Making API calls](#making-api-calls)
- [Point in time API](#point-in-time-api)
- [Using High-level Python client](#using-high-level-python-client)
- [Using DSL features from opensearch-dsl-py](#using-dsl-features-from-opensearch-dsl-py)
- [Searching for documents with filters](#searching-for-documents-with-filters)
- [Using plugins](#using-plugins)
- [Alerting plugin](#alerting-plugin)
Expand Down Expand Up @@ -230,12 +230,12 @@ print('\n The deleted point in time:')
print(response)
```

## Using High-level Python client
High-level python client is now merged into Low-level python client. Thus, opensearch-py supports creating and indexing documents, searching with and without filters, and updating documents using queries.[High-level Python client documentation](https://opensearch.org/docs/latest/clients/python-high-level/).
## Using DSL features from opensearch-dsl-py
opensearch-dsl-py client is now merged into the opensearch-py client. Thus, opensearch-py supports creating and indexing documents, searching with and without filters, and updating documents using queries. See [opensearch-dsl-py client documentation](https://opensearch.org/docs/latest/clients/python-high-level/) for details.

All the APIs newly added from opensearch-dsl-py are listed in [docs](https://github.com/opensearch-project/opensearch-py/tree/main/docs/source/api-ref).

In the below example, 'Search' API from High-level Python Client is used.
In the below example, [Search API](https://github.com/opensearch-project/opensearch-py/blob/main/opensearchpy/helpers/search.py) from opensearch-dsl-py client is used.

### Searching for documents with filters

Expand Down
2 changes: 1 addition & 1 deletion opensearchpy/_async/client/__init__.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@

class AsyncOpenSearch(object):
"""
OpenSearch low-level client. Provides a straightforward mapping from
OpenSearch client. Provides a straightforward mapping from
Python to OpenSearch REST endpoints.

The instance has attributes ``cat``, ``cluster``, ``indices``, ``ingest``,
Expand Down
2 changes: 1 addition & 1 deletion opensearchpy/client/__init__.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@

class OpenSearch(object):
"""
OpenSearch low-level client. Provides a straightforward mapping from
OpenSearch client. Provides a straightforward mapping from
Python to OpenSearch REST endpoints.

The instance has attributes ``cat``, ``cluster``, ``indices``, ``ingest``,
Expand Down