Python elasticsearch-py类库基础用法

塔西噶尼

实践环境

https://pypi.org/project/elasticsearch/
pip install elasticsearch==7.6.0
离线安装包及依赖包下载地址：
https://files.pythonhosted.org/packages/f5/71/45d36a8df68f3ebb098d6861b2c017f3d094538c0fb98fa61d4dc43e69b9/urllib3-1.26.2-py2.py3-none-any.whl#sha256=d8ff90d979214d7b4f8ce956e80f4028fc6860e4431f731ea4a8c08f23f99473
https://files.pythonhosted.org/packages/98/98/c2ff18671db109c9f10ed27f5ef610ae05b73bd876664139cf95bd1429aa/certifi-2023.7.22.tar.gz#sha256=539cc1d13202e33ca466e88b2807e29f4c13049d6d87031a3c110744495cb082
https://files.pythonhosted.org/packages/1f/12/7919c5d8b9c497f9180db15ea8ead6499812ea8264a6ae18766d93c59fe5/dataclasses-0.8.tar.gz#sha256=8479067f342acf957dc82ec415d355ab5edb7e7646b90dc6e2fd1d96ad084c97
https://files.pythonhosted.org/packages/6b/db/d934d605258d38bd470c83d535c3a73c3d01e4ad357ecb4336300fbb8e88/elastic-transport-8.4.1.tar.gz#sha256=e5548997113c5d9566c9a1a51ed67bce50a4871bc0e44b692166461279e4167e
https://files.pythonhosted.org/packages/94/1a/2369fc9264c655c20908053b59fae7f65ddc47f123d89b533a724ae1d19d/elasticsearch-7.6.0.tar.gz
Python3.6.2
Elasticsearch服务 7.6
注意：elasticsearch-py类库版本必须和Elasticsearch服务器版本保持对应，否则会有兼容性问题，具体如下，

1. # Elasticsearch 7.x
2. elasticsearch>=7.0.0,<8.0.0
4. # Elasticsearch 6.x
5. elasticsearch>=6.0.0,<7.0.0
7. # Elasticsearch 5.x
8. elasticsearch>=5.0.0,<6.0.0
10. # Elasticsearch 2.x
11. elasticsearch>=2.0.0,<3.0.0

复制代码

注意：笔者实践时，发现运行以下语句，会报错

1. #!/usr/bin/env python
2. # -*- coding:utf-8 -*-
4. from elasticsearch import Elasticsearch
5. from elasticsearch import helpers
6. from datetime import datetime
9. def search_data_by_scroll(es, index, body):
10.     '''翻页查询'''
12.     request_timeout = 600
13.     scroll = '20m' # 用于配置scroll有效期--滚动搜索上下文保留时间，默认不能超过 1d (24 小时). 可使用search.max_keep_alive集群配置修改该值
15.     query_result = es.search(index=index,
16.                                   scroll=scroll,
17.                                   body=body,
18.                                   request_timeout=request_timeout)
19.     scroll_id = query_result['_scroll_id']
21.     while len(query_result['hits']['hits']) > 0:
22.         yield query_result['hits']['hits']
23.         query_result = es.scroll(scroll_id=scroll_id,
24.                                       scroll=scroll,
25.                                       request_timeout=request_timeout)
26.         scroll_id = query_result['_scroll_id']
29. if __name__ == '__main__':
30.     # ES连接相关配置信息
31.     hosts = [ # ES 集群服务器信息
32.         {"host": "10.153.1.4", "port": 9200},
33.         {"host": "10.153.1.5", "port": 9200},
34.         {"host": "10.153.1.6", "port": 9200}
35.     ]
36.     username = 'myusername'  #  ES用户账号 可选配置, 如果无需访问验证, 则配置为空字符串 ''
37.     password = 'mypassword'  # ES用户密码 可选配置，如果无需访问验证, 则配置为空字符串 ''
40.     es = Elasticsearch(hosts=hosts,
41.                        http_auth=(username, password),
42.                        # 配置连接前进行探测
43.                        sniff_on_connection_fail = True,  # 节点无响应时刷新节点
44.                        sniffer_timeout = 60  # 设置超时时间，单位 秒
45.                        )
47.     ############### 增 ###############
48.     #### 创建索引
49.     #创建索引，如果索引已存在，则报错
50.     res = es.indices.create(index='my-test-index')
51.     print(res) # 输出：{'acknowledged': True, 'shards_acknowledged': True, 'index': 'my-test-index'}
53.     # 创建索引，如果索引已存在，则忽略400错误, 形如 elasticsearch.exceptions.RequestError: RequestError(400, 'resource_already_exists_exception', 'index [my-test-index/rOk1sVW9R46GZq9o7ACVxQ] already exists')
54.     res = es.indices.create(index='my-test-index', ignore=400)
55.     print(res) # 输出索引已存在相关错误信息
57.     # 定义mapping body
58.     index_mappings = {
59.         'mappings': { # key固定为 mappings
60.             'properties': {
61.                 'name': {
62.                     'type': 'keyword'
63.                 },
64.                 'age': {
65.                     'type': 'integer'
66.                 },
67.                 'tags': {
68.                     'type': 'text'
69.                 },
70.                 "timestamp": {
71.                     "type": "date"
72.                 }
73.             }
74.         },
75.         'settings': {
76.             'index': {
77.                 'number_of_shards': '3',
78.                 'number_of_replicas': '0'
79.             }
80.         }
81.     }
83.     # 创建索引的同时，设置mapping
84.     es.indices.create(index='my-test-index', body=index_mappings, ignore=400)
86.     #### 为索引创建别名
87.     # 为单个索引创建别名
88.     print(es.indices.put_alias(index='my-test-index', name='my-test-index-alias')) # 输出：{'acknowledged': True}
90.     res = es.indices.create(index='my-test-index2', ignore=400)
91.     print(res)
92.     # 为多个索引创建同一个别名，联合查询时用
93.     print(es.indices.put_alias(index=['my-test-index', 'my-test-index2'], name='test-index-alias')) # 输出：{'acknowledged': True}
95.     #### 插入数据
96.     # 插入单条数据
97.     data = {
98.         'name': '张三',
99.         'age': 18,
100.         'tags': '勤奋',
101.         'timestamp': datetime.now()
102.     }
103.     res = es.index(index='my-test-index', body=data)
104.     print(res) # 输出：{'_index': 'my-test-index', '_type': '_doc', '_id': 'ELlNE4sBRHfq82dAAhMz', '_version': 1, 'result': 'created', '_shards': {'total': 1, 'successful': 1, 'failed': 0}, '_seq_no': 0, '_primary_term': 1}
106.     # 插入记录时，指定记录ID
107.     data = {
108.         'name': '晓晓',
109.         'age': 19,
110.         'tags': '尊师',
111.         'timestamp': datetime.now()
112.     }
113.     res = es.index(index='my-test-index', id=1, body=data)
114.     print(res) # 输出：{'_index': 'my-test-index', '_type': '_doc', '_id': '1', '_version': 1, 'result': 'created', '_shards': {'total': 1, 'successful': 1, 'failed': 0}, '_seq_no': 2, '_primary_term': 1}
117.     # 插入记录时，指定文档类型
118.     # res = es.index(index='mytest-index', doc_type='person', id=1, body=data) # 注意：如果索引不存在，会自动创建索引
119.     # print(res) # {'_index': 'mytest-index', '_type': 'person', '_id': '1', '_version': 1, 'result': 'created', '_shards': {'total': 2, 'successful': 2, 'failed': 0}, '_seq_no': 0, '_primary_term': 1}
122.     # 批量插入数据
123.     insert_records = []
124.     index_name = 'my-test-index'
125.     data1 = {
126.         '_index': index_name,
127.         'name': '李四',
128.         'age': 20,
129.         'tags': '和善',
130.         'timestamp': datetime.now()
131.     }
132.     data2 = {
133.         '_index': index_name,
134.         'name': '王五',
135.         'age': 19,
136.         'tags': '好学',
137.         'timestamp': datetime.now()
138.     }
139.     insert_records.append(data1)
140.     insert_records.append(data2)
141.     res = helpers.bulk(client=es, actions=insert_records)
142.     print(res) # 输出：(2, [])
144.     ############### 改 ###############
145.     #### 更新记录
146.     # 使用 index 方法 # 注意：使用index实现更新时，body数据必须包含记录的全部字段，否则对应记录，未包含的字段将会被删除
147.     data = {
148.         'name': '晓晓',
149.         'age': 23,
150.         'timestamp': datetime.now()
151.     }
152.     res = es.index(index='mytest-index', id='1', body=data) # id为es中记录的_id值
153.     print(res) # 输出：{'_index': 'mytest-index', '_type': '_doc', '_id': '1', '_version': 2, 'result': 'updated', '_shards': {'total': 2, 'successful': 2, 'failed': 0}, '_seq_no': 1, '_primary_term': 1}
156.     # 使用 update 方法
157.     body = {
158.         'doc': {
159.             'tags': '尊师重教',
160.         }
161.     }
162.     res = es.update(index='mytest-index', id='1', body=body)
163.     print(res) # 输出：{'_index': 'mytest-index', '_type': '_doc', '_id': '1', '_version': 3, 'result': 'updated', '_shards': {'total': 2, 'successful': 2, 'failed': 0}, '_seq_no': 2, '_primary_term': 1}
166.     ############### 查 ###############
167.     # 查看全部索引的信息
168.     index_info = es.indices.get('*')
169.     # print(index_info) # 输出数据格式同 查看某个索引的信息 调用输出
171.     # 查看某个索引的信息
172.     index_info = es.indices.get('mytest-index')
173.     print(index_info) # 输出：{'mytest-index': {'aliases': {}, 'mappings': {'properties': {'age': {'type': 'long'}, 'name': {'type': 'text', 'fields': {'keyword': {'type': 'keyword', 'ignore_above': 256}}}, 'tags': {'type': 'text', 'fields': {'keyword': {'type': 'keyword', 'ignore_above': 256}}}, 'timestamp': {'type': 'date'}}}, 'settings': {'index': {'search': {'slowlog': {'threshold': {'query': {'warn': '2s', 'info': '1s'}}}}, 'number_of_shards': '1', 'provided_name': 'mytest-index', 'creation_date': '1696837120143', 'number_of_replicas': '1', 'uuid': 'EzxFtEyGQBKPUCu9usa8XA', 'version': {'created': '7060099'}}}}}
175.     # 查看多个指定索引的信息
176.     print(es.indices.get(index=['my-test-index', 'mytest-index']))
178.     # 查询索引相关信息
179.     body = '''
180.         {
181.            "query": {
182.               "match_all": {}
183.            }
184.         }'''
185.     body = body.strip()
186.     res = es.search(index=index_name,
187.                     doc_type='_doc', # 可以配置为None
188.                     request_timeout=120, # 设置查询超时时间120秒，es默认的查询超时时间是10s
189.                     body=body) # 注意：这里的body也可以是json，不一定要用字符串
190.     # print(res)
192.     # 查看索引是否存在
193.     print(es.indices.exists('my-test-index'))  # 输出：True
195.     # 获取指定索引中指定ID的记录信息
196.     res = es.get(index='mytest-index', id=1)
197.     print(res) # 输出：{'_index': 'mytest-index', '_type': '_doc', '_id': '1', '_version': 3, '_seq_no': 2, '_primary_term': 1, 'found': True, '_source': {'name': '晓晓', 'age': 23, 'timestamp': '2023-10-09T15:49:53.068134', 'tags': '尊师重教'}}
199.     # # 获取所有索引中指定ID的记录信息
200.     # res = es.get(index="*", id="1") # 报错了
202.     # 查询记录数
203.     doc_count_info = es.count(index=index_name)
204.     print(doc_count_info) # 输出：{'count': 4, '_shards': {'total': 3, 'successful': 3, 'skipped': 0, 'failed': 0}}
206.     # 查询记录信息
207.     res = es.search(index=index_name,
208.               request_timeout=120, # 设置查询超时时间120秒，es默认的查询超时时间是10s
209.               body=body)
210.     # print(res) # 反回一个字典，同界面查询结果
212.     # 查询指定索引，指定文档类型，指定ID记录是否存在
213.     print(es.exists(index='mytest-index', doc_type='doc', id='1')) # 输出：False
215.     # 查询指定索引中，指定ID记录是否存在
216.     print(es.exists(index='mytest-index', id='1')) # 输出：True
218.     # 翻页查询记录信息
219.     for data in search_data_by_scroll(es, 'index_presale_orderinfo', body):
220.         print(data) # 输出数据格式为列表, 形如 [{...},{...}]
223.     # 获取当前集群的基本信息
224.     print(es.info())
226.     # 获取集群健康信息
227.     print(es.cluster.health())
229.     # 获取整个集群的综合状态信息。
230.     print(es.cluster.state())
232.     # 返回群集的当前节点的信息
233.     print(es.cluster.stats())
235.     # 获取索引mapping
236.     print(es.indices.get_mapping(index='my-test-index'))
238.     # 获取索引设置
239.     # 获取单个索引的设置
240.     print(es.indices.get_settings(index='my-test-index'))
241.     # 获取多个索引的设置
242.     print(es.indices.get_settings(index=['my-test-index', 'my-test-index2']))
243.     # 获取所有索引的设置
244.     print(es.indices.get_settings(index='*'))
246.     # 获取索引别名
247.     # 获取单个索引的别名
248.     print(es.indices.get_alias(index='my-test-index'))
249.     # 获取多个索引的别名
250.     print(es.indices.get_alias(index=['my-test-index', 'my-test-index2']))
252.     # 获取任务列表
253.     print(es.tasks.list(detailed=True, timeout='60s'))
254.        
255.        
256.     ############### 删 ###############
258.     # 删除文档记录
259.     # 按id删除
260.     res = es.delete(index='mytest-index', id='1')
261.     print(res) # 输出：{'_index': 'mytest-index', '_type': '_doc', '_id': '1', '_version': 4, 'result': 'deleted', '_shards': {'total': 2, 'successful': 2, 'failed': 0}, '_seq_no': 3, '_primary_term': 1}
263.     # 按条件删除
264.     body = {
265.         'query': {
266.             'match': {
267.                 'name': '张三'
268.             }
269.         }
270.     }
271.     res = es.delete_by_query(index=index_name, body=body, ignore=[400, 404])
272.     print(res) # 输出：{'took': 25, 'timed_out': False, 'total': 1, 'deleted': 1, 'batches': 1, 'version_conflicts': 0, 'noops': 0, 'retries': {'bulk': 0, 'search': 0}, 'throttled_millis': 0, 'requests_per_second': -1.0, 'throttled_until_millis': 0, 'failures': []}
274.     # 删除索引别名
275.     # 删除单个索引的别名
276.     print(es.indices.delete_alias(index='my-test-index', name='my-test-index-alias')) # 输出：{'acknowledged': True}
278.     # 删除多个索引的指定别名，如果别名不存在，则忽略错误
279.     # print(es.indices.delete_alias(index=['my-test-index', 'my-test-index2'], name=['test-index-alias']))
281.     # 删除多个索引的所有别名
282.     print(es.indices.delete_alias(index=['my-test-index', 'my-test-index2'], name='_all')) # 如果存在索引别名，则会报错
285.     # 删除索引
286.     print(es.indices.delete(index_name)) # 输出：{'acknowledged': True}
288.     # 删除索引，忽略400,404错误，索引不存在时，会报404错误
289.     print(es.indices.delete(index_name, ignore = [400, 404]))

复制代码

其它说明：

1. res = es.get(index="*", id="1") # 报错：elasticsearch.exceptions.AuthorizationException: AuthorizationException(403, 'security_exception', 'action [indices:data/read/get] is unauthorized for user [elastic]')

复制代码

scroll 时间单位描述：

1. es.scroll(scroll_id=scroll_id, scroll='10m', request_timeout=20)

复制代码

参考链接

https://pypi.org/project/elasticsearch/7.6.0/#description
https://elasticsearch-py.readthedocs.io/en/v8.10.0/
https://elasticsearch-py.readthedocs.io/en/v8.10.0/api.html
http://runxinzhi.com/bubu99-p-13580687.html

来源:https://www.cnblogs.com/shouke/p/17993185
免责声明：由于采集信息均来自互联网，如果侵犯了您的权益，请联系我们【E-Mail:cb@itdo.tech】 我们会及时删除侵权内容，谢谢合作！