Source code for airflow.contrib.sensors.azure_cosmos_sensor

# -*- coding: utf-8 -*-
#
# 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 airflow.contrib.hooks.azure_cosmos_hook import AzureCosmosDBHook
from airflow.sensors.base_sensor_operator import BaseSensorOperator
from airflow.utils.decorators import apply_defaults


[docs]class AzureCosmosDocumentSensor(BaseSensorOperator):
    """
    Checks for the existence of a document which
    matches the given query in CosmosDB. Example:

    >>> azure_cosmos_sensor = AzureCosmosDocumentSensor(database_name="somedatabase_name",
    ...                            collection_name="somecollection_name",
    ...                            document_id="unique-doc-id",
    ...                            azure_cosmos_conn_id="azure_cosmos_default",
    ...                            task_id="azure_cosmos_sensor")
    """
[docs]    template_fields = ('database_name', 'collection_name', 'document_id')

    @apply_defaults
    def __init__(
            self,
            database_name,
            collection_name,
            document_id,
            azure_cosmos_conn_id="azure_cosmos_default",
            *args,
            **kwargs):
        """
        Create a new AzureCosmosDocumentSensor

        :param database_name: Target CosmosDB database_name.
        :type database_name: str
        :param collection_name: Target CosmosDB collection_name.
        :type collection_name: str
        :param document_id: The ID of the target document.
        :type query: str
        :param azure_cosmos_conn_id: Reference to the Azure CosmosDB connection.
        :type azure_cosmos_conn_id: str
        """
        super(AzureCosmosDocumentSensor, self).__init__(*args, **kwargs)
        self.azure_cosmos_conn_id = azure_cosmos_conn_id
        self.database_name = database_name
        self.collection_name = collection_name
        self.document_id = document_id

[docs]    def poke(self, context):
        self.log.info("*** Intering poke")
        hook = AzureCosmosDBHook(self.azure_cosmos_conn_id)
        return hook.get_document(self.document_id, self.database_name, self.collection_name) is not None