Skip to content

Recommend stack Elasticsearch Python client #242

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

Merged
merged 2 commits into from
Dec 12, 2024
Merged

Recommend stack Elasticsearch Python client #242

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
d4fec00
Recommend stack Elasticsearch Python client
pquentin Dec 12, 2024
f311467
Fix page title
pquentin Dec 12, 2024
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
20 changes: 12 additions & 8 deletions serverless/pages/clients-python-getting-started.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,20 +4,24 @@
// :description: Set up and use the Python client for {es3}.
// :keywords: serverless, elasticsearch, python, how to

This page guides you through the installation process of the Python
client, shows you how to initialize the client, and how to perform basic
{es} operations with it.

See the
https://www.elastic.co/guide/en/elasticsearch/client/python-api/current/index.html[Python
client] documentation for more detailed usage instructions.

[NOTE]
====
This client is for use with {es-serverless} only. See also the https://www.elastic.co/guide/en/elasticsearch/client/index.html[{es} clients].
The same client is used for {es3}, on-premise and managed Elasticsearch. Some API endpoints are however not available in {es3}.
====

This page guides you through the installation process of the Python
client for {es3}, shows you how to initialize the client, and how to perform basic
{es} operations with it.

[discrete]
[[elasticsearch-python-client-getting-started-requirements]]
== Requirements

* Python 3.7 or higher
* Python 3.9 or higher
* https://pip.pypa.io/en/stable/[`pip`]

[discrete]
Expand All @@ -39,7 +43,7 @@ commands:

[source,bash]
----
python -m pip install elasticsearch-serverless
python -m pip install elasticsearch
----

[discrete]
Expand All @@ -50,7 +54,7 @@ Initialize the client using your API key and {es} endpoint:

[source,python]
----
from elasticsearch_serverless import Elasticsearch
from elasticsearch import Elasticsearch

client = Elasticsearch(
"https://...", # Your project's Elasticsearch endpoint
Expand Down
Loading