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.
import warnings
from typing import TYPE_CHECKING, Optional, Sequence

from import GlueCatalogHook
from airflow.sensors.base import BaseSensorOperator

    from airflow.utils.context import Context

[docs]class GlueCatalogPartitionSensor(BaseSensorOperator): """ Waits for a partition to show up in AWS Glue Catalog. :param table_name: The name of the table to wait for, supports the dot notation (my_database.my_table) :param expression: The partition clause to wait for. This is passed as is to the AWS Glue Catalog API's get_partitions function, and supports SQL like notation as in ``ds='2015-01-01' AND type='value'`` and comparison operators as in ``"ds>=2015-01-01"``. See #aws-glue-api-catalog-partitions-GetPartitions :param aws_conn_id: ID of the Airflow connection where credentials and extra configuration are stored :param region_name: Optional aws region name (example: us-east-1). Uses region from connection if not specified. :param database_name: The name of the catalog database where the partitions reside. :param poke_interval: Time in seconds that the job should wait in between each tries """
[docs] template_fields: Sequence[str] = ( 'database_name', 'table_name', 'expression',
[docs] ui_color = '#C5CAE9'
def __init__( self, *, table_name: str, expression: str = "ds='{{ ds }}'", aws_conn_id: str = 'aws_default', region_name: Optional[str] = None, database_name: str = 'default', poke_interval: int = 60 * 3, **kwargs, ): super().__init__(poke_interval=poke_interval, **kwargs) self.aws_conn_id = aws_conn_id self.region_name = region_name self.table_name = table_name self.expression = expression self.database_name = database_name self.hook: Optional[GlueCatalogHook] = None
[docs] def poke(self, context: 'Context'): """Checks for existence of the partition in the AWS Glue Catalog table""" if '.' in self.table_name: self.database_name, self.table_name = self.table_name.split('.') 'Poking for table %s. %s, expression %s', self.database_name, self.table_name, self.expression ) return self.get_hook().check_for_partition(self.database_name, self.table_name, self.expression)
[docs] def get_hook(self) -> GlueCatalogHook: """Gets the GlueCatalogHook""" if self.hook: return self.hook self.hook = GlueCatalogHook(aws_conn_id=self.aws_conn_id, region_name=self.region_name) return self.hook
[docs]class AwsGlueCatalogPartitionSensor(GlueCatalogPartitionSensor): """ This sensor is deprecated. Please use :class:``. """ def __init__(self, *args, **kwargs): warnings.warn( "This sensor is deprecated. " "Please use :class:``.", # noqa: 501 DeprecationWarning, stacklevel=2, ) super().__init__(*args, **kwargs)

Was this entry helpful?