Source code for airflow.providers.jdbc.operators.jdbc

# 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, List, Mapping, Optional, Sequence, Union

from airflow.models import BaseOperator
from airflow.providers.jdbc.hooks.jdbc import JdbcHook

    from airflow.utils.context import Context

[docs]def fetch_all_handler(cursor): """Handler for to return results""" return cursor.fetchall()
[docs]class JdbcOperator(BaseOperator): """ Executes sql code in a database using jdbc driver. Requires jaydebeapi. .. seealso:: For more information on how to use this operator, take a look at the guide: :ref:`howto/operator:JdbcOperator` :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 jdbc_conn_id: reference to a predefined database :param autocommit: if True, each command is automatically committed. (default value: False) :param parameters: (optional) the parameters to render the SQL query with. """
[docs] template_fields: Sequence[str] = ('sql',)
[docs] template_ext: Sequence[str] = ('.sql',)
[docs] template_fields_renderers = {'sql': 'sql'}
[docs] ui_color = '#ededed'
def __init__( self, *, sql: Union[str, List[str]], jdbc_conn_id: str = 'jdbc_default', autocommit: bool = False, parameters: Optional[Union[Mapping, Iterable]] = None, **kwargs, ) -> None: super().__init__(**kwargs) self.parameters = parameters self.sql = sql self.jdbc_conn_id = jdbc_conn_id self.autocommit = autocommit self.hook = None
[docs] def execute(self, context: 'Context') -> None:'Executing: %s', self.sql) hook = JdbcHook(jdbc_conn_id=self.jdbc_conn_id) return, self.autocommit, parameters=self.parameters, handler=fetch_all_handler)

Was this entry helpful?