elasticsearch-dsl 8.15.3

安装

pip install elasticsearch-dsl

示例

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

兼容性

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

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

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

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

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

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

在您的setup.py或requirements.txt中设置要求的最推荐方式是

# Elasticsearch 8.x
elasticsearch-dsl>=8.0.0,<9.0.0

# Elasticsearch 7.x
elasticsearch-dsl>=7.0.0,<8.0.0

# 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

开发在main分支上，旧分支只获取错误修复版本

搜索示例

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

from elasticsearch import Elasticsearch
client = Elasticsearch("https://localhost:9200")

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("https://localhost:9200")

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)

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

• 通过名称（例如“match”）创建适当的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="https://localhost:9200")

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()

开发

激活虚拟环境（虚拟环境）

$ virtualenv venv
$ source venv/bin/activate

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

$ pip install -e '.[develop]'

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

$ python setup.py test

或者，可以使用位于test_elasticsearch_dsl中的run_tests.py脚本来运行测试套件的子集，该脚本封装了pytest。以下是一些示例

# 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 许可证 2.0 版（“许可证”）；除非遵守许可证，否则不得使用此文件。您可以在以下位置获得许可证副本：

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

除非适用法律要求或书面同意，否则在许可证下分发的软件按“原样”提供，不提供任何明示或暗示的保证或条件。有关许可证中规定的具体语言管理许可和限制，请参阅许可证。