PyElasticsearch 技术文档

1. 安装指南

在开始使用 PyElasticsearch 前，请确保您的系统中已安装了 Python 和 Elasticsearch。以下是安装 PyElasticsearch 的步骤：

1. 打开命令行工具。

2. 输入以下命令安装 PyElasticsearch：

   pip install pyelasticsearch
   

3. 确认安装成功，可以通过以下命令检查：

   python -c "import pyelasticsearch; print(pyelasticsearch.__version__)"
   

2. 项目的使用说明

PyElasticsearch 是一个简洁、面向未来的、高性能的 Elasticsearch API。它提供了以下特性：

• 透明地将 Python 数据类型转换为 JSON，包括日期时间和任意精度的 Decimal 类型。
• 将 HTTP 失败状态码转换为异常。
• 支持连接池、HTTP 基本认证和 HTTPS。
• 节点间的负载均衡和故障转移。
• 失败节点标记，避免在一段时间内访问故障节点。
• 可选的自动重试失败请求。
• 线程安全。
• 松耦合设计，允许自定义 JSON 编码和批量索引等。

3. 项目API使用文档

以下是 PyElasticsearch 一些常用 API 的使用示例：

创建连接对象

from pyelasticsearch import ElasticSearch

es = ElasticSearch('http://localhost:9200/')

索引文档

es.index('contacts', 'person', {'name': 'Joe Tester', 'age': 25, 'title': 'QA Master'}, id=1)

批量索引文档

docs = [
    {'id': 2, 'name': 'Jessica Coder', 'age': 32, 'title': 'Programmer'},
    {'id': 3, 'name': 'Freddy Tester', 'age': 29, 'title': 'Office Assistant'}
]

es.bulk((es.index_op(doc, id=doc.pop('id')) for doc in docs), index='contacts', doc_type='person')

刷新索引

es.refresh('contacts')

获取文档

es.get('contacts', 'person', 2)

执行简单搜索

es.search('name:joe OR name:freddy', index='contacts')

使用 Elasticsearch 查询 DSL 执行搜索

query = [
    'query': [
        'filtered': [
            'query': [
                'query_string': ['query': 'name:tester']
            ],
            'filter': [
                'range': [
                    'age': {
                        'from': 27,
                        'to': 37
                    }
                ]
            ]
        ]
    ]
]

es.search(query, index='contacts')

删除索引

es.delete_index('contacts')

4. 项目安装方式

PyElasticsearch 的安装方式已在“1. 安装指南”中详细说明，这里再次简要总结如下：

使用 pip 命令安装：

pip install pyelasticsearch

确保安装成功后，您就可以开始使用 PyElasticsearch 进行开发了。