This is an automated email from the ASF dual-hosted git repository.
bobhan1 pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/doris-website.git
The following commit(s) were added to refs/heads/master by this push:
new e1a862bec42e Fix event-driven warm-up sync event docs (#3918)
e1a862bec42e is described below
commit e1a862bec42e9bcd25071ec56cc3de57fdb43247
Author: bobhan1 <[email protected]>
AuthorDate: Mon Jun 8 16:25:15 2026 +0800
Fix event-driven warm-up sync event docs (#3918)
## Summary
- Update the read/write separation File Cache warm-up guide to describe
event-driven warm-up as Load-triggered.
- Keep current, version-4.x, and zh-CN mirrored docs aligned.
- Clarify that sync_event should be configured as load.
## Context
CIR-20534 reported that event-driven warm-up documentation incorrectly
suggested non-load events. The Jira conclusion is that users should
configure sync_event as load.
## Validation
- git diff --check
- Docs governance scripts were not run per request.
---
docs/compute-storage-decoupled/rw/read-write-separation.md | 8 ++++----
.../current/compute-storage-decoupled/rw/read-write-separation.md | 8 ++++----
.../compute-storage-decoupled/rw/read-write-separation.md | 8 ++++----
.../compute-storage-decoupled/rw/read-write-separation.md | 8 ++++----
4 files changed, 16 insertions(+), 16 deletions(-)
diff --git a/docs/compute-storage-decoupled/rw/read-write-separation.md
b/docs/compute-storage-decoupled/rw/read-write-separation.md
index 46459e40d51f..2a03fd20603c 100644
--- a/docs/compute-storage-decoupled/rw/read-write-separation.md
+++ b/docs/compute-storage-decoupled/rw/read-write-separation.md
@@ -34,7 +34,7 @@ The File Cache active incremental warm-up feature was
introduced in Apache Doris
File Cache active warm-up supports the following two types of cache
synchronization:
-1. **Event-triggered warm-up**: Automatically triggers synchronization after
write operations such as Load, Compaction, and Schema Change complete, reducing
query jitter.
+1. **Event-triggered warm-up**: Automatically warms up data generated during
Load, Compaction, and Schema Change, reducing query jitter.
2. **Periodic hot-data sync**: Continuously syncs hot-query data to the target
cluster through periodic scanning, ensuring stable performance of the standby
cluster during primary/standby switchover.
---
@@ -50,7 +50,7 @@ The applicable scenarios for the three sync modes are as
follows:
|------|--------|----------|
| One-time sync | `ONCE` | Manually triggered; suitable for initial warm-up
when a new cluster comes online |
| Periodic sync | `PERIODIC` | Scheduled sync of hot data; suitable for
continuous warm-keeping scenarios |
-| Event-driven sync | `EVENT_DRIVEN` | Automatically triggered after Load,
Compaction, or Schema Change operations |
+| Event-driven sync | `EVENT_DRIVEN` | Automatically warms up data generated
during Load, Compaction, and Schema Change |
---
@@ -83,7 +83,7 @@ PROPERTIES (
### Event-Driven Sync
-Suitable for read/write separation scenarios, where new data is automatically
warmed up to the read cluster after a write operation completes:
+Suitable for read/write separation scenarios, where data generated during
Load, Compaction, and Schema Change is automatically warmed up to the read
cluster:
```sql
WARM UP COMPUTE GROUP <target_cluster> WITH COMPUTE GROUP <source_cluster>
@@ -93,7 +93,7 @@ PROPERTIES (
);
```
-- `sync_event`: The type of event that triggers synchronization. Accepted
values include `load`, `compaction`, and `schema_change`.
+- `sync_event`: Set this parameter to `load` when creating an event-driven
warm-up job.
---
diff --git
a/i18n/zh-CN/docusaurus-plugin-content-docs/current/compute-storage-decoupled/rw/read-write-separation.md
b/i18n/zh-CN/docusaurus-plugin-content-docs/current/compute-storage-decoupled/rw/read-write-separation.md
index f13d6385c7c3..c27290d7f4ea 100644
---
a/i18n/zh-CN/docusaurus-plugin-content-docs/current/compute-storage-decoupled/rw/read-write-separation.md
+++
b/i18n/zh-CN/docusaurus-plugin-content-docs/current/compute-storage-decoupled/rw/read-write-separation.md
@@ -34,7 +34,7 @@ File Cache 主动增量预热功能已在 Apache Doris **3.1.0** 版本中引入
File Cache 主动预热支持以下两类缓存同步方式：
-1. **事件触发预热**：在 Load、Compaction、Schema Change 等写操作完成后自动触发同步，减少查询抖动。
+1. **事件触发预热**：自动预热 Load、Compaction、Schema Change 过程中产生的数据，减少查询抖动。
2. **热点周期同步**：通过周期性扫描，持续将热点查询数据同步到目标集群，保障主备切换时备集群性能稳定。
---
@@ -50,7 +50,7 @@ File Cache 主动预热支持以下两类缓存同步方式：
|------|--------|----------|
| 一次性同步 | `ONCE` | 手动触发，适用于新集群上线时的初始预热 |
| 周期性同步 | `PERIODIC` | 定时同步热点数据，适用于持续保温场景 |
-| 事件驱动同步 | `EVENT_DRIVEN` | 导入、Compaction、Schema Change 操作后自动触发 |
+| 事件驱动同步 | `EVENT_DRIVEN` | 自动预热 Load、Compaction、Schema Change 过程中产生的数据 |
---
@@ -83,7 +83,7 @@ PROPERTIES (
### 事件驱动同步
-适用于读写分离场景，在写操作完成后自动将新数据预热到读集群：
+适用于读写分离场景，自动将 Load、Compaction、Schema Change 过程中产生的数据预热到读集群：
```sql
WARM UP COMPUTE GROUP <target_cluster> WITH COMPUTE GROUP <source_cluster>
@@ -93,7 +93,7 @@ PROPERTIES (
);
```
-- `sync_event`：触发事件类型，可选值包括 `load`（导入）、`compaction`（合并）、`schema_change`（结构变更）。
+- `sync_event`：创建事件驱动预热任务时，当前请配置为 `load`。
---
diff --git
a/i18n/zh-CN/docusaurus-plugin-content-docs/version-4.x/compute-storage-decoupled/rw/read-write-separation.md
b/i18n/zh-CN/docusaurus-plugin-content-docs/version-4.x/compute-storage-decoupled/rw/read-write-separation.md
index f13d6385c7c3..c27290d7f4ea 100644
---
a/i18n/zh-CN/docusaurus-plugin-content-docs/version-4.x/compute-storage-decoupled/rw/read-write-separation.md
+++
b/i18n/zh-CN/docusaurus-plugin-content-docs/version-4.x/compute-storage-decoupled/rw/read-write-separation.md
@@ -34,7 +34,7 @@ File Cache 主动增量预热功能已在 Apache Doris **3.1.0** 版本中引入
File Cache 主动预热支持以下两类缓存同步方式：
-1. **事件触发预热**：在 Load、Compaction、Schema Change 等写操作完成后自动触发同步，减少查询抖动。
+1. **事件触发预热**：自动预热 Load、Compaction、Schema Change 过程中产生的数据，减少查询抖动。
2. **热点周期同步**：通过周期性扫描，持续将热点查询数据同步到目标集群，保障主备切换时备集群性能稳定。
---
@@ -50,7 +50,7 @@ File Cache 主动预热支持以下两类缓存同步方式：
|------|--------|----------|
| 一次性同步 | `ONCE` | 手动触发，适用于新集群上线时的初始预热 |
| 周期性同步 | `PERIODIC` | 定时同步热点数据，适用于持续保温场景 |
-| 事件驱动同步 | `EVENT_DRIVEN` | 导入、Compaction、Schema Change 操作后自动触发 |
+| 事件驱动同步 | `EVENT_DRIVEN` | 自动预热 Load、Compaction、Schema Change 过程中产生的数据 |
---
@@ -83,7 +83,7 @@ PROPERTIES (
### 事件驱动同步
-适用于读写分离场景，在写操作完成后自动将新数据预热到读集群：
+适用于读写分离场景，自动将 Load、Compaction、Schema Change 过程中产生的数据预热到读集群：
```sql
WARM UP COMPUTE GROUP <target_cluster> WITH COMPUTE GROUP <source_cluster>
@@ -93,7 +93,7 @@ PROPERTIES (
);
```
-- `sync_event`：触发事件类型，可选值包括 `load`（导入）、`compaction`（合并）、`schema_change`（结构变更）。
+- `sync_event`：创建事件驱动预热任务时，当前请配置为 `load`。
---
diff --git
a/versioned_docs/version-4.x/compute-storage-decoupled/rw/read-write-separation.md
b/versioned_docs/version-4.x/compute-storage-decoupled/rw/read-write-separation.md
index 46459e40d51f..2a03fd20603c 100644
---
a/versioned_docs/version-4.x/compute-storage-decoupled/rw/read-write-separation.md
+++
b/versioned_docs/version-4.x/compute-storage-decoupled/rw/read-write-separation.md
@@ -34,7 +34,7 @@ The File Cache active incremental warm-up feature was
introduced in Apache Doris
File Cache active warm-up supports the following two types of cache
synchronization:
-1. **Event-triggered warm-up**: Automatically triggers synchronization after
write operations such as Load, Compaction, and Schema Change complete, reducing
query jitter.
+1. **Event-triggered warm-up**: Automatically warms up data generated during
Load, Compaction, and Schema Change, reducing query jitter.
2. **Periodic hot-data sync**: Continuously syncs hot-query data to the target
cluster through periodic scanning, ensuring stable performance of the standby
cluster during primary/standby switchover.
---
@@ -50,7 +50,7 @@ The applicable scenarios for the three sync modes are as
follows:
|------|--------|----------|
| One-time sync | `ONCE` | Manually triggered; suitable for initial warm-up
when a new cluster comes online |
| Periodic sync | `PERIODIC` | Scheduled sync of hot data; suitable for
continuous warm-keeping scenarios |
-| Event-driven sync | `EVENT_DRIVEN` | Automatically triggered after Load,
Compaction, or Schema Change operations |
+| Event-driven sync | `EVENT_DRIVEN` | Automatically warms up data generated
during Load, Compaction, and Schema Change |
---
@@ -83,7 +83,7 @@ PROPERTIES (
### Event-Driven Sync
-Suitable for read/write separation scenarios, where new data is automatically
warmed up to the read cluster after a write operation completes:
+Suitable for read/write separation scenarios, where data generated during
Load, Compaction, and Schema Change is automatically warmed up to the read
cluster:
```sql
WARM UP COMPUTE GROUP <target_cluster> WITH COMPUTE GROUP <source_cluster>
@@ -93,7 +93,7 @@ PROPERTIES (
);
```
-- `sync_event`: The type of event that triggers synchronization. Accepted
values include `load`, `compaction`, and `schema_change`.
+- `sync_event`: Set this parameter to `load` when creating an event-driven
warm-up job.
---
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
