Update documentation for COPY command #9931
Merged
Conversation
This file contains 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
github-actions
bot
removed
the
documentation
alamb
commented
Apr 3, 2024
| OPTIONS( | ||
| NULL_VALUE 'NAN' | ||
| ); | ||
| my_table(a bigint, b bigint) |
There was a problem hiding this comment.
I found the existing formatting hard to read, so I added some whitespace
alamb
commented
Apr 3, 2024
| ) | ||
| ``` | ||
|
|
||
| In this example, we write the entirety of `source_table` out to a folder of parquet files. One parquet file will be written in parallel to the folder for each partition in the query. The next option `compression` set to `snappy` indicates that unless otherwise specified all columns should use the snappy compression codec. The option `compression::col1` sets an override, so that the column `col1` in the parquet file will use `ZSTD` compression codec with compression level `5`. In general, parquet options which support column specific settings can be specified with the syntax `OPTION::COLUMN.NESTED.PATH`. | ||
|
|
||
| ## Available Options | ||
|
|
||
| ### COPY Specific Options | ||
|
|
||
| The following special options are specific to the `COPY` command. |
There was a problem hiding this comment.
These options are now specified directly in the DML syntax itself, so I removed them from here
alamb
commented
Apr 3, 2024
| @@ -35,8 +35,22 @@ TO '<i><b>file_name</i></b>' | |||
| [ OPTIONS( <i><b>option</i></b> [, ... ] ) ] | |||
| </pre> | |||
|
|
|||
| `STORED AS` specifies the file format the `COPY` command will write. If this | |||
There was a problem hiding this comment.
Ported / reworded this content from write options page
hveiga
reviewed
Apr 3, 2024
| format parquet, | ||
| compression snappy, | ||
| 'compression::col1' 'zstd(5)', | ||
| partition_by 'column3, column4' |
There was a problem hiding this comment.
Is this the correct format? Based on #9927 the partition_by has moved to the DML and it should be something like: COPY t1 TO '/tmp/hive_output/' PARTITIONED BY (col1) OPTIONS (format parquet);
There was a problem hiding this comment.
that is an excellent point -- I fixed it in af55db8 (I also tested that it works locally):
❯ create table source_table as values ('1','2','3','4');
0 row(s) fetched.
Elapsed 0.021 seconds.
❯ COPY source_table
TO 'test/table_with_options'
PARTITIONED BY (column3, column4)
OPTIONS (
format parquet,
compression snappy,
'compression::column1' 'zstd(5)',
)
;
+-------+
| count |
+-------+
| 1 |
+-------+
|
Thank you for the review @hveiga 🙏 |
hveiga
approved these changes
Apr 4, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Which issue does this PR close?
closes #9927
Rationale for this change
Looks like I missed a spot while updating the docs in #9754
What changes are included in this PR?
Are these changes tested?
CI doc checks
Are there any user-facing changes?
Docs