Skip to content

[Docs] Refine and restructure the Unified External Meta Cache guide#3444

Open
suxiaogang223 wants to merge 5 commits intoapache:masterfrom
suxiaogang223:codex/unified-meta-cache-docs
Open

[Docs] Refine and restructure the Unified External Meta Cache guide#3444
suxiaogang223 wants to merge 5 commits intoapache:masterfrom
suxiaogang223:codex/unified-meta-cache-docs

Conversation

@suxiaogang223
Copy link
Contributor

@suxiaogang223 suxiaogang223 commented Mar 10, 2026

Related PRs

This PR updates the documentation related to the new unified external metadata cache framework introduced in:

What this PR does / why we need it

This PR refines the user guide for the unified external metadata cache (unified-meta-cache.md in both English and Chinese) to improve its readability, structural flow, and accuracy.

Key improvements include:

  1. Structural Reorganization: Moved the "What External Meta Cache Includes" section before the configuration section to help users build a clear mental model of the cache architecture (Catalog vs. Engine level) before applying configurations.
  2. Table Consolidation: Merged the redundant "Support Matrix" and "Catalog-Specific Configuration" tables into a single, high-density reference table to improve lookup efficiency.
  3. Clarified Semantics:
    • Added explicit notes on the logical conditions required for a cache to take effect (e.g., enable=true AND ttl-second > 0 AND capacity > 0).
    • Standardized terminology across the document by renaming <module> to <entry>, strictly aligning with the ENTRY_NAME column in the catalog_meta_cache_statistics system table.
  4. Enhanced Observability Guide: Added detailed descriptions for critical troubleshooting metrics like LOAD_FAILURE_COUNT and LAST_ERROR to help users diagnose upstream metadata service issues.
  5. Emphasized Limitations: Added explicit :::caution blocks to highlight that Hive meta.cache.hive.* properties do not currently support hot-reload via ALTER CATALOG.

Check List

  • English documentation updated
  • Chinese documentation updated

@suxiaogang223 suxiaogang223 force-pushed the codex/unified-meta-cache-docs branch from dcc6924 to ab977ae Compare March 10, 2026 08:15
@suxiaogang223 suxiaogang223 changed the title Docs: clarify unified external meta cache docs [Docs] Refine and restructure the Unified External Meta Cache guide Mar 10, 2026
@suxiaogang223
Copy link
Contributor Author

run buildall

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