Python操作Elasticsearch对象

操作几个方面

• 结果过滤，对于返回结果做过滤，主要是优化返回内容。
• 直接操作elasticsearch对象，处理一些简单的索引信息。一下几个方面都是建立在es对象的基础上。
• Indices，关于索引的细节操作，比如创建自定义的mappings。
• Cluster，关于集群的相关操作。
• Nodes，关于节点的相关操作。
• Cat API，换一种查询方式，一般的返回都是json类型的，cat提供了简洁的返回结果。
• Snapshot，快照相关，快照是从正在运行的Elasticsearch集群中获取的备份。我们可以拍摄单个索引或整个群集的快照，并将其存储在共享文件系统的存储库中，并且有一些插件支持S3，HDFS，Azure，Google云存储等上的远程存储库。
• Task Management API，任务管理API是新的，仍应被视为测试版功能。API可能以不向后兼容的方式更改。

结果过滤

• filter_path参数用于过滤减少es返回信息，可以指定返回相关的内容，还支持一些通配符的操作*

body = {
    "query": {
        "match": {
            "name": "成都"
        }
    }
}
# print(es.search(index="p1", body=body))
print(es.search(index="p1", body=body, filter_path=["hits.hits"]))
print(es.search(index="p1", body=body, filter_path=["hits.hits._source"]))
print(es.search(index="p1", body=body, filter_path=["hits.hits._source", "hits.total"]))
print(es.search(index="p1", body=body, filter_path=["hits.*"]))
print(es.search(index="p1", body=body, filter_path=["hits.hits._*"]))

Elasticsearch(es对象 )

• es.index 向指定索引添加更新文档 如果索引不存在就会创建，然后执行添加更新等操作

# print(es.index(index="p2", doc_type="doc", id=1, body={"name": "棒槌", "age": "18"}))  # 正常
# print(es.index(index="p2", doc_type="doc", id=2, body={"name": "棒棒哒", "age": 20}))  # 正常
# print(es.index(index="p2", doc_type="doc", body={"name": "熊大", "age": "10"}))  # 如果添加文档不带id自动会创建一个

• es.get 查询索引中指定文档

# get(self, index, id, doc_type="_doc", params=None):
# print(es.get(index='p2', doc_type='doc', id=1))  # 正常
# print(es.get(index='p2', doc_type='doc'))  # TypeError: get() missing 1 required positional argument: 'id' 只能取单个文档对象
# print(es.get(index='p2', id=2))  # 要指定文档类型elasticsearch.exceptions.NotFoundError: NotFoundError(404, '{"_index":"p2","_type":"_doc","_id":"2","found":false}')

• es.search 执行搜索查询并获取其匹配它可以跟复杂的查询条件 

1. index要搜索的以逗号分隔的索引名称列表; 使用_all 或空字符串对所有索引执行操作。
2. doc_type 要搜索的以逗号分隔的文档类型列表; 留空以对所有类型执行操作。
3. body 使用Query DSL（QueryDomain Specific Language查询表达式）的搜索定义。
4. _source 返回_source字段的true或false，或返回的字段列表，返回指定字段。
5. _source_exclude要从返回的_source字段中排除的字段列表，返回的所有字段中，排除哪些字段。
6. _source_include从_source字段中提取和返回的字段列表，跟_source差不多。

# print(es.search(index='p2', body={"query": {"match": {"age": "10"}}}))
# print(es.search(index='p2', body={"query": {"match": {"age": "10"}}}, _source=['name', 'age']))
# print(es.search(index='p2', body={"query": {"match": {"age": "10"}}}, _source_exclude=['age']))
print(es.search(index='p2', body={"query": {"match": {"age": "10"}}}, _source_include=['age']))

 排除结果

{'took': 3, 'timed_out': False, '_shards': {'total': 5, 'successful': 5, 'skipped': 0, 'failed': 0}, 'hits': {'total': 2, 'max_score': 0.2876821, 'hits': [{'_index': 'p2', '_type': 'doc', '_id': 'lEP_u2wBsrL_vQjNIMFf', '_score': 0.2876821, '_source': {'name': '熊大'}}, {'_index': 'p2', '_type': 'doc', '_id': 'W0MjvGwBsrL_vQjNNd0x', '_score': 0.2876821, '_source': {'sex': '男', 'name': '熊大', 'desc': '卡通智障儿童'}}]}}

• es.get_source，通过索引、类型和ID获取文档的来源，其实，直接返回想要的字典。 

print(es.get_source(index='p2', doc_type='doc', id='1'))

• es.count，执行查询并获取该查询的匹配数。比如查询年龄是18的文档。

body = {
    "query": {
        "match": {
            "age": 18
        }
    }
}
# print(es.count(index='p2', doc_type='doc', body=body))
# print(es.count(index='p2', doc_type='doc', body=body)['count'])
print(es.count(index='p2')) # 查在p2索引中总的文档个数{'count': 4, '_shards': {'total': 5, 'successful': 5, 'skipped': 0, 'failed': 0}}
print(es.count(index='p2', doc_type='doc')) # {'count': 4, '_shards': {'total': 5, 'successful': 5, 'skipped': 0, 'failed': 0}}

• es.create，创建索引（索引不存在的话）并新增一条数据，索引存在仅新增（只能新增，重复执行会报错），还是觉得index好用些

# print(es.create(index='p2', doc_type='doc', id=3, body={"city": "成都", "desc": "旅游的地方颇多， 小吃出名"}))
print(es.get_source(index='p2', doc_type='doc', id=3)) 

• es.delete，删除指定的文档。比如删除文章id为4的文档，但不能删除仅只删除索引，如果想要删除索引，还需要es.indices.delete来处理
• es.delete_by_query，删除与查询匹配的所有文档。

# print(es.delete(index='p2', doc_type='doc', id=1))
# print(es.delete_by_query(index='p2', body={"query": {"match": {"age": 20}}}))
# print(es.search(index='p2'))

• es.exists，查询elasticsearch中是否存在指定的文档，返回一个布尔值。

print(es.exists(index='p2', doc_type='doc', id='1'))

• es.info，获取当前集群的基本信息。

print(es.info())

• es.ping，如果集群已启动，则返回True，否则返回False。

print(es.ping())

Indices(es.indices 索引相关)　　

 创建索引 

body = {
    "mappings": {
        "doc": {
            "dynamic": "strict",
            "properties": {
                "title": {
                    "type": "text",
                    "analyzer": "ik_max_word"
                },
                "url": {
                    "type": "text"
                },
                "action_type": {
                    "type": "text"
                },
                "content": {
                    "type": "text"
                }
            }
        }
    }
}

print(es.indices.create(index='p3', body=body))

创建结果

{'acknowledged': True, 'shards_acknowledged': True, 'index': 'p3'}

• es.indices.analyze，返回分词结果。

print(es.indices.analyze(body={'analyzer': 'ik_max_word', 'text': "皮特和茱丽当选“年度模范情侣”Brad Pitt and Angelina Jolie"}))

• es.indices.delete，在Elasticsearch中删除索引。

print(es.indices.delete(index='p3'))
print(es.indices.delete(index='p2'))    # {'acknowledged': True}

•  es.indices.put_alias，为一个或多个索引创建别名，查询多个索引的时候，可以使用这个别名。

print(es.indices.put_alias(index='p3', name='p3_alias'))  # 为单个索引创建别名
print(es.indices.put_alias(index=['p3', 'p2'], name='p23_alias'))  # 为多个索引创建同一个别名，联查用

• es.indices.delete_alias，删除一个或多个别名。

print(es.indices.delete_alias(index='p1'))
print(es.indices.delete_alias(index=['p1, p2'])) 

• es.indices.get_mapping，检索索引或索引/类型的映射定义。

print(es.indices.get_mapping(index='p3'))

• es.indices.get_settings，检索一个或多个（或所有）索引的设置。

print(es.indices.get_settings(index='p3'))

• es.indices.get，允许检索有关一个或多个索引的信息。

print(es.indices.get(index='p2'))    # 查询指定索引是否存在
print(es.indices.get(index=['p2', 'p3']))

• es.indices.get_alias，检索一个或多个别名。

print(es.indices.get_alias(index='p2'))
print(es.indices.get_alias(index=['p2', 'p3']))

• es.indices.get_field_mapping，检索特定字段的映射信息。

print(es.indices.get_field_mapping(fields='url', index='p3', doc_type='doc'))
print(es.indices.get_field_mapping(fields=['url', 'title'], index='p3', doc_type='doc'))

• es.indices.delete_alias，删除特定别名。
• es.indices.exists，返回一个布尔值，指示给定的索引是否存在。
• es.indices.exists_type，检查索引/索引中是否存在类型/类型。
• es.indices.flus，明确的刷新一个或多个索引。
• es.indices.get_field_mapping，检索特定字段的映射。
• es.indices.get_template，按名称检索索引模板。
• es.indices.open，打开一个封闭的索引以使其可用于搜索。
• es.indices.close，关闭索引以从群集中删除它的开销。封闭索引被阻止进行读/写操作。
• es.indices.clear_cache，清除与一个或多个索引关联的所有缓存或特定缓存。
• es.indices.put_alias，为特定索引/索引创建别名。
• es.indices.get_uprade，监控一个或多个索引的升级程度。
• es.indices.put_mapping，注册特定类型的特定映射定义。
• es.indices.put_settings，实时更改特定索引级别设置。
• es.indices.put_template，创建一个索引模板，该模板将自动应用于创建的新索引。
• es.indices.rollove，当现有索引被认为太大或太旧时，翻转索引API将别名转移到新索引。API接受单个别名和条件列表。别名必须仅指向单个索引。如果索引满足指定条件，则创建新索引并切换别名以指向新别名。
• es.indices.segments，提供构建Lucene索引（分片级别）的低级别段信息。

Cluster（集群相关）

• es.cluster.get_settigns，获取集群设置。

print(es.cluster.get_settings())

• es.cluster.health，获取有关群集运行状况的非常简单的状态。

print(es.cluster.health()) 

• es.cluster.state，获取整个集群的综合状态信息。

print(es.cluster.state())

• es.cluster.state，获取整个集群的综合状态信息。

print(es.cluster.stats()) 

 Node（节点相关） 

• es.nodes.info，返回集群中节点的信息。

print(es.nodes.info())  # 返回所节点
print(es.nodes.info(node_id='node1'))   # 指定一个节点
print(es.nodes.info(node_id=['node1', 'node2']))   # 指定多个节点列表

• es.nodes.stats，获取集群中节点统计信息。

print(es.nodes.stats())
print(es.nodes.stats(node_id='node1'))
print(es.nodes.stats(node_id=['node1', 'node2']))

• es.nodes.hot_threads，获取指定节点的线程信息。

print(es.nodes.hot_threads(node_id='node1'))
print(es.nodes.hot_threads(node_id=['node1', 'node2']))

• es.nodes.usage，获取集群中节点的功能使用信息。

print(es.nodes.usage())
print(es.nodes.usage(node_id='node1'))
print(es.nodes.usage(node_id=['node1', 'node2']))

Cat（一种查询方式）

• es.cat.aliases，返回别名信息。

print(es.cat.aliases(name='p23_alias'))
print(es.cat.aliases(name='p23_alias', format='json')) 

• es.cat.allocation，返回分片使用情况。

print(es.cat.allocation())
print(es.cat.allocation(node_id=['node1']))
print(es.cat.allocation(node_id=['node1', 'node2'], format='json'))

• es.cat.count，Count提供对整个群集或单个索引的文档计数的快速访问。

print(es.cat.count())  # 集群内的文档总数
print(es.cat.count(index='p3'))  # 指定索引文档总数
print(es.cat.count(index=['p3', 'p2'], format='json'))  # 返回两个索引文档和

• es.cat.fielddata，基于每个节点显示有关当前加载的fielddata的信息。有些数据为了查询效率，会放在内存中，fielddata用来控制哪些数据应该被放在内存中，而这个es.cat.fielddata则查询现在哪些数据在内存中，数据大小等信息。

print(es.cat.fielddata())
print(es.cat.fielddata(format='json', bytes='b'))

bytes 单位'b'，'k'，'kb'，'m'，'mb'，'g'，'gb'，'t'，'tb' ，'p'，'pb'

• es.cat.health，从集群中health里面过滤出简洁的集群健康信息

print(es.cat.health())
print(es.cat.health(format='json'))

• es.cat.help，返回es.cat的帮助信息。

print(es.cat.help())

• es.cat.indices，返回索引的信息。

print(es.cat.indices())
print(es.cat.indices(index='p3'))
print(es.cat.indices(index='p3', format='json'))

• es.cat.master，返回集群中主节点的IP，绑定IP和节点名称。

print(es.cat.master())
print(es.cat.master(format='json'))

• es.cat.nodeattrs，返回节点的自定义属性。

print(es.cat.nodeattrs())
print(es.cat.nodeattrs(format='json'))

• es.cat.nodes，返回节点的拓扑，这些信息在查看整个集群时通常很有用，特别是大型集群。我有多少符合条件的节点？

print(es.cat.nodes())
print(es.cat.nodes(format='json'))

• es.cat.plugins，返回节点的插件信息。

print(es.cat.plugins())
print(es.cat.plugins(format='json'))

• es.cat.segments，返回每个索引的Lucene有关的信息。

print(es.cat.segments())
print(es.cat.segments(index='p3'))
print(es.cat.segments(index='p3', format='json'))

• es.cat.shards，返回哪个节点包含哪些分片的信息。

print(es.cat.shards())
print(es.cat.shards(index='p3'))
print(es.cat.shards(index='p3', format='json'))

• es.cat.thread_pool，获取有关线程池的信息。

print(es.cat.thread_pool())

Snapshot（快照相关）

• es.snapshot.create，在存储库中创建快照。
  • repository存储库名称。
  • snapshot快照名称。
  • body快照定义。
• es.snapshot.delete，从存储库中删除快照。
• es.snapshot.create_repository。注册共享文件系统存储库。
• es.snapshot.delete_repository，删除共享文件系统存储库。
• es.snapshot.get，检索有关快照的信息。
• es.snapshot.get_repository，返回有关已注册存储库的信息。
• es.snapshot.restore，恢复快照。
• es.snapshot.status，返回有关所有当前运行快照的信息。通过指定存储库名称，可以将结果限制为特定存储库。
• es.snapshot.verify_repository，返回成功验证存储库的节点列表，如果验证过程失败，则返回错误消息。

Task（任务相关）

• es.tasks.get，检索特定任务的信息。
• es.tasks.cancel，取消任务。
• es.tasks.list，任务列表。

更多玩法https://elasticsearch-py.readthedocs.io/en/master/api.html