elasticsearch6-dsl 6.4.0

安装

pip install elasticsearch-dsl

示例

请参阅 examples 目录，以查看使用 elasticsearch-dsl 的复杂示例。

兼容性

该库自 2.x 版本的 Elasticsearch 以来与所有 Elasticsearch 版本兼容，但您必须使用匹配的主版本。

对于 Elasticsearch 6.0 及以后的版本，请使用库的主版本 6（6.x.y）。

对于 Elasticsearch 5.0 及以后的版本，请使用库的主版本 5（5.x.y）。

对于 Elasticsearch 2.0 及以后的版本，请使用库的主版本 2（2.x.y）。

在您的 setup.py 或 requirements.txt 中设置要求的方式推荐如下：

# Elasticsearch 6.x
elasticsearch-dsl>=6.0.0,<7.0.0

# Elasticsearch 5.x
elasticsearch-dsl>=5.0.0,<6.0.0

# Elasticsearch 2.x
elasticsearch-dsl>=2.0.0,<3.0.0

开发在 master 上进行，较老的分支仅获得错误修复版本

搜索示例

让我们直接以 dict 的形式编写一个典型的搜索请求

from elasticsearch import Elasticsearch
client = Elasticsearch()

response = client.search(
    index="my-index",
    body={
      "query": {
        "bool": {
          "must": [{"match": {"title": "python"}}],
          "must_not": [{"match": {"description": "beta"}}],
          "filter": [{"term": {"category": "search"}}]
        }
      },
      "aggs" : {
        "per_tag": {
          "terms": {"field": "tags"},
          "aggs": {
            "max_lines": {"max": {"field": "lines"}}
          }
        }
      }
    }
)

for hit in response['hits']['hits']:
    print(hit['_score'], hit['_source']['title'])

for tag in response['aggregations']['per_tag']['buckets']:
    print(tag['key'], tag['max_lines']['value'])

这种方法的缺点是它非常冗长，容易出错，例如不正确的嵌套，难以修改（例如添加另一个过滤器），并且绝对不是编写时的乐趣。

让我们用 Python DSL 重新编写这个例子

from elasticsearch import Elasticsearch
from elasticsearch_dsl import Search

client = Elasticsearch()

s = Search(using=client, index="my-index") \
    .filter("term", category="search") \
    .query("match", title="python")   \
    .exclude("match", description="beta")

s.aggs.bucket('per_tag', 'terms', field='tags') \
    .metric('max_lines', 'max', field='lines')

response = s.execute()

for hit in response:
    print(hit.meta.score, hit.title)

for tag in response.aggregations.per_tag.buckets:
    print(tag.key, tag.max_lines.value)

如您所见，库已经处理了以下内容：

• 通过名称（例如“匹配”）创建适当的 Query 对象

• 将查询组合成复合 bool 查询

• 将 term 查询放置在 bool 查询的过滤器上下文中

• 提供对响应数据的方便访问

• 不需要到处使用花括号或方括号

持久化示例

让我们有一个简单的 Python 类，它代表一个博客系统中的文章

from datetime import datetime
from elasticsearch_dsl import Document, Date, Integer, Keyword, Text, connections

# Define a default Elasticsearch client
connections.create_connection(hosts=['localhost'])

class Article(Document):
    title = Text(analyzer='snowball', fields={'raw': Keyword()})
    body = Text(analyzer='snowball')
    tags = Keyword()
    published_from = Date()
    lines = Integer()

    class Index:
        name = 'blog'
        settings = {
          "number_of_shards": 2,
        }

    def save(self, ** kwargs):
        self.lines = len(self.body.split())
        return super(Article, self).save(** kwargs)

    def is_published(self):
        return datetime.now() > self.published_from

# create the mappings in elasticsearch
Article.init()

# create and save and article
article = Article(meta={'id': 42}, title='Hello world!', tags=['test'])
article.body = ''' looong text '''
article.published_from = datetime.now()
article.save()

article = Article.get(id=42)
print(article.is_published())

# Display cluster health
print(connections.get_connection().cluster.health())

在这个例子中，您可以看到

• 提供默认连接

• 定义带有映射配置的字段

• 设置索引名称

• 定义自定义方法

• 重写内置的 .save() 方法以挂钩到持久化生命周期

• 检索并将对象保存到 Elasticsearch 中

• 访问底层客户端以使用其他 API

您可以在文档的持久化章节中看到更多内容。

从 elasticsearch-py 迁移

您不需要将整个应用程序迁移以获得 Python DSL 的好处，您可以通过从现有的 dict 创建 Search 对象，使用 API 修改它，并将其反序列化为 dict 来逐步开始。

body = {...} # insert complicated query here

# Convert to Search object
s = Search.from_dict(body)

# Add some filters, aggregations, queries, ...
s.filter("term", tags="python")

# Convert back to dict to plug back into existing code
body = s.to_dict()

开发

激活虚拟环境（virtualenvs）

$ virtualenv venv
$ source venv/bin/activate

要安装所有必要的开发依赖项，请运行

$ pip install -e '.[develop]'

要运行 elasticsearch-dsl-py 的所有测试，请运行

$ python setup.py test

另外，可以使用位于 test_elasticsearch_dsl 的 run_tests.py 脚本来运行测试套件的子集。以下是一些示例。

# Run all of the tests in `test_elasticsearch_dsl/test_analysis.py`
$ ./run_tests.py test_analysis.py

# Run only the `test_analyzer_serializes_as_name` test.
$ ./run_tests.py test_analysis.py::test_analyzer_serializes_as_name

pytest 会跳过来自 test_elasticsearch_dsl/test_integration 的测试，除非存在一个可以进行连接的 Elasticsearch 实例。默认情况下，测试连接尝试在 localhost:9200 进行，这是根据 elasticsearch-py 的 Connection 类中指定的默认值。由于运行集成测试会对 Elasticsearch 集群造成破坏性更改，因此只有在相关的集群为空时才运行它们。因此，如果位于 localhost:9200 的 Elasticsearch 实例不满足这些要求，可以通过 TEST_ES_SERVER 环境变量指定不同的测试 Elasticsearch 服务器。

$ TEST_ES_SERVER=my-test-server:9201 ./run_tests

文档

文档可在 https://elasticsearch-dsl.elastic.ac.cn 找到。

贡献指南

想要对 Elasticsearch DSL 进行开发吗？太棒了！我们提供了 贡献指南。

许可协议

版权所有 2013 Elasticsearch

在 Apache License 2.0（以下简称“许可证”）下许可；除非遵守许可证规定或书面同意，否则不得使用此文件。您可以在以下位置获得许可证副本：

https://apache.ac.cn/licenses/LICENSE-2.0

除非适用法律要求或书面同意，否则在许可证下分发的软件按“原样”分发，不提供任何形式的保证或条件，无论是明示的还是隐含的。有关许可证的具体语言、权限和限制，请参阅许可证。