.. _f-columngroupoperator:

module ``generic.column_group_operator``
========================================





.. inheritance-diagram:: pysqllike.generic.column_group_operator


Short summary
+++++++++++++

module ``pysqllike.generic.column_group_operator``

Creates custom classes to interpret Python expression as column operations.


:githublink:`%|py|6`




Classes
+++++++

+--------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------+
| class                                                                                      | truncated documentation                                                             |
+============================================================================================+=====================================================================================+
| :class:`ColumnGroupOperator <pysqllike.generic.column_group_operator.ColumnGroupOperator>` | Defines an operation between two columns.                                           |
+--------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------+
| :class:`OperatorGroupAvg <pysqllike.generic.column_group_operator.OperatorGroupAvg>`       | defines the group function ``avg``, the default value when the set is empty is None |
+--------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------+
| :class:`OperatorGroupLen <pysqllike.generic.column_group_operator.OperatorGroupLen>`       | defines the group function ``len``                                                  |
+--------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------+










Methods
+++++++

+--------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------+
| method                                                                                     | truncated documentation                                                                                |
+============================================================================================+========================================================================================================+
| :py:meth:`__call__ <pysqllike.generic.column_group_operator.ColumnGroupOperator.__call__>` | returns the results of this operation between a list of columns                                        |
+--------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------+
| :py:meth:`__call__ <pysqllike.generic.column_group_operator.OperatorGroupAvg.__call__>`    | returns the results of this operation between a list of columns, it returns :class:`NA` for a null set |
+--------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------+
| :py:meth:`__call__ <pysqllike.generic.column_group_operator.OperatorGroupLen.__call__>`    | returns the results of this operation between a list of columns                                        |
+--------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------+
| :py:meth:`__init__ <pysqllike.generic.column_group_operator.ColumnGroupOperator.__init__>` | Initiates the operator.                                                                                |
+--------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------+
| :py:meth:`__init__ <pysqllike.generic.column_group_operator.OperatorGroupAvg.__init__>`    | Initiates the operator.                                                                                |
+--------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------+
| :py:meth:`__init__ <pysqllike.generic.column_group_operator.OperatorGroupLen.__init__>`    | Initiates the operator.                                                                                |
+--------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------+
| :py:meth:`__str__ <pysqllike.generic.column_group_operator.ColumnGroupOperator.__str__>`   | usual                                                                                                  |
+--------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------+
| :py:meth:`__str__ <pysqllike.generic.column_group_operator.OperatorGroupAvg.__str__>`      | usual                                                                                                  |
+--------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------+
| :py:meth:`__str__ <pysqllike.generic.column_group_operator.OperatorGroupLen.__str__>`      | usual                                                                                                  |
+--------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------+


Documentation
+++++++++++++

.. automodule:: pysqllike.generic.column_group_operator
    :members:
    :special-members: __init__
    :show-inheritance: