-
Notifications
You must be signed in to change notification settings - Fork 2.2k
[Doc] Improve Query Profile example and fix typos #67022
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
[Doc] Improve Query Profile example and fix typos #67022
Conversation
This PR replaces the 'SELECT 1' example with a query on 'information_schema.columns' to ensure a meaningful Query Profile (with Scan and Aggregation nodes) is generated for demonstration.
It also fixes typos ('Manged' -> 'Managed') in the English documentation.
Updates are applied to English, Chinese, and Japanese documentation.
Signed-off-by: arvindksi274-ksolves <arvind.kandpal@ksolves.com>
|
Hi @kevincai , Please review this PR when you have a moment. Thanks! |
[Java-Extensions Incremental Coverage Report]✅ pass : 0 / 0 (0%) |
[FE Incremental Coverage Report]✅ pass : 0 / 0 (0%) |
[BE Incremental Coverage Report]✅ pass : 0 / 0 (0%) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull request overview
This documentation PR improves the Query Profile example in StarRocks documentation by replacing a trivial query (SELECT 1) with a more meaningful example that demonstrates actual query profiling features. The PR also fixes a typo in the English documentation.
- Replaces
SELECT 1withSELECT count(*) FROM information_schema.columns;to provide a query that generates scan and aggregation nodes in the profile - Standardizes SQL command capitalization to uppercase (SET, SELECT, SHOW) for consistency
- Fixes typo "Manged Version" → "Managed Version" in English docs
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| docs/zh/best_practices/query_tuning/query_profile_overview.md | Updates Chinese documentation with improved query example and consistent SQL capitalization |
| docs/ja/best_practices/query_tuning/query_profile_overview.md | Updates Japanese documentation with improved query example and consistent SQL capitalization |
| docs/en/best_practices/query_tuning/query_profile_overview.md | Updates English documentation with improved query example, consistent SQL capitalization, and fixes "Manged" typo |
After thoroughly reviewing all three documentation files, I found no issues with the changes. The improvements are well-justified and implemented consistently across all language versions:
-
Example improvement: The new query
SELECT count(*) FROM information_schema.columns;is indeed more appropriate as it:- Guarantees execution on any cluster without requiring user data
- Generates meaningful profile output with scan and aggregation operations
- Better demonstrates the query profiling capabilities
-
Typo fix: The correction of "Manged Version" to "Managed Version" is correct.
-
Consistency: All three language versions (English, Chinese, Japanese) have been updated consistently with:
- The same improved query example
- Matching query_id values in examples
- Standardized SQL command capitalization (uppercase)
- Proper spacing and formatting
The changes are accurate, improve documentation quality, and maintain consistency across all language versions. No issues were identified.
Why I'm doing:
The current documentation uses
SELECT 1as an example to demonstrate Query Profiling. However,SELECT 1often executes instantly (0ms), causing two main issues for learners:SHOW PROFILELISTdue to its speed.Additionally, I found a typo ("Manged") in the English documentation.
What I'm doing:
Improved Example: I updated
docs/en,docs/zh, anddocs/javersions ofquery_profile_overview.md.SELECT 1withSELECT count(*) FROM information_schema.columns;.Typo Fix: Fixed
Manged Version->Managed Versionin the English documentation.Fixes #
What type of PR is this:
Does this PR entail a change in behavior?
If yes, please specify the type of change:
Checklist:
Bugfix cherry-pick branch check: