1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
|
[[getting-started-python]]
== Getting started
This page guides you through the installation process of the Python client,
shows you how to instantiate the client, and how to perform basic Elasticsearch
operations with it.
[discrete]
=== Requirements
* https://www.python.org/[Python] 3.8 or newer
* https://pip.pypa.io/en/stable/[`pip`], installed by default alongside Python
[discrete]
=== Installation
To install the latest version of the client, run the following command:
[source,shell]
--------------------------
python -m pip install elasticsearch
--------------------------
Refer to the <<installation>> page to learn more.
[discrete]
=== Connecting
You can connect to the Elastic Cloud using an API key and the Elasticsearch
endpoint.
[source,py]
----
from elasticsearch import Elasticsearch
client = Elasticsearch(
"https://...", # Elasticsearch endpoint
api_key="api_key",
)
----
Your Elasticsearch endpoint can be found on the **My deployment** page of your
deployment:
image::images/es-endpoint.jpg[alt="Finding Elasticsearch endpoint",align="center"]
You can generate an API key on the **Management** page under Security.
image::images/create-api-key.png[alt="Create API key",align="center"]
For other connection options, refer to the <<connecting>> section.
[discrete]
=== Operations
Time to use Elasticsearch! This section walks you through the basic, and most
important, operations of Elasticsearch. For more operations and more advanced
examples, refer to the <<examples>> page.
[discrete]
==== Creating an index
This is how you create the `my_index` index:
[source,py]
----
client.indices.create(index="my_index")
----
[discrete]
==== Indexing documents
This is a simple way of indexing a document:
[source,py]
----
client.index(
index="my_index",
id="my_document_id",
document={
"foo": "foo",
"bar": "bar",
}
)
----
[discrete]
==== Getting documents
You can get documents by using the following code:
[source,py]
----
client.get(index="my_index", id="my_document_id")
----
[discrete]
==== Searching documents
This is how you can create a single match query with the Python client:
[source,py]
----
client.search(index="my_index", query={
"match": {
"foo": "foo"
}
})
----
[discrete]
==== Updating documents
This is how you can update a document, for example to add a new field:
[source,py]
----
client.update(index="my_index", id="my_document_id", doc={
"foo": "bar",
"new_field": "new value",
})
----
[discrete]
==== Deleting documents
[source,py]
----
client.delete(index="my_index", id="my_document_id")
----
[discrete]
==== Deleting an index
[source,py]
----
client.indices.delete(index="my_index")
----
[discrete]
== Further reading
* Use <<client-helpers>> for a more comfortable experience with the APIs.
|
