docs-archive/apache-airflow-providers-qubole/3.2.0/_sources/_api/airflow/providers/qubole/operators/qubole_check/index.rst.txt

:py:mod:`airflow.providers.qubole.operators.qubole_check`
=========================================================

.. py:module:: airflow.providers.qubole.operators.qubole_check


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

Classes
~~~~~~~

.. autoapisummary::

   airflow.providers.qubole.operators.qubole_check.QuboleCheckOperator
   airflow.providers.qubole.operators.qubole_check.QuboleValueCheckOperator



Functions
~~~~~~~~~

.. autoapisummary::

   airflow.providers.qubole.operators.qubole_check.get_sql_from_qbol_cmd
   airflow.providers.qubole.operators.qubole_check.handle_airflow_exception



.. py:class:: QuboleCheckOperator(*, qubole_conn_id = 'qubole_default', results_parser_callable = None, **kwargs)

   Bases: :py:obj:`_QuboleCheckOperatorMixin`, :py:obj:`airflow.providers.common.sql.operators.sql.SQLCheckOperator`, :py:obj:`airflow.providers.qubole.operators.qubole.QuboleOperator`

   Performs checks against Qubole Commands. ``QuboleCheckOperator`` expects
   a command that will be executed on QDS.
   By default, each value on first row of the result of this Qubole Command
   is evaluated using python ``bool`` casting. If any of the
   values return ``False``, the check is failed and errors out.

   Note that Python bool casting evals the following as ``False``:

   * ``False``
   * ``0``
   * Empty string (``""``)
   * Empty list (``[]``)
   * Empty dictionary or set (``{}``)

   Given a query like ``SELECT COUNT(*) FROM foo``, it will fail only if
   the count ``== 0``. You can craft much more complex query that could,
   for instance, check that the table has the same number of rows as
   the source table upstream, or that the count of today's partition is
   greater than yesterday's partition, or that a set of metrics are less
   than 3 standard deviation for the 7 day average.

   This operator can be used as a data quality check in your pipeline, and
   depending on where you put it in your DAG, you have the choice to
   stop the critical path, preventing from
   publishing dubious data, or on the side and receive email alerts
   without stopping the progress of the DAG.

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

   :param qubole_conn_id: Connection id which consists of qds auth_token
   :param results_parser_callable: This is an optional parameter to extend the flexibility of parsing the
       results of Qubole command to the users. This is a Python callable which can hold the logic to parse
       list of rows returned by Qubole command. By default, only the values on first row are used for
       performing checks. This callable should return a list of records on which the checks have to be
       performed.

   kwargs:
       Arguments specific to Qubole command can be referred from QuboleOperator docs.

   .. note:: All fields in common with template fields of
       QuboleOperator and SQLCheckOperator are template-supported.


   .. py:attribute:: template_fields
      :annotation: :Sequence[str]

      

   .. py:attribute:: template_ext
      

      

   .. py:attribute:: ui_fgcolor
      :annotation: = #000

      


.. py:class:: QuboleValueCheckOperator(*, pass_value, tolerance = None, results_parser_callable = None, qubole_conn_id = 'qubole_default', **kwargs)

   Bases: :py:obj:`_QuboleCheckOperatorMixin`, :py:obj:`airflow.providers.common.sql.operators.sql.SQLValueCheckOperator`, :py:obj:`airflow.providers.qubole.operators.qubole.QuboleOperator`

   Performs a simple value check using Qubole command.
   By default, each value on the first row of this
   Qubole command is compared with a pre-defined value.
   The check fails and errors out if the output of the command
   is not within the permissible limit of expected value.

   :param qubole_conn_id: Connection id which consists of qds auth_token
   :param pass_value: Expected value of the query results.
   :param tolerance: Defines the permissible pass_value range, for example if tolerance is 2, the Qubole
       command output can be anything between -2*pass_value and 2*pass_value, without the operator erring
       out.
   :param results_parser_callable: This is an optional parameter to extend the flexibility of parsing the
       results of Qubole command to the users. This is a Python callable which can hold the logic to parse
       list of rows returned by Qubole command. By default, only the values on first row are used for
       performing checks. This callable should return a list of records on which the checks have to be
       performed.

   kwargs:
       Arguments specific to Qubole command can be referred from QuboleOperator docs.

   .. note:: All fields in common with template fields of
           QuboleOperator and SQLValueCheckOperator are template-supported.

   .. py:attribute:: template_fields
      

      

   .. py:attribute:: template_ext
      

      

   .. py:attribute:: ui_fgcolor
      :annotation: = #000

      


.. py:function:: get_sql_from_qbol_cmd(params)

   Get Qubole sql from Qubole command


.. py:function:: handle_airflow_exception(airflow_exception, hook)

   Qubole check handle Airflow exception