-
Notifications
You must be signed in to change notification settings - Fork 29k
[SPARK-30589][DOC] Document DISTRIBUTE BY Clause of SELECT statement in SQL Reference #27298
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
Closed
dilipbiswal
wants to merge
4
commits into
apache:master
from
dilipbiswal:sql-ref-select-distributeby
Closed
Changes from all commits
Commits
Show all changes
4 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,84 @@ | ||
| --- | ||
| layout: global | ||
| title: DISTRIBUTE BY Clause | ||
| displayTitle: DISTRIBUTE BY Clause | ||
| license: | | ||
| Licensed to the Apache Software Foundation (ASF) under one or more | ||
| contributor license agreements. See the NOTICE file distributed with | ||
| this work for additional information regarding copyright ownership. | ||
| The ASF licenses this file to You under the Apache License, Version 2.0 | ||
| (the "License"); you may not use this file except in compliance with | ||
| the License. You may obtain a copy of the License at | ||
|
|
||
| http://www.apache.org/licenses/LICENSE-2.0 | ||
|
|
||
| Unless required by applicable law or agreed to in writing, software | ||
| distributed under the License is distributed on an "AS IS" BASIS, | ||
| WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| See the License for the specific language governing permissions and | ||
| limitations under the License. | ||
| --- | ||
| The <code>DISTRIBUTE BY</code> clause is used to repartition the data based | ||
| on the input expressions. Unlike the `CLUSTER BY` clause, this does not | ||
| sort the data within each partition. | ||
|
|
||
| ### Syntax | ||
| {% highlight sql %} | ||
| DISTRIBUTE BY { expression [ , ... ] } | ||
| {% endhighlight %} | ||
|
|
||
| ### Parameters | ||
| <dl> | ||
| <dt><code><em>expression</em></code></dt> | ||
| <dd> | ||
| Specifies combination of one or more values, operators and SQL functions that results in a value. | ||
| </dd> | ||
| </dl> | ||
|
|
||
| ### Examples | ||
| {% highlight sql %} | ||
| CREATE TABLE person (name STRING, age INT); | ||
| INSERT INTO person VALUES | ||
| ('Zen Hui', 25), | ||
| ('Anil B', 18), | ||
| ('Shone S', 16), | ||
| ('Mike A', 25), | ||
| ('John A', 18), | ||
| ('Jack N', 16); | ||
|
|
||
| -- Reduce the number of shuffle partitions to 2 to illustrate the behavior of `DISTRIBUTE BY`. | ||
| -- It's easier to see the clustering and sorting behavior with less number of partitions. | ||
| SET spark.sql.shuffle.partitions = 2; | ||
|
|
||
| -- Select the rows with no ordering. Please note that without any sort directive, the result | ||
| -- of the query is not deterministic. It's included here to just contrast it with the | ||
| -- behavior of `DISTRIBUTE BY`. The query below produces rows where age columns are not | ||
| -- clustered together. | ||
| SELECT age, name FROM person; | ||
|
|
||
| +---+-------+ | ||
| |age|name | | ||
| +---+-------+ | ||
| |16 |Shone S| | ||
| |25 |Zen Hui| | ||
| |16 |Jack N | | ||
| |25 |Mike A | | ||
| |18 |John A | | ||
| |18 |Anil B | | ||
| +---+-------+ | ||
|
|
||
| -- Produces rows clustered by age. Persons with same age are clustered together. | ||
| -- Unlike `CLUSTER BY` clause, the rows are not sorted within a partition. | ||
| SELECT age, name FROM person DISTRIBUTE BY age; | ||
|
|
||
| +---+-------+ | ||
| |age|name | | ||
| +---+-------+ | ||
| |25 |Zen Hui| | ||
| |25 |Mike A | | ||
| |18 |John A | | ||
| |18 |Anil B | | ||
| |16 |Shone S| | ||
| |16 |Jack N | | ||
| +---+-------+ | ||
| {% endhighlight %} | ||
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.
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.
link to
CLUSTER BY?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.
@huaxingao will do it in the finalization pr when the links are available.