You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@airflow.apache.org by GitBox <gi...@apache.org> on 2021/11/01 07:31:32 UTC
[GitHub] [airflow] ephraimbuddy commented on a change in pull request #19137: Add RedshiftDataHook
ephraimbuddy commented on a change in pull request #19137:
URL: https://github.com/apache/airflow/pull/19137#discussion_r739994507
##########
File path: airflow/providers/amazon/aws/hooks/redshift_data.py
##########
@@ -0,0 +1,152 @@
+#
+# 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.
+"""Interact with AWS Redshift clusters."""
+
+from typing import Optional
+
+from airflow.providers.amazon.aws.hooks.base_aws import AwsBaseHook
+
+
+class RedshiftDataHook(AwsBaseHook):
+ """
+ Interact with AWS Redshift Data, using the boto3 library
+
+ Additional arguments (such as ``aws_conn_id``) may be specified and
+ are passed down to the underlying AwsBaseHook.
+
+ .. seealso::
+ :class:`~airflow.providers.amazon.aws.hooks.base_aws.AwsBaseHook`
+
+ :param aws_conn_id: The Airflow connection used for AWS credentials.
+ :type aws_conn_id: str
+ """
+
+ def __init__(self, *args, **kwargs) -> None:
+ kwargs["client_type"] = "redshift-data"
+ super().__init__(*args, **kwargs)
+
+ def execute_statement(
+ self,
+ cluster_identifier: str,
+ database: str,
+ sql: str,
+ db_user: Optional[str] = "",
+ parameters: Optional[list] = None,
+ secret_arn: Optional[str] = "",
+ statement_name: Optional[str] = "",
+ with_event: Optional[bool] = False,
+ ):
+ """
+ Runs an SQL statement, which can be data manipulation language (DML)
+ or data definition language (DDL)
+
+ :param cluster_identifier: unique identifier of a cluster
+ :type cluster_identifier: str
+ :param database: the name of the database
+ :type database: str
+ :param sql: the SQL statement text to run
+ :type sql: str
+ :param db_user: the database user name
+ :type db_user: str
+ :param parameters: the parameters for the SQL statement
+ :type parameters: list
+ :param secret_arn: the name or ARN of the secret that enables db access
+ :type secret_arn: str
+ :param statement_name: the name of the SQL statement
+ :type statement_name: str
+ :param with_event: indicates whether to send an event to EventBridge
+ :type with_event: bool
+
+ """
+ """only provide parameter argument if it is valid"""
+ if parameters:
+ response = self.get_conn().execute_statement(
+ ClusterIdentifier=cluster_identifier,
+ Database=database,
+ Sql=sql,
+ DbUser=db_user,
+ WithEvent=with_event,
+ SecretArn=secret_arn,
+ StatementName=statement_name,
+ Parameters=parameters,
+ )
+ else:
+ response = self.get_conn().execute_statement(
+ ClusterIdentifier=cluster_identifier,
+ Database=database,
+ Sql=sql,
+ DbUser=db_user,
+ WithEvent=with_event,
+ SecretArn=secret_arn,
+ StatementName=statement_name,
+ )
+ return response['Id'] if response['Id'] else None
+
+ def describe_statement(
+ self,
+ id: str,
+ ):
+ """
+ Describes the details about a specific instance when a query was run
+ by the Amazon Redshift Data API
+
+ :param id: the identifier of the SQL statement to describe.
+ :type id: str
+
+ """
+ response = self.get_conn().describe_statement(
+ Id=id,
+ )
+ return response['Status']
Review comment:
I would prefer we return the whole response here rather than just the status. Someone else might need to get more information other than `status`
##########
File path: airflow/providers/amazon/aws/operators/redshift_data.py
##########
@@ -0,0 +1,127 @@
+#
+# 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.
+from time import sleep
+from typing import Optional
+
+from airflow.exceptions import AirflowException
+from airflow.models import BaseOperator
+from airflow.providers.amazon.aws.hooks.redshift_data import RedshiftDataHook
+
+
+class RedshiftDataOperator(BaseOperator):
+ """
+ Executes SQL Statements against an Amazon Redshift cluster using Redshift Data
+
+ .. seealso::
+ For more information on how to use this operator, take a look at the guide:
+ :ref:`howto/operator:RedshiftDataOperator`
+
+ :param sql: the sql code to be executed
+ :type sql: Can receive a str representing a sql statement,
+ or an iterable of str (sql statements)
+ :param aws_conn_id: AWS connection id (default: aws_default)
+ :type aws_conn_id: str
+ :param parameters: (optional) the parameters to render the SQL query with.
+ :type parameters: dict or iterable
+ :param autocommit: if True, each command is automatically committed.
+ (default value: False)
+ :type autocommit: bool
+ """
+
+ template_fields = ('sql',)
+ template_ext = ('.sql',)
+
+ def __init__(
+ self,
+ *,
+ aws_conn_id: str = 'aws_default',
+ cluster_identifier: str,
+ database: str,
+ sql: str,
Review comment:
Can we make this to take a `list` too, that way we will support running multiple SQL statements at once?
##########
File path: airflow/providers/amazon/aws/hooks/redshift_data.py
##########
@@ -0,0 +1,152 @@
+#
+# 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.
+"""Interact with AWS Redshift clusters."""
+
+from typing import Optional
+
+from airflow.providers.amazon.aws.hooks.base_aws import AwsBaseHook
+
+
+class RedshiftDataHook(AwsBaseHook):
+ """
+ Interact with AWS Redshift Data, using the boto3 library
+
+ Additional arguments (such as ``aws_conn_id``) may be specified and
+ are passed down to the underlying AwsBaseHook.
+
+ .. seealso::
+ :class:`~airflow.providers.amazon.aws.hooks.base_aws.AwsBaseHook`
+
+ :param aws_conn_id: The Airflow connection used for AWS credentials.
+ :type aws_conn_id: str
+ """
+
+ def __init__(self, *args, **kwargs) -> None:
+ kwargs["client_type"] = "redshift-data"
+ super().__init__(*args, **kwargs)
+
+ def execute_statement(
+ self,
+ cluster_identifier: str,
+ database: str,
+ sql: str,
+ db_user: Optional[str] = "",
+ parameters: Optional[list] = None,
+ secret_arn: Optional[str] = "",
+ statement_name: Optional[str] = "",
+ with_event: Optional[bool] = False,
+ ):
+ """
+ Runs an SQL statement, which can be data manipulation language (DML)
+ or data definition language (DDL)
+
+ :param cluster_identifier: unique identifier of a cluster
+ :type cluster_identifier: str
+ :param database: the name of the database
+ :type database: str
+ :param sql: the SQL statement text to run
+ :type sql: str
+ :param db_user: the database user name
+ :type db_user: str
+ :param parameters: the parameters for the SQL statement
+ :type parameters: list
+ :param secret_arn: the name or ARN of the secret that enables db access
+ :type secret_arn: str
+ :param statement_name: the name of the SQL statement
+ :type statement_name: str
+ :param with_event: indicates whether to send an event to EventBridge
+ :type with_event: bool
+
+ """
+ """only provide parameter argument if it is valid"""
+ if parameters:
+ response = self.get_conn().execute_statement(
+ ClusterIdentifier=cluster_identifier,
+ Database=database,
+ Sql=sql,
+ DbUser=db_user,
+ WithEvent=with_event,
+ SecretArn=secret_arn,
+ StatementName=statement_name,
+ Parameters=parameters,
+ )
+ else:
+ response = self.get_conn().execute_statement(
+ ClusterIdentifier=cluster_identifier,
+ Database=database,
+ Sql=sql,
+ DbUser=db_user,
+ WithEvent=with_event,
+ SecretArn=secret_arn,
+ StatementName=statement_name,
+ )
+ return response['Id'] if response['Id'] else None
+
+ def describe_statement(
+ self,
+ id: str,
+ ):
+ """
+ Describes the details about a specific instance when a query was run
+ by the Amazon Redshift Data API
+
+ :param id: the identifier of the SQL statement to describe.
+ :type id: str
+
+ """
+ response = self.get_conn().describe_statement(
+ Id=id,
+ )
+ return response['Status']
+
+ def get_statement_result(
+ self,
+ id: str,
+ next_token: Optional[str] = "",
+ ):
+ """
+ Fetches the temporarily cached result of an SQL statement, a token is
+ returned to page through the statement results
+
+ :param id: the identifier of the SQL statement to describe.
+ :type id: str
+ :param next_token: a value that indicates the starting point for the next set of response records
+ :type next_token: str
+
+ """
+ response = self.get_conn().get_statement_result(
+ Id=id,
+ NextToken=next_token,
+ )
+ return response
+
+ def cancel_statement(
+ self,
+ id: str,
+ ):
+ """
+ Cancels a running query, to be canceled, a query must be running
+
+ :param id: the identifier of the SQL statement to describe.
+ :type id: str
+
+ """
+ response = self.get_conn().cancel_statement(
+ Id=id,
+ )
+ return response['Status'] if response['Status'] else None
Review comment:
```suggestion
return response['Status']
```
Do you suspect that it could return None?
##########
File path: airflow/providers/amazon/aws/hooks/redshift_data.py
##########
@@ -0,0 +1,152 @@
+#
+# 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.
+"""Interact with AWS Redshift clusters."""
+
+from typing import Optional
+
+from airflow.providers.amazon.aws.hooks.base_aws import AwsBaseHook
+
+
+class RedshiftDataHook(AwsBaseHook):
+ """
+ Interact with AWS Redshift Data, using the boto3 library
+
+ Additional arguments (such as ``aws_conn_id``) may be specified and
+ are passed down to the underlying AwsBaseHook.
+
+ .. seealso::
+ :class:`~airflow.providers.amazon.aws.hooks.base_aws.AwsBaseHook`
+
+ :param aws_conn_id: The Airflow connection used for AWS credentials.
+ :type aws_conn_id: str
+ """
+
+ def __init__(self, *args, **kwargs) -> None:
+ kwargs["client_type"] = "redshift-data"
+ super().__init__(*args, **kwargs)
+
+ def execute_statement(
+ self,
+ cluster_identifier: str,
+ database: str,
+ sql: str,
+ db_user: Optional[str] = "",
+ parameters: Optional[list] = None,
+ secret_arn: Optional[str] = "",
+ statement_name: Optional[str] = "",
+ with_event: Optional[bool] = False,
+ ):
+ """
+ Runs an SQL statement, which can be data manipulation language (DML)
+ or data definition language (DDL)
+
+ :param cluster_identifier: unique identifier of a cluster
+ :type cluster_identifier: str
+ :param database: the name of the database
+ :type database: str
+ :param sql: the SQL statement text to run
+ :type sql: str
+ :param db_user: the database user name
+ :type db_user: str
+ :param parameters: the parameters for the SQL statement
+ :type parameters: list
+ :param secret_arn: the name or ARN of the secret that enables db access
+ :type secret_arn: str
+ :param statement_name: the name of the SQL statement
+ :type statement_name: str
+ :param with_event: indicates whether to send an event to EventBridge
+ :type with_event: bool
+
+ """
+ """only provide parameter argument if it is valid"""
+ if parameters:
+ response = self.get_conn().execute_statement(
+ ClusterIdentifier=cluster_identifier,
+ Database=database,
+ Sql=sql,
+ DbUser=db_user,
+ WithEvent=with_event,
+ SecretArn=secret_arn,
+ StatementName=statement_name,
+ Parameters=parameters,
+ )
+ else:
+ response = self.get_conn().execute_statement(
+ ClusterIdentifier=cluster_identifier,
+ Database=database,
+ Sql=sql,
+ DbUser=db_user,
+ WithEvent=with_event,
+ SecretArn=secret_arn,
+ StatementName=statement_name,
+ )
Review comment:
Since the `parameters` arg is not required, we could pass `None` to the execute_statement and it would be ignored.
##########
File path: airflow/providers/amazon/aws/example_dags/example_redshift_data_execute_sql.py
##########
@@ -0,0 +1,83 @@
+# 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.
+
+from datetime import datetime, timedelta
+from os import getenv
+
+from airflow.decorators import dag, task
+from airflow.providers.amazon.aws.hooks.redshift_data import RedshiftDataHook
+from airflow.providers.amazon.aws.operators.redshift_data import RedshiftDataOperator
+
+# [START howto_operator_redshift_data_env_variables]
+REDSHIFT_CLUSTER_IDENTIFIER = getenv("REDSHIFT_CLUSTER_IDENTIFIER", "test-cluster")
+REDSHIFT_DATABASE = getenv("REDSHIFT_DATABASE", "test-database")
+REDSHIFT_DATABASE_USER = getenv("REDSHIFT_DATABASE_USER", "awsuser")
+# [END howto_operator_redshift_data_env_variables]
+
+REDSHIFT_QUERY = """
+SELECT table_schema,
+ table_name
+FROM information_schema.tables
+WHERE table_schema NOT IN ('information_schema', 'pg_catalog')
+ AND table_type = 'BASE TABLE'
+ORDER BY table_schema,
+ table_name;
+ """
+POLL_INTERVAL = 10
+TIMEOUT = 600
+
+
+# [START howto_redshift_data]
+@dag(
+ dag_id='example_redshift_data',
+ schedule_interval=None,
+ start_date=datetime(2021, 1, 1),
+ dagrun_timeout=timedelta(minutes=60),
+ tags=['example'],
+ catchup=False,
+)
+def example_redshift_data():
+ @task(task_id="output_results")
+ def output_results_fn(id):
+ """This is a python decorator task that returns a Redshift query"""
+ hook = RedshiftDataHook()
+
+ resp = hook.get_statement_result(
+ id=id,
+ )
+ print(resp)
+ return resp
Review comment:
Since this is necessary, we should create an operator for it. No strong opinion but it seems necessary.
##########
File path: airflow/providers/amazon/aws/hooks/redshift_data.py
##########
@@ -0,0 +1,152 @@
+#
+# 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.
+"""Interact with AWS Redshift clusters."""
+
+from typing import Optional
+
+from airflow.providers.amazon.aws.hooks.base_aws import AwsBaseHook
+
+
+class RedshiftDataHook(AwsBaseHook):
+ """
+ Interact with AWS Redshift Data, using the boto3 library
+
+ Additional arguments (such as ``aws_conn_id``) may be specified and
+ are passed down to the underlying AwsBaseHook.
+
+ .. seealso::
+ :class:`~airflow.providers.amazon.aws.hooks.base_aws.AwsBaseHook`
+
+ :param aws_conn_id: The Airflow connection used for AWS credentials.
+ :type aws_conn_id: str
+ """
+
+ def __init__(self, *args, **kwargs) -> None:
+ kwargs["client_type"] = "redshift-data"
+ super().__init__(*args, **kwargs)
+
+ def execute_statement(
+ self,
+ cluster_identifier: str,
+ database: str,
+ sql: str,
+ db_user: Optional[str] = "",
+ parameters: Optional[list] = None,
+ secret_arn: Optional[str] = "",
+ statement_name: Optional[str] = "",
+ with_event: Optional[bool] = False,
+ ):
+ """
+ Runs an SQL statement, which can be data manipulation language (DML)
+ or data definition language (DDL)
+
+ :param cluster_identifier: unique identifier of a cluster
+ :type cluster_identifier: str
+ :param database: the name of the database
+ :type database: str
+ :param sql: the SQL statement text to run
+ :type sql: str
+ :param db_user: the database user name
+ :type db_user: str
+ :param parameters: the parameters for the SQL statement
+ :type parameters: list
+ :param secret_arn: the name or ARN of the secret that enables db access
+ :type secret_arn: str
+ :param statement_name: the name of the SQL statement
+ :type statement_name: str
+ :param with_event: indicates whether to send an event to EventBridge
+ :type with_event: bool
+
+ """
+ """only provide parameter argument if it is valid"""
Review comment:
```suggestion
# only provide parameter argument if it is valid
```
We may not need this comment though
##########
File path: tests/providers/amazon/aws/hooks/test_redshift_data.py
##########
@@ -0,0 +1,76 @@
+#
+# 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.
+#
+
+import unittest
+from unittest import mock
+
+from airflow.providers.amazon.aws.hooks.redshift_data import RedshiftDataHook
+
+
Review comment:
For this test, check that we can be able to connect and that we are actually calling the API we connected to. The current tests doesn't guarantee that we are hitting that API
--
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