如何使用elastic4s为Elasticsearch索引配置ngram_analyzer？

我来帮你解决这个问题——结合你现有的ElasticSearchRepositoryWrapper代码结构，有两种简单的方式来添加指定的ngram分析器配置：

方式一：重写Repository的settings方法（推荐） #

你的SomeClass已经继承了ElasticSearchRepositoryWrapper，只需要在类中额外重写settings方法，把分析器配置定义进去，这样调用createIndexIfNotExists()时就会自动将settings和mapping合并创建索引了。

修改后的代码如下：

class SomeClass(val client: ElasticClient, val config: Config, val configName: String)(implicit val ec: ExecutionContext) extends ElasticSearchRepositoryWrapper[AnotherClass]{
  
  // 重写settings，定义ngram分析器和对应的tokenizer
  override def settings: Option[Settings] = Some(
    Settings(
      "index.analysis.analyzer.ngram_analyzer.filter" -> List("lowercase"),
      "index.analysis.analyzer.ngram_analyzer.tokenizer" -> "my_tokenizer",
      "index.analysis.tokenizer.my_tokenizer.token_chars" -> List("letter", "digit"),
      "index.analysis.tokenizer.my_tokenizer.min_gram" -> "3",
      "index.analysis.tokenizer.my_tokenizer.max_gram" -> "3",
      "index.analysis.tokenizer.my_tokenizer.type" -> "ngram"
    )
  )

  override def mapping: Option[MappingDefinition] = Some(
    properties(
      KeywordField("id"),
      TextField("name").fielddata(true).analyzer("ngram_analyzer"),
      KeywordField("lang"),
      BasicField("order", "long"),
      // 其他字段...
    )
  )
}

这样配置后，当你调用repository.createIndexIfNotExists()，elastic4s会自动把settings和mapping一起应用到新创建的索引上，完全匹配你需要的JSON配置结构。

方式二：手动构建CreateIndex请求 #

如果你的Repository封装没有提供settings重写的入口，或者你需要更灵活的自定义，也可以直接手动构建包含settings和mapping的创建索引请求：

// 替换成你的索引名称
val indexName = "your_target_index"

val createIndexRequest = client.execute {
  createIndex(indexName)
    .settings(
      "index.analysis.analyzer.ngram_analyzer.filter" -> List("lowercase"),
      "index.analysis.analyzer.ngram_analyzer.tokenizer" -> "my_tokenizer",
      "index.analysis.tokenizer.my_tokenizer.token_chars" -> List("letter", "digit"),
      "index.analysis.tokenizer.my_tokenizer.min_gram" -> "3",
      "index.analysis.tokenizer.my_tokenizer.max_gram" -> "3",
      "index.analysis.tokenizer.my_tokenizer.type" -> "ngram"
    )
    .mappings(
      properties(
        KeywordField("id"),
        TextField("name").fielddata(true).analyzer("ngram_analyzer"),
        KeywordField("lang"),
        BasicField("order", "long"),
        // 其他字段...
      )
    )
}

// 处理请求结果
createIndexRequest.onComplete {
  case Success(_) => println(s"索引 $indexName 已成功创建，包含ngram分析器")
  case Failure(e) => println(s"创建索引失败：${e.getMessage}")
}

重要注意事项 #

注意：Elasticsearch的索引settings（尤其是分析器配置）无法在索引创建后修改。如果你的目标索引已经存在，createIndexIfNotExists()不会更新它的settings。这种情况下，你需要先删除旧索引，再重新创建；或者使用索引别名+重建的方式迁移数据，前者对于测试环境更简单，后者适合生产环境避免数据丢失。

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