Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Correctly render results_parser_callable parameter in Qubole operator docs #25514

Merged
merged 1 commit into from
Aug 4, 2022
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
39 changes: 13 additions & 26 deletions airflow/providers/qubole/operators/qubole_check.py
Original file line number Diff line number Diff line change
Expand Up @@ -86,19 +86,15 @@ class QuboleCheckOperator(_QuboleCheckOperatorMixin, SQLCheckOperator, QuboleOpe
: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.

: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.

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

Expand Down Expand Up @@ -138,28 +134,19 @@ class QuboleValueCheckOperator(_QuboleCheckOperatorMixin, SQLValueCheckOperator,
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 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.

: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.


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