Skip to content

Conversation

@arvindKandpal-ksolves
Copy link
Contributor

Why I'm doing:

The current documentation uses SELECT 1 as an example to demonstrate Query Profiling. However, SELECT 1 often executes instantly (0ms), causing two main issues for learners:

  1. It sometimes does not appear in SHOW PROFILELIST due to its speed.
  2. It generates an empty or trivial Query Profile tree (no Scan, Join, or Aggregation nodes), which makes it a poor example for explaining how to interpret a profile.

Additionally, I found a typo ("Manged") in the English documentation.

What I'm doing:

  1. Improved Example: I updated docs/en, docs/zh, and docs/ja versions of query_profile_overview.md.

    • Replaced SELECT 1 with SELECT count(*) FROM information_schema.columns;.
    • This query works on any cluster (no user data required) and guarantees the execution of Scan and Aggregation nodes, producing a meaningful profile graph for demonstration.
  2. Typo Fix: Fixed Manged Version -> Managed Version in the English documentation.

Fixes #

What type of PR is this:

  • BugFix
  • Feature
  • Enhancement
  • Refactor
  • UT
  • Doc
  • Tool

Does this PR entail a change in behavior?

  • Yes, this PR will result in a change in behavior.
  • No, this PR will not result in a change in behavior.

If yes, please specify the type of change:

  • Interface/UI changes: syntax, type conversion, expression evaluation, display information
  • Parameter changes: default values, similar parameters but with different default values
  • Policy changes: use new policy to replace old one, functionality automatically enabled
  • Feature removed
  • Miscellaneous: upgrade & downgrade compatibility, etc.

Checklist:

  • I have added test cases for my bug fix or my new feature
  • This pr needs user documentation (for new or modified features or behaviors)
  • I have added documentation for my new feature or new function
  • This is a backport pr

Bugfix cherry-pick branch check:

  • I have checked the version labels which the pr will be auto-backported to the target branch
    • 4.0
    • 3.5
    • 3.4
    • 3.3

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>
@github-actions github-actions bot added documentation Improvements or additions to documentation title needs [type] labels Dec 19, 2025
@arvindKandpal-ksolves
Copy link
Contributor Author

Hi @kevincai , Please review this PR when you have a moment. Thanks!

@arvindKandpal-ksolves arvindKandpal-ksolves changed the title [Docs] Improve Query Profile example and fix typos [Doc] Improve Query Profile example and fix typos Dec 19, 2025
@github-actions
Copy link

[Java-Extensions Incremental Coverage Report]

pass : 0 / 0 (0%)

@github-actions
Copy link

[FE Incremental Coverage Report]

pass : 0 / 0 (0%)

@github-actions
Copy link

[BE Incremental Coverage Report]

pass : 0 / 0 (0%)

Copy link
Contributor

Copilot AI left a 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 1 with SELECT 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:

  1. 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
  2. Typo fix: The correction of "Manged Version" to "Managed Version" is correct.

  3. 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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants