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 __future__ import annotations

from typing import TYPE_CHECKING, Any, Sequence

    from airflow.utils.context import Context

from airflow.compat.functools import cached_property
from airflow.exceptions import AirflowException
from import AthenaHook
from airflow.sensors.base import BaseSensorOperator

[docs]class AthenaSensor(BaseSensorOperator): """ Asks for the state of the Query until it reaches a failure state or success state. If the query fails, the task will fail. .. seealso:: For more information on how to use this sensor, take a look at the guide: :ref:`howto/sensor:AthenaSensor` :param query_execution_id: query_execution_id to check the state of :param max_retries: Number of times to poll for query state before returning the current state, defaults to None :param aws_conn_id: aws connection to use, defaults to 'aws_default' :param sleep_time: Time in seconds to wait between two consecutive call to check query status on athena, defaults to 10 """
[docs] template_fields: Sequence[str] = ("query_execution_id",)
[docs] template_ext: Sequence[str] = ()
[docs] ui_color = "#66c3ff"
def __init__( self, *, query_execution_id: str, max_retries: int | None = None, aws_conn_id: str = "aws_default", sleep_time: int = 10, **kwargs: Any, ) -> None: super().__init__(**kwargs) self.aws_conn_id = aws_conn_id self.query_execution_id = query_execution_id self.sleep_time = sleep_time self.max_retries = max_retries
[docs] def poke(self, context: Context) -> bool: state = self.hook.poll_query_status(self.query_execution_id, self.max_retries) if state in self.FAILURE_STATES: raise AirflowException("Athena sensor failed") if state in self.INTERMEDIATE_STATES: return False return True
[docs] def hook(self) -> AthenaHook: """Create and return an AthenaHook""" return AthenaHook(self.aws_conn_id, sleep_time=self.sleep_time)

Was this entry helpful?