Skip to content

[core] Fix stale option key in clustering.strategy description - #9602

Open
thswlsqls wants to merge 1 commit into
apache:masterfrom
thswlsqls:fix/clustering-strategy-stale-option-key
Open

[core] Fix stale option key in clustering.strategy description#9602
thswlsqls wants to merge 1 commit into
apache:masterfrom
thswlsqls:fix/clustering-strategy-stale-option-key

Conversation

@thswlsqls

Copy link
Copy Markdown
Contributor

Purpose

  • The description of clustering.strategy says the algorithm is chosen from the number of columns in 'clustering.by-columns', but no such option key exists in Paimon.
  • The primary key is clustering.columns, with sink.clustering.by-columns kept only as its fallback. Users following the current text silently get no clustering.
  • This completes the rename started in 2558c585c (added clustering.columns, made sink.clustering.by-columns a fallback) and continued in 4e7e4188e (dropped the deprecated sink. prefix but kept the old suffix). It does not restore the sink. prefix.
  • docs/generated/core_configuration.html renders the same string, so both files are updated together, matching [core] Fix stale default value in sort-compaction.range-strategy description #9104.

Tests

  • Description string only, no behavior change — no new tests.
  • mvn -pl paimon-api clean install passed (checkstyle, spotless, 184 unit tests).
  • ConfigOptionsDocsCompletenessITCase in paimon-docs passed; reverting only the HTML makes it fail on clustering.strategy.

The description of 'clustering.strategy' referred to
'clustering.by-columns', which is not a valid option key. The primary
key is 'clustering.columns' and its fallback key is
'sink.clustering.by-columns'. Update the description and the generated
configuration table accordingly.

Generated-by: Claude Code
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant