Source code for airflow.providers.oracle.operators.oracle

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

from airflow.models import BaseOperator
from airflow.providers.oracle.hooks.oracle import OracleHook

if TYPE_CHECKING:
    from airflow.utils.context import Context


[docs]class OracleOperator(BaseOperator): """ Executes sql code in a specific Oracle database. :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 oracle_conn_id: The :ref:`Oracle connection id <howto/connection:oracle>` reference to a specific Oracle database. :param parameters: (optional, templated) 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] = ( 'parameters', '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]], oracle_conn_id: str = 'oracle_default', parameters: Optional[Union[Mapping, Iterable]] = None, autocommit: bool = False, **kwargs, ) -> None: super().__init__(**kwargs) self.oracle_conn_id = oracle_conn_id self.sql = sql self.autocommit = autocommit self.parameters = parameters
[docs] def execute(self, context: 'Context') -> None: self.log.info('Executing: %s', self.sql) hook = OracleHook(oracle_conn_id=self.oracle_conn_id) if self.sql: hook.run(self.sql, autocommit=self.autocommit, parameters=self.parameters)
[docs]class OracleStoredProcedureOperator(BaseOperator): """ Executes stored procedure in a specific Oracle database. :param procedure: name of stored procedure to call (templated) :param oracle_conn_id: The :ref:`Oracle connection id <howto/connection:oracle>` reference to a specific Oracle database. :param parameters: (optional, templated) the parameters provided in the call """
[docs] template_fields: Sequence[str] = ( 'parameters', 'procedure',
)
[docs] ui_color = '#ededed'
def __init__( self, *, procedure: str, oracle_conn_id: str = 'oracle_default', parameters: Optional[Union[Dict, List]] = None, **kwargs, ) -> None: super().__init__(**kwargs) self.oracle_conn_id = oracle_conn_id self.procedure = procedure self.parameters = parameters
[docs] def execute(self, context: 'Context') -> Optional[Union[List, Dict]]: self.log.info('Executing: %s', self.procedure) hook = OracleHook(oracle_conn_id=self.oracle_conn_id) return hook.callproc(self.procedure, autocommit=True, parameters=self.parameters)

Was this entry helpful?