Update S3ToRedshift Operator docs to indicate multiple key functionality #28705
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
boring-cyborg
bot
added
area:providers
area:system-tests
kind:documentation
provider:amazon
RachitSharma2001
force-pushed
the
add-wildcard-redshift
branch
from
4b2f62a to
00906f4
Compare
uranusjr
reviewed
Jan 4, 2023
| @@ -42,7 +42,7 @@ class S3ToRedshiftOperator(BaseOperator): | |||
| :param schema: reference to a specific schema in redshift database | |||
| :param table: reference to a specific table in redshift database | |||
| :param s3_bucket: reference to a specific S3 bucket | |||
| :param s3_key: reference to a specific S3 key | |||
| :param s3_key: reference either to a specific S3 key or a set of keys or folders sharing that prefix | |||
There was a problem hiding this comment.
What does “a set of keys” mean? Does it has to be a Python set, or is the term being used more liberally? If the latter case I think collection is a more common term.
There was a problem hiding this comment.
I suppose a better wording would be:
:param s3_key: key prefix that selects single or multiple objects from S3
vincbeck
requested changes
Jan 5, 2023
| @@ -207,6 +208,18 @@ def delete_security_group(sec_group_id: str, sec_group_name: str): | |||
| ) | |||
| # [END howto_transfer_s3_to_redshift] | |||
|
|
|||
| # [START howto_transfer_s3_to_redshift_multiple_keys] | |||
| transfer_s3_to_redshift_multiple = S3ToRedshiftOperator( | |||
There was a problem hiding this comment.
Dont forget to add it to the chain command
RachitSharma2001
force-pushed
the
add-wildcard-redshift
branch
from
00906f4 to
aa38594
Compare
|
Thank you all for the suggestions for the changes. I have updated the wording of the documentation in airflow/providers/amazon/aws/transfers/s3_to_redshift.py, and have added the requested change to the system test. Let me know if any other changes are needed. |
vincbeck
approved these changes
Jan 5, 2023
uranusjr
approved these changes
Jan 6, 2023
potiuk
approved these changes
Jan 6, 2023
2 tasks
37 tasks
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.
As shown in issue #27957, the current documentation for the
S3ToRedshiftOperator seems to indicate that only one key from S3 can be transferred to Redshift. However, as elaborated here and in the aws docs here, theCOPYcommand from S3 to Redshift automatically looks for all keys that matches the given prefix, and then copies all of them to redshift.For this PR, I wanted to update the docs to make this clear to Airflow users. I also added a system test that displays this functionality.