---
title: "Elasticsearch API 兼容性配置"
date: 2026-02-22
lastmod: 2026-02-22
description: "控制与 Elasticsearch API 兼容模式的配置说明"
tags: ["API兼容性", "Elasticsearch", "迁移配置"]
summary: "配置项概述 #  elasticsearch.api_compatibility 配置项控制 Easysearch 是否启用与 Elasticsearch 的 API 兼容模式。
   配置项 默认值 说明     elasticsearch.api_compatibility false 启用 ES API 兼容模式     配置说明 #  elasticsearch.api_compatibility #  配置项作用：控制是否启用与 Elasticsearch 的 API 兼容模式。启用后，Easysearch 将尽可能兼容 Elasticsearch 的 API 行为。
默认值：false
配置类型：静态配置
取值范围：
 true：启用 ES API 兼容模式 false：禁用兼容模式（默认）  配置格式：
# 默认配置：禁用兼容模式 elasticsearch.api_compatibility: false # 启用兼容模式 elasticsearch.api_compatibility: true  使用场景 #  启用兼容模式 #  # 启用 ES API 兼容性 elasticsearch."
---


## 配置项概述

`elasticsearch.api_compatibility` 配置项控制 Easysearch 是否启用与 Elasticsearch 的 API 兼容模式。

| 配置项 | 默认值 | 说明 |
|--------|--------|------|
| `elasticsearch.api_compatibility` | false | 启用 ES API 兼容模式 |

---

## 配置说明

## elasticsearch.api_compatibility

**配置项作用**：控制是否启用与 Elasticsearch 的 API 兼容模式。启用后，Easysearch 将尽可能兼容 Elasticsearch 的 API 行为。

**默认值**：`false`

**配置类型**：静态配置

**取值范围**：
- `true`：启用 ES API 兼容模式
- `false`：禁用兼容模式（默认）

**配置格式**：
```yaml
# 默认配置：禁用兼容模式
elasticsearch.api_compatibility: false

# 启用兼容模式
elasticsearch.api_compatibility: true
```

---

## 使用场景

## 启用兼容模式

```yaml
# 启用 ES API 兼容性
elasticsearch.api_compatibility: true
elasticsearch.api_compatibility_version: 7.10.2
```

**适用场景**：
- 从 Elasticsearch 迁移到 Easysearch
- 使用 Elasticsearch 原生客户端连接 Easysearch
- 需要兼容 Elasticsearch 特定的 API 行为

## 禁用兼容模式（默认）

```yaml
# 使用 Easysearch 原生 API
elasticsearch.api_compatibility: false
```

**适用场景**：
- 新项目直接使用 Easysearch
- 使用 Easysearch 优化的客户端
- 不需要向后兼容

---

## 推荐配置

## 迁移场景

```yaml
# 从 ES 迁移到 Easysearch
elasticsearch.api_compatibility: true
elasticsearch.api_compatibility_version: 7.10.2
```

## 新项目

```yaml
# 直接使用 Easysearch
elasticsearch.api_compatibility: false
```

---

## 注意事项

1. **重启生效**：修改此配置需要重启节点
2. **配合使用**：通常与 `elasticsearch.api_compatibility_version` 配合使用
3. **性能影响**：兼容模式可能有轻微性能开销
4. **功能限制**：并非所有 ES 特性都能完全兼容