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

:py:mod:`airflow.providers.apache.cassandra.sensors.record`
===========================================================

.. py:module:: airflow.providers.apache.cassandra.sensors.record

.. autoapi-nested-parse::

   This module contains sensor that check the existence
   of a record in a Cassandra cluster.



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

Classes
~~~~~~~

.. autoapisummary::

   airflow.providers.apache.cassandra.sensors.record.CassandraRecordSensor




.. py:class:: CassandraRecordSensor(*, keys, table, cassandra_conn_id = CassandraHook.default_conn_name, **kwargs)

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

   Checks for the existence of a record in a Cassandra cluster.

   .. seealso::
       For more information on how to use this operator, take a look at the guide:
       :ref:`howto/operator:CassandraRecordSensor`

   For example, if you want to wait for a record that has values 'v1' and 'v2' for each
   primary keys 'p1' and 'p2' to be populated in keyspace 'k' and table 't',
   instantiate it as follows:

   >>> cassandra_sensor = CassandraRecordSensor(table="k.t",
   ...                                          keys={"p1": "v1", "p2": "v2"},
   ...                                          cassandra_conn_id="cassandra_default",
   ...                                          task_id="cassandra_sensor")

   :param table: Target Cassandra table.
       Use dot notation to target a specific keyspace.
   :param keys: The keys and their values to be monitored
   :param cassandra_conn_id: The connection ID to use
       when connecting to Cassandra cluster

   .. py:attribute:: template_fields
      :annotation: :Sequence[str] = ['table', 'keys']

      

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

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