Source code for

# 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
# Unless required by applicable law or agreed to in writing,
# software distributed under the License is distributed on an
# KIND, either express or implied.  See the License for the
# specific language governing permissions and limitations
# under the License.

from typing import TYPE_CHECKING, Iterable, Optional, Sequence, Union

from airflow.models import BaseOperator
from import RedshiftSQLHook
from airflow.www import utils as wwwutils

    from airflow.utils.context import Context

[docs]class RedshiftSQLOperator(BaseOperator): """ Executes SQL Statements against an Amazon Redshift cluster .. seealso:: For more information on how to use this operator, take a look at the guide: :ref:`howto/operator:RedshiftSQLOperator` :param sql: the SQL code to be executed as a single string, or a list of str (sql statements), or a reference to a template file. Template references are recognized by str ending in '.sql' :param redshift_conn_id: reference to :ref:`Amazon Redshift connection id<howto/connection:redshift>` :param parameters: (optional) the parameters to render the SQL query with. :param autocommit: if True, each command is automatically committed. (default value: False) """
[docs] template_fields: Sequence[str] = ('sql',)
[docs] template_ext: Sequence[str] = ('.sql',)
# TODO: Remove renderer check when the provider has an Airflow 2.3+ requirement.
[docs] template_fields_renderers = { "sql": "postgresql" if "postgresql" in wwwutils.get_attr_renderer() else "sql"
} def __init__( self, *, sql: Union[str, Iterable[str]], redshift_conn_id: str = 'redshift_default', parameters: Optional[dict] = None, autocommit: bool = True, **kwargs, ) -> None: super().__init__(**kwargs) self.redshift_conn_id = redshift_conn_id self.sql = sql self.autocommit = autocommit self.parameters = parameters
[docs] def get_hook(self) -> RedshiftSQLHook: """Create and return RedshiftSQLHook. :return RedshiftSQLHook: A RedshiftSQLHook instance. """ return RedshiftSQLHook(redshift_conn_id=self.redshift_conn_id)
[docs] def execute(self, context: 'Context') -> None: """Execute a statement against Amazon Redshift""""Executing statement: %s", self.sql) hook = self.get_hook(), autocommit=self.autocommit, parameters=self.parameters)

Was this entry helpful?