This is an automated email from the ASF dual-hosted git repository.
lzljs3620320 pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/paimon.git
The following commit(s) were added to refs/heads/master by this push:
new ef459612a5 [doc] Append table adds compact option doc (#6076)
ef459612a5 is described below
commit ef459612a527373badc2cfa04c3599affadf07e9
Author: yuzelin <[email protected]>
AuthorDate: Mon Aug 18 10:40:35 2025 +0800
[doc] Append table adds compact option doc (#6076)
---
docs/content/append-table/streaming.md | 33 +++++++++++++++++++++++++++++++++
1 file changed, 33 insertions(+)
diff --git a/docs/content/append-table/streaming.md
b/docs/content/append-table/streaming.md
index 3d843e4dbb..49f44a7f13 100644
--- a/docs/content/append-table/streaming.md
+++ b/docs/content/append-table/streaming.md
@@ -58,6 +58,39 @@ If you set `write-only` to true, the `Compact Coordinator`
and `Compact Worker`
The auto compaction is only supported in Flink engine streaming mode. You can
also start a compaction job in Flink by
Flink action in Paimon and disable all the other compactions by setting
`write-only`.
+The following options control the strategy of compaction:
+
+<table class="configuration table table-bordered">
+ <thead>
+ <tr>
+ <th class="text-left" style="width: 20%">Key</th>
+ <th class="text-left" style="width: 15%">Default</th>
+ <th class="text-left" style="width: 10%">Type</th>
+ <th class="text-left" style="width: 55%">Description</th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td><h5>write-only</h5></td>
+ <td style="word-wrap: break-word;">false</td>
+ <td>Boolean</td>
+ <td>If set to true, compactions and snapshot expiration will be
skipped. This option is used along with dedicated compact jobs.</td>
+ </tr>
+ <tr>
+ <td><h5>compaction.min.file-num</h5></td>
+ <td style="word-wrap: break-word;">5</td>
+ <td>Integer</td>
+ <td>For file set [f_0,...,f_N], the minimum file number to trigger
a compaction for append table.</td>
+ </tr>
+ <tr>
+ <td><h5>compaction.delete-ratio-threshold</h5></td>
+ <td style="word-wrap: break-word;">(none)</td>
+ <td>Double</td>
+ <td>Ratio of the deleted rows in a data file to be forced
compacted.</td>
+ </tr>
+ </tbody>
+</table>
+
## Streaming Query
You can stream the Append table and use it like a Message Queue. As with
primary key tables, there are two options
