Skip to content

Commit aedeea9

Browse files
committed
add docs
1 parent afb2960 commit aedeea9

File tree

1 file changed

+32
-5
lines changed

1 file changed

+32
-5
lines changed

docs/content/append-table/incremental-clustering.md

Lines changed: 32 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -39,12 +39,15 @@ gradually converges to an optimal state, significantly reducing the decision-mak
3939

4040

4141
Incremental Clustering supports:
42-
- Support incremental clustering; minimizing write amplification as possible.
43-
- Support small-file compaction; during rewrites, respect target-file-size.
44-
- Support changing clustering keys; newly ingested data is clustered according to the latest clustering keys.
45-
- Provide a full mode; when selected, the entire dataset will be reclustered.
42+
- Support incremental clustering: minimizing write amplification as possible.
43+
- Support small-file compaction: during rewrites, respect target-file-size.
44+
- Support changing clustering keys: newly ingested data is clustered according to the latest clustering keys.
45+
- Provide a full mode: when in full mode, the entire dataset will be reclustered.
4646

47-
**Only append unaware-bucket table supports Incremental Clustering.**
47+
48+
**Note**: If data ordering within bucketed tables is not a concern, you can set `'bucket-append-ordered'` to `false`
49+
to disable this ordering requirement. This allows you to enable Incremental Clustering for bucketed tables,
50+
which can significantly improve query performance for specific query keys.
4851

4952
## Enable Incremental Clustering
5053

@@ -85,6 +88,30 @@ To enable Incremental Clustering, the following configuration needs to be set fo
8588

8689
</table>
8790

91+
For bucketed tables, you also need to set the following configuration:
92+
<table class="table table-bordered">
93+
<thead>
94+
<tr>
95+
<th class="text-left" style="width: 20%">Option</th>
96+
<th class="text-left" style="width: 10%">Value</th>
97+
<th class="text-left" style="width: 5%">Required</th>
98+
<th class="text-left" style="width: 10%">Type</th>
99+
<th class="text-left" style="width: 55%">Description</th>
100+
</tr>
101+
</thead>
102+
<tbody>
103+
<tr>
104+
<td><h5>bucket-append-ordered</h5></td>
105+
<td>false</td>
106+
<td style="word-wrap: break-word;">Yes</td>
107+
<td>Boolean</td>
108+
<td>Must be set to false to disable the ordering requirement for bucketed tables. Default is true.</td>
109+
</tr>
110+
</tbody>
111+
112+
</table>
113+
114+
88115
Once Incremental Clustering for a table is enabled, you can run Incremental Clustering in batch mode periodically
89116
to continuously optimizes data layout of the table and deliver better query performance.
90117

0 commit comments

Comments
 (0)