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 import AwsBaseSensor
from import aws_template_fields

    from airflow.utils.context import Context

from airflow.exceptions import AirflowException, AirflowSkipException
from import AthenaHook

[docs]class AthenaSensor(AwsBaseSensor[AthenaHook]): """ Poll the state of the Query until it reaches a terminal state; fails if the query fails. .. 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 sleep_time: Time in seconds to wait between two consecutive call to check query status on athena, defaults to 10 :param aws_conn_id: The Airflow connection used for AWS credentials. If this is ``None`` or empty then the default boto3 behaviour is used. If running Airflow in a distributed manner and aws_conn_id is None or empty, then default boto3 configuration would be used (and must be maintained on each worker node). :param region_name: AWS region_name. If not specified then the default boto3 behaviour is used. :param verify: Whether or not to verify SSL certificates. See: :param botocore_config: Configuration dictionary (key-values) for botocore client. See: """
[docs] aws_hook_class = AthenaHook
[docs] template_fields: Sequence[str] = aws_template_fields( "query_execution_id", )
[docs] ui_color = "#66c3ff"
def __init__( self, *, query_execution_id: str, max_retries: int | None = None, sleep_time: int = 10, **kwargs: Any, ) -> None: super().__init__(**kwargs) 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, self.sleep_time) if state in self.FAILURE_STATES: # TODO: remove this if block when min_airflow_version is set to higher than 2.7.1 message = "Athena sensor failed" if self.soft_fail: raise AirflowSkipException(message) raise AirflowException(message) if state in self.INTERMEDIATE_STATES: return False return True

Was this entry helpful?