Skip to content

[docs](file-cache) Document file cache enabled by default since 4.2 - #4202

Merged
morningman merged 1 commit into
apache:masterfrom
hubgeter:file-cache-default-4.2
Oct 10, 2026
Merged

morningman merged 1 commit into
apache:masterfrom
hubgeter:file-cache-default-4.2

Conversation

@hubgeter

@hubgeter hubgeter commented Oct 9, 2026 •

Copy link
Copy Markdown
Contributor

What problem does this PR solve?

Apache Doris enables the block file cache by default since 4.2: both the BE config enable_file_cache and the session variable enable_file_cache default to true (apache/doris#66684, apache/doris#68797). The docs still described the old behavior (false for non-cloud mode, and "disabled by default" for Data Cache).

What is changed?

  • enable_file_cache default updated from false to true in the BE config reference, the Data Cache page, and the compute-storage-decoupled File Cache page.
  • Clarified that an external file scan reads through the cache only when the BE config, the session variable, and cache admission control are all enabled; the session variable has no effect on internal tables.
  • Added caveats for the new default: the default cache path ${DORIS_HOME}/file_cache may grow until the disk is 85%–88% full (bound it with total_size, or set enable_file_cache = false to keep the old behavior); BE configs are not persisted while session variables are persisted in the FE image, so a cluster upgraded from an older version keeps its previous value and needs SET GLOBAL enable_file_cache = true to cache external tables.
  • Applied to docs/ (dev) and versioned_docs/version-4.x/, English and Chinese.

Versions

  • dev
  • 4.x
  • 3.x
  • 2.1 or older (not covered by version/language sync gate)

Languages

  • Chinese
  • English

Docs Checklist

  • Checked by AI
  • Test Cases Built
  • Updated required version and language counterparts, or explained why not
  • If only one language changed, confirmed whether source/translation counterparts need sync

The block file cache is enabled by default since Doris 4.2: both the BE config enable_file_cache and the session variable enable_file_cache default to true (apache/doris#66684, apache/doris#68797).

- Update the documented default of the BE config and the session variable.
- Clarify that an external file scan reads through the cache only when the BE config, the session variable, and cache admission control are all enabled.
- Add caveats: the default cache path ${DORIS_HOME}/file_cache may grow until the disk is 85%-88% full; BE configs are not persisted while session variables are, so a cluster upgraded from an older version needs SET GLOBAL enable_file_cache = true to cache external tables.
- Applied to dev and 4.x docs, English and Chinese.
@hubgeter

hubgeter commented Oct 9, 2026

Copy link
Copy Markdown
Contributor Author

run buildall

@morningman
morningman merged commit e778825 into apache:master Oct 10, 2026
3 checks passed

This branch was previously deployed

1 inactive deployment
Production — 799cc60e Deployed Oct 9, 2026 by hubgeter via Build Check #8467
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.

2 participants