Source code for airflow.providers.amazon.aws.hooks.redshift_sql
# 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__future__importannotationsimportredshift_connectorfromredshift_connectorimportConnectionasRedshiftConnectionfromsqlalchemyimportcreate_enginefromsqlalchemy.engine.urlimportURLfromairflow.compat.functoolsimportcached_propertyfromairflow.providers.common.sql.hooks.sqlimportDbApiHook
[docs]classRedshiftSQLHook(DbApiHook):""" Execute statements against Amazon Redshift, using redshift_connector This hook requires the redshift_conn_id connection. :param redshift_conn_id: reference to :ref:`Amazon Redshift connection id<howto/connection:redshift>` .. note:: get_sqlalchemy_engine() and get_uri() depend on sqlalchemy-amazon-redshift """
[docs]defget_ui_field_behaviour()->dict:"""Returns custom field behavior"""return{"hidden_fields":[],"relabeling":{"login":"User","schema":"Database"},
def_get_conn_params(self)->dict[str,str|int]:"""Helper method to retrieve connection args"""conn=self.connconn_params:dict[str,str|int]={}ifconn.login:conn_params["user"]=conn.loginifconn.password:conn_params["password"]=conn.passwordifconn.host:conn_params["host"]=conn.hostifconn.port:conn_params["port"]=conn.portifconn.schema:conn_params["database"]=conn.schemareturnconn_params
[docs]defget_uri(self)->str:"""Overrides DbApiHook get_uri to use redshift_connector sqlalchemy dialect as driver name"""conn_params=self._get_conn_params()if"user"inconn_params:conn_params["username"]=conn_params.pop("user")# Compatibility: The 'create' factory method was added in SQLAlchemy 1.4# to replace calling the default URL constructor directly.create_url=getattr(URL,"create",URL)returnstr(create_url(drivername="redshift+redshift_connector",**conn_params))
[docs]defget_sqlalchemy_engine(self,engine_kwargs=None):"""Overrides DbApiHook get_sqlalchemy_engine to pass redshift_connector specific kwargs"""conn_kwargs=self.conn.extra_dejsonifengine_kwargsisNone:engine_kwargs={}if"connect_args"inengine_kwargs:engine_kwargs["connect_args"]={**conn_kwargs,**engine_kwargs["connect_args"]}else:engine_kwargs["connect_args"]=conn_kwargsreturncreate_engine(self.get_uri(),**engine_kwargs)
[docs]defget_table_primary_key(self,table:str,schema:str|None="public")->list[str]|None:""" Helper method that returns the table primary key :param table: Name of the target table :param schema: Name of the target schema, public by default :return: Primary key columns list """sql=""" select kcu.column_name from information_schema.table_constraints tco join information_schema.key_column_usage kcu on kcu.constraint_name = tco.constraint_name and kcu.constraint_schema = tco.constraint_schema and kcu.constraint_name = tco.constraint_name where tco.constraint_type = 'PRIMARY KEY' and kcu.table_schema = %s and kcu.table_name = %s """pk_columns=[row[0]forrowinself.get_records(sql,(schema,table))]returnpk_columnsorNone
[docs]defget_conn(self)->RedshiftConnection:"""Returns a redshift_connector.Connection object"""conn_params=self._get_conn_params()conn_kwargs_dejson=self.conn.extra_dejsonconn_kwargs:dict={**conn_params,**conn_kwargs_dejson}returnredshift_connector.connect(**conn_kwargs)