-
Notifications
You must be signed in to change notification settings - Fork 29.3k
[SPARK-58520][SQL] Document dynamic table options in SQL reference #57724
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
Open
marcuslin123
wants to merge
1
commit into
apache:master
Choose a base branch
from
marcuslin123:codex/SPARK-58520-doc-dynamic-table-options
base: master
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+61
−3
Open
Changes from all commits
Commits
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
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 |
|---|---|---|
|
|
@@ -33,7 +33,9 @@ apply. All of these row-level changes are performed as a single atomic operation | |
|
|
||
| ```sql | ||
| MERGE [ WITH SCHEMA EVOLUTION ] INTO target_table [ [ AS ] target_alias ] | ||
| USING { source_table | ( source_query ) } [ [ AS ] source_alias ] | ||
| [ WITH ( target_option_key = target_option_value [ , ... ] ) ] | ||
| USING { source_table [ WITH ( source_option_key = source_option_value [ , ... ] ) ] | | ||
| ( source_query ) } [ [ AS ] source_alias ] | ||
| ON merge_condition | ||
| [ WHEN MATCHED [ AND matched_condition ] THEN matched_action ] [ ... ] | ||
| [ WHEN NOT MATCHED [ BY TARGET ] [ AND not_matched_condition ] THEN not_matched_action ] [ ... ] | ||
|
|
@@ -69,6 +71,13 @@ not_matched_by_source_action | |
| The source of the merge, specified either as a table or as a parenthesized query. An optional | ||
| alias may be provided with or without the `AS` keyword. | ||
|
|
||
| * **WITH ( option_key = option_value [ , ... ] )** | ||
|
|
||
| Specifies dynamic table options for this `MERGE` operation. Options following the target table | ||
| are passed to the data source connector for the write operation. Options following the source | ||
| table are passed to the connector when reading the source. The supported options depend on the | ||
| connector. | ||
|
|
||
| * **merge_condition** | ||
|
|
||
| A boolean expression, introduced by the `ON` keyword, that determines how rows from the source | ||
|
|
@@ -149,6 +158,17 @@ SELECT * FROM source; | |
| +--+------+-----+ | ||
| ``` | ||
|
|
||
| #### Merge Using Dynamic Table Options | ||
|
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. same |
||
|
|
||
| ```sql | ||
| -- Option names and values are specific to each table's data source connector. | ||
| MERGE INTO target t WITH (`write.split-size` = 10) | ||
| USING source WITH (`split-size` = 5) s | ||
| ON t.pk = s.pk | ||
| WHEN MATCHED THEN UPDATE SET * | ||
| WHEN NOT MATCHED THEN INSERT *; | ||
| ``` | ||
|
|
||
| #### Update Matched Rows and Insert New Rows | ||
|
|
||
| ```sql | ||
|
|
||
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
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.
nit: can we put it towards the end ? Its more a speciality so I feel shouldn't be the first one.