blob: 61a55dc35684165abd0d6b8ccfbba87f3501e5d8 [file] [log] [blame]
:py:mod:`airflow.providers.arangodb.sensors.arangodb`
=====================================================
.. py:module:: airflow.providers.arangodb.sensors.arangodb
Module Contents
---------------
Classes
~~~~~~~
.. autoapisummary::
airflow.providers.arangodb.sensors.arangodb.AQLSensor
.. py:class:: AQLSensor(*, query, arangodb_conn_id = 'arangodb_default', **kwargs)
Bases: :py:obj:`airflow.sensors.base.BaseSensorOperator`
Checks for the existence of a document which
matches the given query in ArangoDB. Example:
:param collection: Target DB collection.
:param query: The query to poke, or you can provide .sql file having the query
:param arangodb_conn_id: The :ref:`ArangoDB connection id <howto/connection:arangodb>` to use
when connecting to ArangoDB.
:param arangodb_db: Target ArangoDB name.
.. py:attribute:: template_fields
:annotation: :Sequence[str] = ['query']
.. py:attribute:: template_ext
:annotation: :Sequence[str] = ['.sql']
.. py:attribute:: template_fields_renderers
.. py:method:: poke(self, context)
Function that the sensors defined while deriving this class should
override.