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
154
155
156
157
158
159
160
161
162
163
164
165
166
167
|
.. _quickstart:
Quickstart
==========
This guide shows you how to install the Elasticsearch Python client and perform basic
operations like indexing or searching documents.
Requirements
------------
- `Python <https://www.python.org/>`_ 3.8 or newer
- `pip <https://pip.pypa.io/en/stable/>`_
Installation
------------
To install the client, run the following command:
.. code-block:: console
$ python -m pip install elasticsearch
Connecting
----------
You can connect to Elastic Cloud using an API key and the Cloud ID.
.. code-block:: python
from elasticsearch import Elasticsearch
client = Elasticsearch(cloud_id="YOUR_CLOUD_ID", api_key="YOUR_API_KEY")
Your Cloud ID can be found on the **My deployment** page of your deployment
under **Cloud ID**.
You can generate an API key on the **Management** page under Security.
.. image:: ../guide/images/create-api-key.png
Confirm that the connection was successful.
.. code-block:: python
print(client.info())
Using the client
----------------
Time to use Elasticsearch! This section walks you through the most important
operations of Elasticsearch. The following examples assume that the Python
client was instantiated as above.
Create an index with mappings
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
This is how you create the `my_index` index.
Optionally, you can first define the expected types of your features with a custom mapping.
.. code-block:: python
mappings = {
"properties": {
"foo": {"type": "text"},
"bar": {
"type": "text",
"fields": {
"keyword": {
"type": "keyword",
"ignore_above": 256,
}
},
},
}
}
client.indices.create(index="my_index", mappings=mappings)
Indexing documents
^^^^^^^^^^^^^^^^^^
This indexes a document with the index API:
.. code-block:: python
client.index(
index="my_index",
id="my_document_id",
document={
"foo": "foo",
"bar": "bar",
},
)
You can also index multiple documents at once with the bulk helper function:
.. code-block:: python
from elasticsearch import helpers
def generate_docs():
for i in range(10):
yield {
"_index": "my_index",
"foo": f"foo {i}",
"bar": "bar",
}
helpers.bulk(client, generate_docs())
These helpers are the recommended way to perform bulk ingestion. While it is also possible to perform bulk ingestion using ``client.bulk`` directly, the helpers handle retries, ingesting chunk by chunk and more. See the :ref:`helpers` page for more details.
Getting documents
^^^^^^^^^^^^^^^^^
You can get documents by using the following code:
.. code-block:: python
client.get(index="my_index", id="my_document_id")
Searching documents
^^^^^^^^^^^^^^^^^^^
This is how you can create a single match query with the Python client:
.. code-block:: python
client.search(index="my_index", query={"match": {"foo": {"query": "foo"}}})
Updating documents
^^^^^^^^^^^^^^^^^^
This is how you can update a document, for example to add a new field:
.. code-block:: python
client.update(
index="my_index",
id="my_document_id",
doc={
"foo": "bar",
"new_field": "new value",
},
)
Deleting documents
^^^^^^^^^^^^^^^^^^
.. code-block:: python
client.delete(index="my_index", id="my_document_id")
Deleting an index
^^^^^^^^^^^^^^^^^
.. code-block:: python
client.indices.delete(index="my_index")
|
