docs-archive/apache-airflow-providers-mongo/3.0.0/_sources/_api/airflow/providers/mongo/sensors/mongo/index.rst.txt

:py:mod:`airflow.providers.mongo.sensors.mongo`
===============================================

.. py:module:: airflow.providers.mongo.sensors.mongo


Module Contents
---------------

Classes
~~~~~~~

.. autoapisummary::

   airflow.providers.mongo.sensors.mongo.MongoSensor




.. py:class:: MongoSensor(*, collection, query, mongo_conn_id = 'mongo_default', mongo_db=None, **kwargs)

   Bases: :py:obj:`airflow.sensors.base.BaseSensorOperator`

   Checks for the existence of a document which
   matches the given query in MongoDB. Example:

   >>> mongo_sensor = MongoSensor(collection="coll",
   ...                            query={"key": "value"},
   ...                            mongo_conn_id="mongo_default",
   ...                            mongo_db="admin",
   ...                            task_id="mongo_sensor")

   :param collection: Target MongoDB collection.
   :param query: The query to find the target document.
   :param mongo_conn_id: The :ref:`Mongo connection id <howto/connection:mongo>` to use
       when connecting to MongoDB.
   :param mongo_db: Target MongoDB name.

   .. py:attribute:: template_fields
      :annotation: :Sequence[str] = ['collection', 'query']

      

   .. py:method:: poke(self, context)

      Function that the sensors defined while deriving this class should
      override.