You are viewing a plain text version of this content. The canonical link for it is here.
Posted to reviews@spark.apache.org by GitBox <gi...@apache.org> on 2022/06/09 08:45:50 UTC

[GitHub] [spark] dcoliversun opened a new pull request, #36820: [SPARK-39428][DOC] Use code block for Coalesce-Hints-for-SQL-Queries

dcoliversun opened a new pull request, #36820:
URL: https://github.com/apache/spark/pull/36820

   <!--
   Thanks for sending a pull request!  Here are some tips for you:
     1. If this is your first time, please read our contributor guidelines: https://spark.apache.org/contributing.html
     2. Ensure you have added or run the appropriate tests for your PR: https://spark.apache.org/developer-tools.html
     3. If the PR is unfinished, add '[WIP]' in your PR title, e.g., '[WIP][SPARK-XXXX] Your PR title ...'.
     4. Be sure to keep the PR description updated to reflect all changes.
     5. Please write your PR title to summarize what this PR proposes.
     6. If possible, provide a concise example to reproduce the issue for a faster review.
     7. If you want to add a new configuration, please read the guideline first for naming configurations in
        'core/src/main/scala/org/apache/spark/internal/config/ConfigEntry.scala'.
     8. If you want to add or modify an error type or message, please read the guideline first in
        'core/src/main/resources/error/README.md'.
   -->
   
   ### What changes were proposed in this pull request?
   <!--
   Please clarify what changes you are proposing. The purpose of this section is to outline the changes and how this PR fixes the issue. 
   If possible, please consider writing useful notes for better and faster reviews in your PR. See the examples below.
     1. If you refactor some codes with changing classes, showing the class hierarchy will help reviewers.
     2. If you fix some SQL features, you can provide some references of other DBMSes.
     3. If there is design documentation, please add the link.
     4. If there is a discussion in the mailing list, please add the link.
   -->
   This PR aims to use code block for `Coalesce Hints for SQL Queries` in `sql-performance-tuning.md`.
   
   ### Why are the changes needed?
   <!--
   Please clarify why the changes are needed. For instance,
     1. If you propose a new API, clarify the use case for a new API.
     2. If you fix a bug, you can clarify why it is a bug.
   -->
   ![image](https://user-images.githubusercontent.com/44011673/172803691-d0cf50d3-9efa-47a9-955a-83e8f6e6ded4.png)
   In Coalesce Hints for SQL Queries, SQL statements is in plain block, not in SQL code block.
   
   ### Does this PR introduce _any_ user-facing change?
   <!--
   Note that it means *any* user-facing change including all aspects such as the documentation fix.
   If yes, please clarify the previous behavior and the change this PR proposes - provide the console output, description and/or an example to show the behavior difference if possible.
   If possible, please also clarify if this is a user-facing change compared to the released Spark versions or within the unreleased branches such as master.
   If no, write 'No'.
   -->
   No.
   
   ### How was this patch tested?
   <!--
   If tests were added, say they were added here. Please make sure to add some test cases that check the changes thoroughly including negative and positive cases if possible.
   If it was tested in a way different from regular unit tests, please clarify how you tested step by step, ideally copy and paste-able, so that other reviewers can test and check, and descendants can verify in the future.
   If tests were not added, please describe why they were not added and/or why it was difficult to add.
   If benchmark tests were added, please run the benchmarks in GitHub Actions for the consistent environment, and the instructions could accord to: https://spark.apache.org/developer-tools.html#github-workflow-benchmarks.
   -->
   Change of document, so no need to add test.


-- 
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: reviews-unsubscribe@spark.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


---------------------------------------------------------------------
To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org
For additional commands, e-mail: reviews-help@spark.apache.org

[GitHub] [spark] dcoliversun commented on a diff in pull request #36820: [SPARK-39428][DOC] Use code block for Coalesce-Hints-for-SQL-Queries

Posted by GitBox <gi...@apache.org>.
dcoliversun commented on code in PR #36820:
URL: https://github.com/apache/spark/pull/36820#discussion_r894120786


##########
docs/sql-performance-tuning.md:
##########
@@ -222,17 +222,19 @@ parameter. The "REPARTITION" hint has a partition number, columns, or both/neith
 The "REPARTITION_BY_RANGE" hint must have column names and a partition number is optional. The "REBALANCE"
 hint has an initial partition number, columns, or both/neither of them as parameters.
 
-    SELECT /*+ COALESCE(3) */ * FROM t
-    SELECT /*+ REPARTITION(3) */ * FROM t
-    SELECT /*+ REPARTITION(c) */ * FROM t
-    SELECT /*+ REPARTITION(3, c) */ * FROM t
-    SELECT /*+ REPARTITION */ * FROM t
-    SELECT /*+ REPARTITION_BY_RANGE(c) */ * FROM t
-    SELECT /*+ REPARTITION_BY_RANGE(3, c) */ * FROM t
-    SELECT /*+ REBALANCE */ * FROM t
-    SELECT /*+ REBALANCE(3) */ * FROM t
-    SELECT /*+ REBALANCE(c) */ * FROM t
-    SELECT /*+ REBALANCE(3, c) */ * FROM t
+```sql

Review Comment:
   Thanks. I think no need use `{% highlight sql %}`.
   * SQL Code block as follow
   https://github.com/apache/spark/blob/c480c66d06af9076b9c4af79e51526a054670a06/docs/sql-ref-ansi-compliance.md?plain=1#L45-L67
   
   * Document Page built as follow
   ![image](https://user-images.githubusercontent.com/44011673/172983757-a8cb8e75-8918-4a4d-9b2f-67fb3df48c68.png)
   



-- 
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: reviews-unsubscribe@spark.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


---------------------------------------------------------------------
To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org
For additional commands, e-mail: reviews-help@spark.apache.org

[GitHub] [spark] huaxingao commented on a diff in pull request #36820: [SPARK-39428][DOC] Use code block for Coalesce-Hints-for-SQL-Queries

Posted by GitBox <gi...@apache.org>.
huaxingao commented on code in PR #36820:
URL: https://github.com/apache/spark/pull/36820#discussion_r893717557


##########
docs/sql-performance-tuning.md:
##########
@@ -222,17 +222,19 @@ parameter. The "REPARTITION" hint has a partition number, columns, or both/neith
 The "REPARTITION_BY_RANGE" hint must have column names and a partition number is optional. The "REBALANCE"
 hint has an initial partition number, columns, or both/neither of them as parameters.
 
-    SELECT /*+ COALESCE(3) */ * FROM t
-    SELECT /*+ REPARTITION(3) */ * FROM t
-    SELECT /*+ REPARTITION(c) */ * FROM t
-    SELECT /*+ REPARTITION(3, c) */ * FROM t
-    SELECT /*+ REPARTITION */ * FROM t
-    SELECT /*+ REPARTITION_BY_RANGE(c) */ * FROM t
-    SELECT /*+ REPARTITION_BY_RANGE(3, c) */ * FROM t
-    SELECT /*+ REBALANCE */ * FROM t
-    SELECT /*+ REBALANCE(3) */ * FROM t
-    SELECT /*+ REBALANCE(c) */ * FROM t
-    SELECT /*+ REBALANCE(3, c) */ * FROM t
+```sql
+SELECT /*+ COALESCE(3) */ * FROM t
+SELECT /*+ REPARTITION(3) */ * FROM t
+SELECT /*+ REPARTITION(c) */ * FROM t
+SELECT /*+ REPARTITION(3, c) */ * FROM t
+SELECT /*+ REPARTITION */ * FROM t
+SELECT /*+ REPARTITION_BY_RANGE(c) */ * FROM t
+SELECT /*+ REPARTITION_BY_RANGE(3, c) */ * FROM t
+SELECT /*+ REBALANCE */ * FROM t
+SELECT /*+ REBALANCE(3) */ * FROM t
+SELECT /*+ REBALANCE(c) */ * FROM t
+SELECT /*+ REBALANCE(3, c) */ * FROM t

Review Comment:
   nit: Could you add `;` to the end of each of these SQL statements?



-- 
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: reviews-unsubscribe@spark.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


---------------------------------------------------------------------
To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org
For additional commands, e-mail: reviews-help@spark.apache.org

[GitHub] [spark] yaooqinn commented on a diff in pull request #36820: [SPARK-39428][DOC] Use code block for Coalesce-Hints-for-SQL-Queries

Posted by GitBox <gi...@apache.org>.
yaooqinn commented on code in PR #36820:
URL: https://github.com/apache/spark/pull/36820#discussion_r894112358


##########
docs/sql-performance-tuning.md:
##########
@@ -222,17 +222,19 @@ parameter. The "REPARTITION" hint has a partition number, columns, or both/neith
 The "REPARTITION_BY_RANGE" hint must have column names and a partition number is optional. The "REBALANCE"
 hint has an initial partition number, columns, or both/neither of them as parameters.
 
-    SELECT /*+ COALESCE(3) */ * FROM t
-    SELECT /*+ REPARTITION(3) */ * FROM t
-    SELECT /*+ REPARTITION(c) */ * FROM t
-    SELECT /*+ REPARTITION(3, c) */ * FROM t
-    SELECT /*+ REPARTITION */ * FROM t
-    SELECT /*+ REPARTITION_BY_RANGE(c) */ * FROM t
-    SELECT /*+ REPARTITION_BY_RANGE(3, c) */ * FROM t
-    SELECT /*+ REBALANCE */ * FROM t
-    SELECT /*+ REBALANCE(3) */ * FROM t
-    SELECT /*+ REBALANCE(c) */ * FROM t
-    SELECT /*+ REBALANCE(3, c) */ * FROM t
+```sql

Review Comment:
   how about use `{% highlight sql %}` like other SQL highlights in this doc



##########
docs/sql-performance-tuning.md:
##########
@@ -222,17 +222,19 @@ parameter. The "REPARTITION" hint has a partition number, columns, or both/neith
 The "REPARTITION_BY_RANGE" hint must have column names and a partition number is optional. The "REBALANCE"
 hint has an initial partition number, columns, or both/neither of them as parameters.
 
-    SELECT /*+ COALESCE(3) */ * FROM t
-    SELECT /*+ REPARTITION(3) */ * FROM t
-    SELECT /*+ REPARTITION(c) */ * FROM t
-    SELECT /*+ REPARTITION(3, c) */ * FROM t
-    SELECT /*+ REPARTITION */ * FROM t
-    SELECT /*+ REPARTITION_BY_RANGE(c) */ * FROM t
-    SELECT /*+ REPARTITION_BY_RANGE(3, c) */ * FROM t
-    SELECT /*+ REBALANCE */ * FROM t
-    SELECT /*+ REBALANCE(3) */ * FROM t
-    SELECT /*+ REBALANCE(c) */ * FROM t
-    SELECT /*+ REBALANCE(3, c) */ * FROM t
+```sql

Review Comment:
   how about using `{% highlight sql %}` like other SQL highlights in this doc



-- 
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: reviews-unsubscribe@spark.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


---------------------------------------------------------------------
To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org
For additional commands, e-mail: reviews-help@spark.apache.org

[GitHub] [spark] AmplabJenkins commented on pull request #36820: [SPARK-39428][DOC] Use code block for Coalesce-Hints-for-SQL-Queries

Posted by GitBox <gi...@apache.org>.
AmplabJenkins commented on PR #36820:
URL: https://github.com/apache/spark/pull/36820#issuecomment-1151878079

   Can one of the admins verify this patch?


-- 
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: reviews-unsubscribe@spark.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


---------------------------------------------------------------------
To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org
For additional commands, e-mail: reviews-help@spark.apache.org

[GitHub] [spark] wangyum commented on pull request #36820: [SPARK-39428][DOC] Use code block for Coalesce-Hints-for-SQL-Queries

Posted by GitBox <gi...@apache.org>.
wangyum commented on PR #36820:
URL: https://github.com/apache/spark/pull/36820#issuecomment-1152067827

   Merged to master.


-- 
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: reviews-unsubscribe@spark.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


---------------------------------------------------------------------
To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org
For additional commands, e-mail: reviews-help@spark.apache.org

[GitHub] [spark] wangyum closed pull request #36820: [SPARK-39428][DOC] Use code block for Coalesce-Hints-for-SQL-Queries

Posted by GitBox <gi...@apache.org>.
wangyum closed pull request #36820: [SPARK-39428][DOC] Use code block for Coalesce-Hints-for-SQL-Queries
URL: https://github.com/apache/spark/pull/36820


-- 
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: reviews-unsubscribe@spark.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


---------------------------------------------------------------------
To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org
For additional commands, e-mail: reviews-help@spark.apache.org

[GitHub] [spark] dcoliversun commented on a diff in pull request #36820: [SPARK-39428][DOC] Use code block for Coalesce-Hints-for-SQL-Queries

Posted by GitBox <gi...@apache.org>.
dcoliversun commented on code in PR #36820:
URL: https://github.com/apache/spark/pull/36820#discussion_r894079306


##########
docs/sql-performance-tuning.md:
##########
@@ -222,17 +222,19 @@ parameter. The "REPARTITION" hint has a partition number, columns, or both/neith
 The "REPARTITION_BY_RANGE" hint must have column names and a partition number is optional. The "REBALANCE"
 hint has an initial partition number, columns, or both/neither of them as parameters.
 
-    SELECT /*+ COALESCE(3) */ * FROM t
-    SELECT /*+ REPARTITION(3) */ * FROM t
-    SELECT /*+ REPARTITION(c) */ * FROM t
-    SELECT /*+ REPARTITION(3, c) */ * FROM t
-    SELECT /*+ REPARTITION */ * FROM t
-    SELECT /*+ REPARTITION_BY_RANGE(c) */ * FROM t
-    SELECT /*+ REPARTITION_BY_RANGE(3, c) */ * FROM t
-    SELECT /*+ REBALANCE */ * FROM t
-    SELECT /*+ REBALANCE(3) */ * FROM t
-    SELECT /*+ REBALANCE(c) */ * FROM t
-    SELECT /*+ REBALANCE(3, c) */ * FROM t
+```sql
+SELECT /*+ COALESCE(3) */ * FROM t
+SELECT /*+ REPARTITION(3) */ * FROM t
+SELECT /*+ REPARTITION(c) */ * FROM t
+SELECT /*+ REPARTITION(3, c) */ * FROM t
+SELECT /*+ REPARTITION */ * FROM t
+SELECT /*+ REPARTITION_BY_RANGE(c) */ * FROM t
+SELECT /*+ REPARTITION_BY_RANGE(3, c) */ * FROM t
+SELECT /*+ REBALANCE */ * FROM t
+SELECT /*+ REBALANCE(3) */ * FROM t
+SELECT /*+ REBALANCE(c) */ * FROM t
+SELECT /*+ REBALANCE(3, c) */ * FROM t

Review Comment:
   Fine :)



-- 
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: reviews-unsubscribe@spark.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


---------------------------------------------------------------------
To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org
For additional commands, e-mail: reviews-help@spark.apache.org