快速入门

编辑

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

要求

编辑
  • Node.js 版本 14.x 或更高版本
  • npm,通常与 Node.js 捆绑在一起

安装

编辑

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

npm install @elastic/elasticsearch

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

连接

编辑

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

const { Client } = require('@elastic/elasticsearch')
const client = new Client({
  node: 'https://...', // Elasticsearch endpoint
  auth: {
    apiKey: { // API key ID and secret
      id: 'foo',
      api_key: 'bar',
    }
  }
})

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

Finding Elasticsearch endpoint

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

Create API key

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

操作

编辑

是时候使用 Elasticsearch 了!本节将引导您完成 Elasticsearch 的基本且最重要的操作。

创建索引

编辑

以下是创建 my_index 索引的方法:

await client.indices.create({ index: 'my_index' })

索引文档

编辑

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

await client.index({
  index: 'my_index',
  id: 'my_document_id',
  document: {
    foo: 'foo',
    bar: 'bar',
  },
})

获取文档

编辑

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

await client.get({
  index: 'my_index',
  id: 'my_document_id',
})

搜索文档

编辑

以下是如何使用客户端创建单一匹配查询:

await client.search({
  query: {
    match: {
      foo: 'foo'
    }
  }
})

更新文档

编辑

以下是如何更新文档,例如添加新字段:

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

删除文档

编辑
await client.delete({
  index: 'my_index',
  id: 'my_document_id',
})

删除索引

编辑
await client.indices.delete({ index: 'my_index' })

进一步阅读

编辑
  • 使用客户端助手可以获得更舒适的 API 体验。
  • 有关如何将数据摄取到 Elastic Cloud 的详细示例,请参阅此页面