You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@airflow.apache.org by "Artuz37 (via GitHub)" <gi...@apache.org> on 2024/08/13 09:45:44 UTC

[PR] add OpenLineage support to S3ToRedshiftOperator [airflow]

Artuz37 opened a new pull request, #41422:
URL: https://github.com/apache/airflow/pull/41422

   <!--
    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.
    -->
   
   <!--
   Thank you for contributing! Please make sure that your code changes
   are covered with tests. And in case of new features or big changes
   remember to adjust the documentation.
   
   Feel free to ping committers for the review!
   
   In case of an existing issue, reference it using one of the following:
   
   closes: #ISSUE
   related: #ISSUE
   
   How to write a good git commit message:
   http://chris.beams.io/posts/git-commit/
   -->
   
   
   
   <!-- Please keep an empty line above the dashes. -->
   ---
   Added `get_openlineage_facets_on_complete` method to `S3ToRedshiftOperator`. 
   It extracts target table schema by querying redshift and creates identity column level lineage. 
   
   **^ Add meaningful description above**
   Read the **[Pull Request Guidelines](https://github.com/apache/airflow/blob/main/contributing-docs/05_pull_requests.rst#pull-request-guidelines)** for more information.
   In case of fundamental code changes, an Airflow Improvement Proposal ([AIP](https://cwiki.apache.org/confluence/display/AIRFLOW/Airflow+Improvement+Proposals)) is needed.
   In case of a new dependency, check compliance with the [ASF 3rd Party License Policy](https://www.apache.org/legal/resolved.html#category-x).
   In case of backwards incompatible changes please leave a note in a newsfragment file, named `{pr_number}.significant.rst` or `{issue_number}.significant.rst`, in [newsfragments](https://github.com/apache/airflow/tree/main/newsfragments).
   


-- 
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: commits-unsubscribe@airflow.apache.org

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


Re: [PR] add OpenLineage support to S3ToRedshiftOperator [airflow]

Posted by "vincbeck (via GitHub)" <gi...@apache.org>.
vincbeck commented on code in PR #41422:
URL: https://github.com/apache/airflow/pull/41422#discussion_r1715394154


##########
airflow/providers/amazon/aws/transfers/s3_to_redshift.py:
##########
@@ -197,3 +199,77 @@ def execute(self, context: Context) -> None:
         else:
             redshift_hook.run(sql, autocommit=self.autocommit)
         self.log.info("COPY command complete...")
+
+    def get_openlineage_facets_on_complete(self, task_instance):
+        """Implement on_complete as we will query destination table."""
+        from pathlib import Path
+
+        from airflow.providers.amazon.aws.utils.open_lineage import (
+            get_facets_from_redshift_table,
+            get_identity_column_lineage_facet,
+        )
+        from airflow.providers.common.compat.openlineage.facet import (
+            Dataset,
+            Identifier,
+            LifecycleStateChange,
+            LifecycleStateChangeDatasetFacet,
+            SymlinksDatasetFacet,
+        )
+        from airflow.providers.openlineage.extractors import OperatorLineage
+
+        redshift_hook = self._create_hook()
+        if isinstance(redshift_hook, RedshiftDataHook):
+            database = self.redshift_data_api_kwargs.get("database")
+            identifier = self.redshift_data_api_kwargs.get(
+                "cluster_identifier"
+            ) or self.redshift_data_api_kwargs.get("workgroup_name")

Review Comment:
   ```suggestion
               identifier = self.redshift_data_api_kwargs.get(
                   "cluster_identifier", self.redshift_data_api_kwargs.get("workgroup_name")
               )
   ```



-- 
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: commits-unsubscribe@airflow.apache.org

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


Re: [PR] add OpenLineage support to S3ToRedshiftOperator [airflow]

Posted by "Artuz37 (via GitHub)" <gi...@apache.org>.
Artuz37 commented on code in PR #41422:
URL: https://github.com/apache/airflow/pull/41422#discussion_r1716929554


##########
airflow/providers/amazon/aws/transfers/s3_to_redshift.py:
##########
@@ -197,3 +199,77 @@ def execute(self, context: Context) -> None:
         else:
             redshift_hook.run(sql, autocommit=self.autocommit)
         self.log.info("COPY command complete...")
+
+    def get_openlineage_facets_on_complete(self, task_instance):
+        """Implement on_complete as we will query destination table."""
+        from pathlib import Path
+
+        from airflow.providers.amazon.aws.utils.open_lineage import (
+            get_facets_from_redshift_table,
+            get_identity_column_lineage_facet,
+        )
+        from airflow.providers.common.compat.openlineage.facet import (
+            Dataset,
+            Identifier,
+            LifecycleStateChange,
+            LifecycleStateChangeDatasetFacet,
+            SymlinksDatasetFacet,
+        )
+        from airflow.providers.openlineage.extractors import OperatorLineage
+
+        redshift_hook = self._create_hook()
+        if isinstance(redshift_hook, RedshiftDataHook):

Review Comment:
   That's a nice topic. In current state of the operator, used hook can be RedshiftDataHook or RedshiftSQLHook, which at the core are two completely different objects. `isinstance` isn't the problem itself, however it is a result of violated polymorphism. If we want numpy to pass, `redshift_hook` type needs to be checked before called. 
   
   My proposal in this case is to introduce property you suggested, and based on that, create `redshift_data_hook` or `redshift_sql_hook`. This way, we do not risk trying to call some method of RedshiftSQLHook on RedshiftDataHook and vice versa. I pushed commit with this change, let me know what you think
   
   



-- 
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: commits-unsubscribe@airflow.apache.org

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


Re: [PR] add OpenLineage support to S3ToRedshiftOperator [airflow]

Posted by "ad-m-ss (via GitHub)" <gi...@apache.org>.
ad-m-ss commented on code in PR #41422:
URL: https://github.com/apache/airflow/pull/41422#discussion_r1715438128


##########
airflow/providers/amazon/aws/transfers/s3_to_redshift.py:
##########
@@ -197,3 +199,77 @@ def execute(self, context: Context) -> None:
         else:
             redshift_hook.run(sql, autocommit=self.autocommit)
         self.log.info("COPY command complete...")
+
+    def get_openlineage_facets_on_complete(self, task_instance):
+        """Implement on_complete as we will query destination table."""
+        from pathlib import Path
+
+        from airflow.providers.amazon.aws.utils.open_lineage import (
+            get_facets_from_redshift_table,
+            get_identity_column_lineage_facet,
+        )
+        from airflow.providers.common.compat.openlineage.facet import (
+            Dataset,
+            Identifier,
+            LifecycleStateChange,
+            LifecycleStateChangeDatasetFacet,
+            SymlinksDatasetFacet,
+        )
+        from airflow.providers.openlineage.extractors import OperatorLineage
+
+        redshift_hook = self._create_hook()
+        if isinstance(redshift_hook, RedshiftDataHook):

Review Comment:
   I am not sure about style guidelines of the project, but I suggest
   
   ```suggestion
           if self.redshift_data_api_kwargs:
   ```
   
   `isinstance` is generally discouraged in Python.
   
   We can also `property` like:
   
   ```
   @property
   def use_redshift_data(self):
       return bool(self.redshift_data_api_kwargs)
   ```
   
   to avoid duplication of that condition in an explicit way.
   



-- 
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: commits-unsubscribe@airflow.apache.org

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


Re: [PR] add OpenLineage support to S3ToRedshiftOperator [airflow]

Posted by "ad-m-ss (via GitHub)" <gi...@apache.org>.
ad-m-ss commented on code in PR #41422:
URL: https://github.com/apache/airflow/pull/41422#discussion_r1715438128


##########
airflow/providers/amazon/aws/transfers/s3_to_redshift.py:
##########
@@ -197,3 +199,77 @@ def execute(self, context: Context) -> None:
         else:
             redshift_hook.run(sql, autocommit=self.autocommit)
         self.log.info("COPY command complete...")
+
+    def get_openlineage_facets_on_complete(self, task_instance):
+        """Implement on_complete as we will query destination table."""
+        from pathlib import Path
+
+        from airflow.providers.amazon.aws.utils.open_lineage import (
+            get_facets_from_redshift_table,
+            get_identity_column_lineage_facet,
+        )
+        from airflow.providers.common.compat.openlineage.facet import (
+            Dataset,
+            Identifier,
+            LifecycleStateChange,
+            LifecycleStateChangeDatasetFacet,
+            SymlinksDatasetFacet,
+        )
+        from airflow.providers.openlineage.extractors import OperatorLineage
+
+        redshift_hook = self._create_hook()
+        if isinstance(redshift_hook, RedshiftDataHook):

Review Comment:
   I am not sure about style guidelines of the project, but I suggest
   
   ```suggestion
           if self.redshift_data_api_kwargs:
   ```
   
   `isinstance` is generally discouraged in Python.



-- 
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: commits-unsubscribe@airflow.apache.org

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


Re: [PR] add OpenLineage support to S3ToRedshiftOperator [airflow]

Posted by "vincbeck (via GitHub)" <gi...@apache.org>.
vincbeck commented on code in PR #41422:
URL: https://github.com/apache/airflow/pull/41422#discussion_r1715443155


##########
airflow/providers/amazon/aws/transfers/s3_to_redshift.py:
##########
@@ -197,3 +199,77 @@ def execute(self, context: Context) -> None:
         else:
             redshift_hook.run(sql, autocommit=self.autocommit)
         self.log.info("COPY command complete...")
+
+    def get_openlineage_facets_on_complete(self, task_instance):
+        """Implement on_complete as we will query destination table."""
+        from pathlib import Path
+
+        from airflow.providers.amazon.aws.utils.open_lineage import (
+            get_facets_from_redshift_table,
+            get_identity_column_lineage_facet,
+        )
+        from airflow.providers.common.compat.openlineage.facet import (
+            Dataset,
+            Identifier,
+            LifecycleStateChange,
+            LifecycleStateChangeDatasetFacet,
+            SymlinksDatasetFacet,
+        )
+        from airflow.providers.openlineage.extractors import OperatorLineage
+
+        redshift_hook = self._create_hook()
+        if isinstance(redshift_hook, RedshiftDataHook):

Review Comment:
   I like that!



-- 
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: commits-unsubscribe@airflow.apache.org

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


Re: [PR] add OpenLineage support to S3ToRedshiftOperator [airflow]

Posted by "Artuz37 (via GitHub)" <gi...@apache.org>.
Artuz37 closed pull request #41422: add OpenLineage support to S3ToRedshiftOperator
URL: https://github.com/apache/airflow/pull/41422


-- 
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: commits-unsubscribe@airflow.apache.org

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


Re: [PR] add OpenLineage support to S3ToRedshiftOperator [airflow]

Posted by "ad-m-ss (via GitHub)" <gi...@apache.org>.
ad-m-ss commented on code in PR #41422:
URL: https://github.com/apache/airflow/pull/41422#discussion_r1715438128


##########
airflow/providers/amazon/aws/transfers/s3_to_redshift.py:
##########
@@ -197,3 +199,77 @@ def execute(self, context: Context) -> None:
         else:
             redshift_hook.run(sql, autocommit=self.autocommit)
         self.log.info("COPY command complete...")
+
+    def get_openlineage_facets_on_complete(self, task_instance):
+        """Implement on_complete as we will query destination table."""
+        from pathlib import Path
+
+        from airflow.providers.amazon.aws.utils.open_lineage import (
+            get_facets_from_redshift_table,
+            get_identity_column_lineage_facet,
+        )
+        from airflow.providers.common.compat.openlineage.facet import (
+            Dataset,
+            Identifier,
+            LifecycleStateChange,
+            LifecycleStateChangeDatasetFacet,
+            SymlinksDatasetFacet,
+        )
+        from airflow.providers.openlineage.extractors import OperatorLineage
+
+        redshift_hook = self._create_hook()
+        if isinstance(redshift_hook, RedshiftDataHook):

Review Comment:
   I am not sure about style guidelines of the project, but I suggest
   
   ```suggestion
           if self.redshift_data_api_kwargs:
   ```
   
   `isinstance` is generally discouraged in Python.
   
   We can also add property like:
   
   ```
   @property
   def use_redshift_data(self):
       return bool(self.redshift_data_api_kwargs)
   ```
   
   to avoid duplication of that condition in an explicit way.
   



-- 
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: commits-unsubscribe@airflow.apache.org

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


Re: [PR] add OpenLineage support to S3ToRedshiftOperator [airflow]

Posted by "boring-cyborg[bot] (via GitHub)" <gi...@apache.org>.
boring-cyborg[bot] commented on PR #41422:
URL: https://github.com/apache/airflow/pull/41422#issuecomment-2285832430

   Congratulations on your first Pull Request and welcome to the Apache Airflow community! If you have any issues or are unsure about any anything please check our Contributors' Guide (https://github.com/apache/airflow/blob/main/contributing-docs/README.rst)
   Here are some useful points:
   - Pay attention to the quality of your code (ruff, mypy and type annotations). Our [pre-commits]( https://github.com/apache/airflow/blob/main/contributing-docs/08_static_code_checks.rst#prerequisites-for-pre-commit-hooks) will help you with that.
   - In case of a new feature add useful documentation (in docstrings or in `docs/` directory). Adding a new operator? Check this short [guide](https://github.com/apache/airflow/blob/main/docs/apache-airflow/howto/custom-operator.rst) Consider adding an example DAG that shows how users should use it.
   - Consider using [Breeze environment](https://github.com/apache/airflow/blob/main/dev/breeze/doc/README.rst) for testing locally, it's a heavy docker but it ships with a working Airflow and a lot of integrations.
   - Be patient and persistent. It might take some time to get a review or get the final approval from Committers.
   - Please follow [ASF Code of Conduct](https://www.apache.org/foundation/policies/conduct) for all communication including (but not limited to) comments on Pull Requests, Mailing list and Slack.
   - Be sure to read the [Airflow Coding style]( https://github.com/apache/airflow/blob/main/contributing-docs/05_pull_requests.rst#coding-style-and-best-practices).
   - Always keep your Pull Requests rebased, otherwise your build might fail due to changes not related to your commits.
   Apache Airflow is a community-driven project and together we are making it better 🚀.
   In case of doubts contact the developers at:
   Mailing List: dev@airflow.apache.org
   Slack: https://s.apache.org/airflow-slack
   


-- 
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: commits-unsubscribe@airflow.apache.org

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


Re: [PR] add OpenLineage support to S3ToRedshiftOperator [airflow]

Posted by "vincbeck (via GitHub)" <gi...@apache.org>.
vincbeck commented on code in PR #41422:
URL: https://github.com/apache/airflow/pull/41422#discussion_r1717034718


##########
airflow/providers/amazon/aws/transfers/s3_to_redshift.py:
##########
@@ -197,3 +199,77 @@ def execute(self, context: Context) -> None:
         else:
             redshift_hook.run(sql, autocommit=self.autocommit)
         self.log.info("COPY command complete...")
+
+    def get_openlineage_facets_on_complete(self, task_instance):
+        """Implement on_complete as we will query destination table."""
+        from pathlib import Path
+
+        from airflow.providers.amazon.aws.utils.open_lineage import (
+            get_facets_from_redshift_table,
+            get_identity_column_lineage_facet,
+        )
+        from airflow.providers.common.compat.openlineage.facet import (
+            Dataset,
+            Identifier,
+            LifecycleStateChange,
+            LifecycleStateChangeDatasetFacet,
+            SymlinksDatasetFacet,
+        )
+        from airflow.providers.openlineage.extractors import OperatorLineage
+
+        redshift_hook = self._create_hook()
+        if isinstance(redshift_hook, RedshiftDataHook):

Review Comment:
   I like it better that way! Thanks for the quick turn around



-- 
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: commits-unsubscribe@airflow.apache.org

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