入门指南

编辑

本页将指导您完成 Python 客户端的安装过程,向您展示如何实例化客户端,以及如何使用它执行基本的 Elasticsearch 操作。

要求

编辑
  • Python 3.8 或更高版本
  • pip,默认与 Python 一起安装

安装

编辑

要安装最新版本的客户端,请运行以下命令

python -m pip install elasticsearch

请参阅 安装 页面了解更多信息。

连接

编辑

您可以使用 API 密钥和 Elasticsearch 端点连接到 Elastic Cloud。

from elasticsearch import Elasticsearch

client = Elasticsearch(
    "https://...",  # Elasticsearch endpoint
    api_key="api_key",
)

您的 Elasticsearch 端点可以在您的部署的 我的部署 页面上找到

Finding Elasticsearch endpoint

您可以在 管理 页面下的“安全性”中生成 API 密钥。

Create API key

有关其他连接选项,请参阅 连接 部分。

操作

编辑

是时候使用 Elasticsearch 了!本节将引导您完成 Elasticsearch 的基本且最重要的操作。有关更多操作和更高级的示例,请参阅 示例 页面。

创建索引

编辑

这是创建 my_index 索引的方法

client.indices.create(index="my_index")

索引文档

编辑

这是一种简单的索引文档的方式

client.index(
    index="my_index",
    id="my_document_id",
    document={
        "foo": "foo",
        "bar": "bar",
    }
)

获取文档

编辑

您可以使用以下代码获取文档

client.get(index="my_index", id="my_document_id")

搜索文档

编辑

这是如何使用 Python 客户端创建单个匹配查询的方法

client.search(index="my_index", query={
    "match": {
        "foo": "foo"
    }
})

更新文档

编辑

这是如何更新文档的方法,例如添加一个新字段

client.update(index="my_index", id="my_document_id", doc={
    "foo": "bar",
    "new_field": "new value",
})

删除文档

编辑
client.delete(index="my_index", id="my_document_id")

删除索引

编辑
client.indices.delete(index="my_index")

进一步阅读

编辑