[fix](doc) clarify fs.defaultFS conditional-required nature in hive-catalog syntax#3745
Merged
morningman merged 1 commit intoMay 23, 2026
Merged
Conversation
Closed
…atalog syntax In `hive-catalog.mdx` the inline syntax block comment says `'fs.defaultFS' = '<fs_defaultfs>', -- optional`, while the surrounding description (and the existing 2.1 notes) state that this property is required when writing through Doris. Issue apache#3466 surfaced this inconsistency. Update the inline comment to read `-- required for write, optional for read-only` (EN) / `-- 写入必填,只读时可选` (zh) across the current/dev/3.x/4.x/2.1 EN + zh hive-catalog pages. Also add a top-of-page :::note on the 2.1 EN and zh pages: Hive write via Doris is supported only from 2.1.3+ (per release-2.1.3 release notes). Closes apache#3466
6fa9fb5 to
958a289
Compare
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
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 #3466. The hive-catalog page's inline syntax block had
'fs.defaultFS' = '<fs_defaultfs>', -- optional, while the page's own description (and the 2.1 page's note) says this property is required when writing through Doris. The two statements contradicted each other.This PR makes the inline comment match the description across all maintained versions (EN + zh, current/dev/3.x/4.x/2.1):
'fs.defaultFS' = '<fs_defaultfs>', -- required for write, optional for read-only'fs.defaultFS' = '<fs_defaultfs>', -- 写入必填,只读时可选Additionally, the 2.1 pages get a top-of-page
:::noteclarifying that Hive write via Doris is only supported from 2.1.3 onward (per the 2.1.3 release notes) — earlier 2.1.x releases are query-only.Test plan