blob: 23c4c9692df03d7d69e4fc5f5e3caa8d34ed99d0 [file] [log] [blame]
:mod:`airflow.providers.mongo.sensors.mongo`
============================================
.. py:module:: airflow.providers.mongo.sensors.mongo
Module Contents
---------------
.. py:class:: MongoSensor(*, collection: str, query: dict, mongo_conn_id: str = 'mongo_default', **kwargs)
Bases: :class:`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",
... task_id="mongo_sensor")
:param collection: Target MongoDB collection.
:type collection: str
:param query: The query to find the target document.
:type query: dict
:param mongo_conn_id: The :ref:`Mongo connection id <howto/connection:mongo>` to use
when connecting to MongoDB.
:type mongo_conn_id: str
.. attribute:: template_fields
:annotation: = ['collection', 'query']
.. method:: poke(self, context: dict)