john-jac commented on a change in pull request #19137: URL: https://github.com/apache/airflow/pull/19137#discussion_r741517446
########## 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: In testing, passing None caused a failure in boto3 as invalid parameters. That's why I had to break it out into two different calls. ########## 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: For this first release the aim is parity with the Postgres operator, which I don't believe returns a full set of results (but I could be mistaken). Certainly for a future release we could break this out, and in fact it would be good to add a sensor as well so that the SQL statement can be performed asynchronously. ########## 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: Multiple SQL statements is a separate boto3 call, which could be added in a future release. ########## 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: Multiple SQL statements is a separate boto3 call, [batch_execute_statement](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/redshift-data.html#RedshiftDataAPIService.Client.batch_execute_statement), which could be added in a future release. -- 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: [email protected] For queries about this service, please contact Infrastructure at: [email protected]
