Node.js调用Elasticsearch时preference参数报错的解决咨询

原因 #

Elasticsearch的preference是URL查询参数，不属于请求体（body）的一部分，直接将其放在search方法的body里会触发字段不存在的错误。

解决方案 #

根据你使用的Elasticsearch客户端版本，分两种方式处理：

情况1：使用官方@elastic/elasticsearch客户端（v7+） #

调用search方法时，将preference作为客户端方法的顶层参数传递，而非嵌套在body内：

const { Client } = require('@elastic/elasticsearch');
const client = new Client({ node: 'http://your-es-host:9200' });

async function searchWithPreference() {
  const result = await client.search({
    index: 'your-index-name',
    preference: 'your-custom-value', // 直接作为顶层参数传入
    body: {
      // 你的查询逻辑，比如match、filter等
      query: {
        match: { title: 'elasticsearch' }
      }
    }
  });
  console.log(result.hits.hits);
}

searchWithPreference();

情况2：使用旧版elasticsearch客户端（v6及以下） #

旧版客户端参数结构类似，同样把preference放在顶层配置中：

const elasticsearch = require('elasticsearch');
const client = new elasticsearch.Client({ host: 'http://your-es-host:9200' });

client.search({
  index: 'your-index-name',
  preference: 'your-custom-value', // 顶层参数
  body: {
    query: {
      match: { title: 'elasticsearch' }
    }
  }
}, (err, result) => {
  if (err) console.error(err);
  else console.log(result.hits.hits);
});

逻辑验证 #

Kibana中通过URL参数?preference=xxx有效，本质是将参数放在了URL查询串中，和客户端传递顶层参数的逻辑一致——客户端会自动把这些顶层参数拼接到请求URL的查询部分，而非塞进请求体。

内容的提问来源于stack exchange，提问作者Emily