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 2022/01/04 16:23:52 UTC

[GitHub] [airflow] dstandish commented on a change in pull request #20642: Added Hook for Amazon RDS

dstandish commented on a change in pull request #20642:
URL: https://github.com/apache/airflow/pull/20642#discussion_r777810867



##########
File path: airflow/providers/amazon/aws/hooks/rds.py
##########
@@ -0,0 +1,165 @@
+#
+# 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 RDS."""
+
+from typing import Any, Callable, Dict, List, Optional, Union
+
+from airflow.exceptions import AirflowException
+from airflow.providers.amazon.aws.hooks.base_aws import AwsBaseHook
+
+
+class RDSHook(AwsBaseHook):
+    """
+    Interact with AWS RDS using the boto3 library.
+    Client methods could be used from hook object, like: hook.create_db_instance()
+
+    Additional arguments (such as ``aws_conn_id``) may be specified and
+    are passed down to the underlying AwsBaseHook.
+
+    All available methods are listed in documentation
+    .. seealso::
+        https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/rds.html
+
+    .. 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"] = "rds"
+        super().__init__(*args, **kwargs)
+
+    def __getattr__(self, item: str) -> Union[Callable, AirflowException]:
+        client = self.get_conn()
+        if hasattr(client, item):
+            self.log.info("Calling boto3 RDS client's method:", item)
+            return getattr(client, item)
+        else:
+            raise AirflowException("Boto3 RDS client doesn't have a method:", item)
+
+
+class RDSHookAlt(AwsBaseHook):
+    """
+    Interact with AWS RDS, using the boto3 library.
+
+    Additional arguments (such as ``aws_conn_id``) may be specified and
+    are passed down to the underlying AwsBaseHook.
+
+    All unimplemented methods available from boto3 RDS client -> hook.get_conn()
+    .. seealso::
+        https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/rds.html
+
+    .. 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"] = "rds"
+        super().__init__(*args, **kwargs)
+
+    def describe_db_snapshots(

Review comment:
       i don't recommend creating methods like this in hooks. what you're doing  here is essentially making an alias for the boto3 method.  but instead, the user can just do `client = hook.get_conn()` and calll the method directly.  airflow does not need to get in the way between user and library without good reason.
   
   so i would not recommend adding  any of these methods and i do not think you need the Alt version of this hook.  in any case you could add the first version first, and add additional methods later as the need arises.




-- 
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