Source code for airflow.providers.mysql.operators.mysql

# 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.
import ast
from typing import TYPE_CHECKING, Iterable, List, Mapping, Optional, Sequence, Union

from airflow.models import BaseOperator
from airflow.providers.mysql.hooks.mysql import MySqlHook
from airflow.www import utils as wwwutils

    from airflow.utils.context import Context

[docs]class MySqlOperator(BaseOperator): """ Executes sql code in a specific MySQL database .. seealso:: For more information on how to use this operator, take a look at the guide: :ref:`howto/operator:MySqlOperator` :param sql: the sql code to be executed. Can receive a str representing a sql statement, a list of str (sql statements), or reference to a template file. Template reference are recognized by str ending in '.sql' (templated) :param mysql_conn_id: Reference to :ref:`mysql connection id <howto/connection:mysql>`. :param parameters: (optional) the parameters to render the SQL query with. Template reference are recognized by str ending in '.json' (templated) :param autocommit: if True, each command is automatically committed. (default value: False) :param database: name of database which overwrite defined one in connection """
[docs] template_fields: Sequence[str] = ('sql', 'parameters')
# TODO: Remove renderer check when the provider has an Airflow 2.3+ requirement.
[docs] template_fields_renderers = { 'sql': 'mysql' if 'mysql' in wwwutils.get_attr_renderer() else 'sql', 'parameters': 'json',
[docs] template_ext: Sequence[str] = ('.sql', '.json')
[docs] ui_color = '#ededed'
def __init__( self, *, sql: Union[str, List[str]], mysql_conn_id: str = 'mysql_default', parameters: Optional[Union[Mapping, Iterable]] = None, autocommit: bool = False, database: Optional[str] = None, **kwargs, ) -> None: super().__init__(**kwargs) self.mysql_conn_id = mysql_conn_id self.sql = sql self.autocommit = autocommit self.parameters = parameters self.database = database
[docs] def prepare_template(self) -> None: """Parse template file for attribute parameters.""" if isinstance(self.parameters, str): self.parameters = ast.literal_eval(self.parameters)
[docs] def execute(self, context: 'Context') -> None:'Executing: %s', self.sql) hook = MySqlHook(mysql_conn_id=self.mysql_conn_id, schema=self.database), autocommit=self.autocommit, parameters=self.parameters)

Was this entry helpful?