[spark] Extend get_cluster_configs procedure output with default value, is_default and description columns#3690
Open
XuQianJin-Stars wants to merge 1 commit into
Conversation
…e, is_default and description columns
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.
Purpose
Linked issue: close #xxx
Extend the
sys.get_cluster_configsSpark procedure output so users can inspect not only the current value and source of each cluster config, but also its declared default value, whether the current value equals the default, and a human-readable description. This makes the procedure far more useful for diagnostics and onboarding.Brief change log
GetClusterConfigsProcedureoutput schema from 3 columns to 6 columns:config_key(String)config_value(String)config_source(String:DYNAMIC/STATIC/DEFAULT)default_value(String, nullable)is_default(Boolean)description(String, nullable)config_key -> ConfigOptionlookup by reflecting over the staticConfigOptionsfields, so known keys are enriched with their declared default value, default flag, and description.ConfigOptions):default_valueanddescriptionareNULL, andis_defaultis reported astrue.procedures.md) with the new columns and usage examples.GetClusterConfigsProcedureTestwith assertions covering the new columns.Tests
GetClusterConfigsProcedureTest:default_value,is_default, anddescriptionfor an overridden key (e.g.kv.snapshot.interval).NULLdefault andis_default = true.API and Format
sys.get_cluster_configsprocedure is extended. This is an additive change; existing columns keep their positions. Downstream consumers reading by column index should be aware of the new trailing columns.Documentation
website/docs/engine-spark/procedures.mdto document the three new output columns and provide example output.