[fix](doc) correct default_compression_type default value and valid values list#3746
Open
boluor wants to merge 1 commit into
Open
[fix](doc) correct default_compression_type default value and valid values list#3746boluor wants to merge 1 commit into
boluor wants to merge 1 commit into
Conversation
…alues list The fe-config doc for `default_compression_type` had two factual errors: 1. Default value: doc said `lz4` (before 4.0.3) / `zstd` (since 4.0.3). The actual FE Config (apache/doris) is `LZ4F` (before 4.0.3) and `ZSTD` (4.0.3+). The default was changed by apache/doris#58923 (label dev/4.0.3-merged) — "change default compression from lz4f to zstd". LZ4 and LZ4F are different algorithms (raw block vs frame format), so `lz4` was simply wrong. 2. Valid values: doc said "lz4, zstd". The Config.java description and `PropertyAnalyzer.stringToCompressionType` accept seven algorithms: LZ4, LZ4F, LZ4HC, ZLIB, ZSTD, SNAPPY, NONE (case-insensitive). Update the doc to reflect the source-of-truth in apache/doris `fe/fe-common/.../common/Config.java` for both current/dev and 4.x, EN + zh. The parameter does not exist in branch-2.1 or branch-3.0, so no edit is needed in the 2.1 docs; the 3.x doc set is missing this parameter entirely, which is a separate gap. Closes apache#3463
Open
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Fixes #3463. The fe-config doc for
default_compression_typehad two factual errors:Default value — doc said
lz4(before 4.0.3) /zstd(since 4.0.3). The actual FE Config in apache/doris isLZ4F(before 4.0.3) andZSTD(since 4.0.3). The default was changed by [opt](compression) change default compression from lz4f to zstd doris#58923 (labeldev/4.0.3-merged) — "opt change default compression from lz4f to zstd".LZ4andLZ4Fare different algorithms (raw block vs frame format), so the previouslz4was simply wrong.Valid values — doc said "lz4, zstd". The
Config.javadescription andPropertyAnalyzer.stringToCompressionTypeactually accept seven algorithms:LZ4,LZ4F,LZ4HC,ZLIB,ZSTD,SNAPPY,NONE(case-insensitive).Source-of-truth references:
fe/fe-common/src/main/java/org/apache/doris/common/Config.java(default_compression_typefield, both pre-58923 and post-58923 values)fe/fe-core/src/main/java/org/apache/doris/common/util/PropertyAnalyzer.java#stringToCompressionType(accepted values)Scope
Updated in 4 places (current/dev EN + zh, 4.x EN + zh):
docs/admin-manual/config/fe-config.mdi18n/zh-CN/docusaurus-plugin-content-docs/current/admin-manual/config/fe-config.mdversioned_docs/version-4.x/admin-manual/config/fe-config.mdi18n/zh-CN/docusaurus-plugin-content-docs/version-4.x/admin-manual/config/fe-config.mdThe parameter does not exist in
branch-2.1orbranch-3.0, so the 2.1 docs need no change.Test plan
LZ4F/ZSTD) and the full valid-values list