stevqin opened a new issue, #66420: URL: https://github.com/apache/doris/issues/66420
### Search before asking - [x] I had searched in the [issues](https://github.com/apache/doris/issues?q=is%3Aissue) and found no similar issues. ### Description Please add a description field to the result of `SHOW VARIABLES`, preferably as an appended third column so that the existing first two columns remain unchanged. Example: | Variable_name | Value | Description | | --- | --- | --- | | enable_nereids_planner | true | Enables the Nereids query planner. Disabling it may change planner behavior and query performance. | The description should include, where applicable: - what the variable controls; - the consequences and risks of changing it; - valid values or ranges; - scope (session/global); - whether it is dynamic or requires a restart. Ideally, the description should come from a single metadata source in the codebase so that SQL output and documentation remain consistent. Some clients may assume that `SHOW VARIABLES` always returns exactly two columns. If appending a column is considered incompatible, an alternative could be `SHOW VARIABLES EXTENDED` or an equivalent metadata view/table that exposes variable descriptions. ### Use case Currently, `SHOW VARIABLES` returns the variable name and its current value, but it does not explain what each variable controls. Administrators and developers must search the documentation separately to understand a variable's purpose, the effect and risks of changing it, its valid range, scope, and whether a restart is required. This makes variable discovery, troubleshooting, and tuning less efficient, especially when reviewing many variables. I have observed this behavior in Doris 3.1.4 and 4.1.3. Making variables self-describing would improve operational troubleshooting, tuning, and discoverability. ### Related issues No related issue found. I searched the apache/doris issue tracker for SHOW VARIABLES descriptions and variable metadata. ### Are you willing to submit PR? - [ ] Yes I am willing to submit a PR! ### Code of Conduct - [x] I agree to follow this project's [Code of Conduct](https://www.apache.org/foundation/policies/conduct) -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected] --------------------------------------------------------------------- To unsubscribe, e-mail: [email protected] For additional commands, e-mail: [email protected]
