Source code for airflow.providers.qubole.sensors.qubole
#
# 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__ import annotations
from typing import TYPE_CHECKING, Sequence
from qds_sdk.qubole import Qubole
from qds_sdk.sensors import FileSensor, PartitionSensor
from airflow.exceptions import AirflowException
from airflow.hooks.base import BaseHook
from airflow.sensors.base import BaseSensorOperator
if TYPE_CHECKING:
from airflow.utils.context import Context
[docs]class QuboleSensor(BaseSensorOperator):
"""Base class for all Qubole Sensors."""
[docs] template_fields: Sequence[str] = ("data", "qubole_conn_id")
[docs] template_ext: Sequence[str] = (".txt",)
def __init__(self, *, data, qubole_conn_id: str = "qubole_default", **kwargs) -> None:
self.data = data
self.qubole_conn_id = qubole_conn_id
if "poke_interval" in kwargs and kwargs["poke_interval"] < 5:
raise AirflowException(
f"Sorry, poke_interval can't be less than 5 sec for task '{kwargs['task_id']}' "
f"in dag '{kwargs['dag'].dag_id}'."
)
super().__init__(**kwargs)
[docs] def poke(self, context: Context) -> bool:
conn = BaseHook.get_connection(self.qubole_conn_id)
Qubole.configure(api_token=conn.password, api_url=conn.host)
self.log.info("Poking: %s", self.data)
status = False
try:
status = self.sensor_class.check(self.data) # type: ignore[attr-defined]
except Exception as e:
self.log.exception(e)
status = False
self.log.info("Status of this Poke: %s", status)
return status
[docs]class QuboleFileSensor(QuboleSensor):
"""
Wait for a file or folder to be present in cloud storage.
Check for file or folder presence via QDS APIs.
.. seealso::
For more information on how to use this sensor, take a look at the guide:
:ref:`howto/operator:QuboleFileSensor`
:param qubole_conn_id: Connection id which consists of qds auth_token
:param data: a JSON object containing payload, whose presence needs to be checked
Check this `example <https://github.com/apache/airflow/blob/main\
/airflow/providers/qubole/example_dags/example_qubole_sensor.py>`_ for sample payload
structure.
.. note:: Both ``data`` and ``qubole_conn_id`` fields support templating. You can
also use ``.txt`` files for template-driven use cases.
"""
def __init__(self, **kwargs) -> None:
self.sensor_class = FileSensor
super().__init__(**kwargs)
[docs]class QubolePartitionSensor(QuboleSensor):
"""
Wait for a Hive partition to show up in QHS (Qubole Hive Service).
Check for Hive partition presence via QDS APIs.
.. seealso::
For more information on how to use this sensor, take a look at the guide:
:ref:`howto/operator:QubolePartitionSensor`
:param qubole_conn_id: Connection id which consists of qds auth_token
:param data: a JSON object containing payload, whose presence needs to be checked.
Check this `example <https://github.com/apache/airflow/blob/main\
/airflow/providers/qubole/example_dags/example_qubole_sensor.py>`_ for sample payload
structure.
.. note:: Both ``data`` and ``qubole_conn_id`` fields support templating. You can
also use ``.txt`` files for template-driven use cases.
"""
def __init__(self, **kwargs) -> None:
self.sensor_class = PartitionSensor
super().__init__(**kwargs)
