.. _l-classes:

Classes
=======

.. contents::
    :local:
    :depth: 1


Summary
+++++++

+--------------------------------------------------------------------------------------------+--------------+---------------------------------------------------------------------------------------------------+
| class                                                                                      | class parent | truncated documentation                                                                           |
+============================================================================================+==============+===================================================================================================+
| :class:`CFT <pysqllike.generic.column_type.CFT>`                                           |              | defines a function                                                                                |
+--------------------------------------------------------------------------------------------+--------------+---------------------------------------------------------------------------------------------------+
| :class:`CodeException <pysqllike.translation.code_exception.CodeException>`                |              | Custom exception for this subfolder.                                                              |
+--------------------------------------------------------------------------------------------+--------------+---------------------------------------------------------------------------------------------------+
| :class:`CodeNodeVisitor <pysqllike.translation.node_visitor_translator.CodeNodeVisitor>`   |              | Defines a visitor which walks though the syntax tree of the code.                                 |
+--------------------------------------------------------------------------------------------+--------------+---------------------------------------------------------------------------------------------------+
| :class:`ColumnConstantType <pysqllike.generic.column_type.ColumnConstantType>`             |              | defines a constant as a column                                                                    |
+--------------------------------------------------------------------------------------------+--------------+---------------------------------------------------------------------------------------------------+
| :class:`ColumnGroupOperator <pysqllike.generic.column_group_operator.ColumnGroupOperator>` |              | Defines an operation between two columns.                                                         |
+--------------------------------------------------------------------------------------------+--------------+---------------------------------------------------------------------------------------------------+
| :class:`ColumnGroupType <pysqllike.generic.column_type.ColumnGroupType>`                   |              | defines a column which processes a group of rows (after a groupby)                                |
+--------------------------------------------------------------------------------------------+--------------+---------------------------------------------------------------------------------------------------+
| :class:`ColumnOperator <pysqllike.generic.column_operator.ColumnOperator>`                 |              | defines an operation between two columns                                                          |
+--------------------------------------------------------------------------------------------+--------------+---------------------------------------------------------------------------------------------------+
| :class:`ColumnTableType <pysqllike.generic.column_type.ColumnTableType>`                   |              | defines a table column (not coming from an expression)                                            |
+--------------------------------------------------------------------------------------------+--------------+---------------------------------------------------------------------------------------------------+
| :class:`ColumnType <pysqllike.generic.column_type.ColumnType>`                             |              | Defines a column of a table.                                                                      |
+--------------------------------------------------------------------------------------------+--------------+---------------------------------------------------------------------------------------------------+
| :class:`EmptyGroup <pysqllike.generic.others_types.EmptyGroup>`                            |              | defines an empty group                                                                            |
+--------------------------------------------------------------------------------------------+--------------+---------------------------------------------------------------------------------------------------+
| :class:`GroupByContainer <pysqllike.generic.others_types.GroupByContainer>`                |              | to differiate between a list and a list introduced by a groupby                                   |
+--------------------------------------------------------------------------------------------+--------------+---------------------------------------------------------------------------------------------------+
| :class:`IterException <pysqllike.generic.iter_exceptions.IterException>`                   |              | custom exception                                                                                  |
+--------------------------------------------------------------------------------------------+--------------+---------------------------------------------------------------------------------------------------+
| :class:`IterRow <pysqllike.generic.iter_rows.IterRow>`                                     |              | Defines an iterator which mimic SQL behavior.                                                     |
+--------------------------------------------------------------------------------------------+--------------+---------------------------------------------------------------------------------------------------+
| :class:`NA <pysqllike.generic.others_types.NA>`                                            |              | Defines the missing type.                                                                         |
+--------------------------------------------------------------------------------------------+--------------+---------------------------------------------------------------------------------------------------+
| :class:`NoSortClass <pysqllike.generic.others_types.NoSortClass>`                          |              | Container which overloads the sort operator to return 0 all the times.                            |
+--------------------------------------------------------------------------------------------+--------------+---------------------------------------------------------------------------------------------------+
| :class:`NotAllowedOperation <pysqllike.generic.iter_exceptions.NotAllowedOperation>`       |              | custom exception                                                                                  |
+--------------------------------------------------------------------------------------------+--------------+---------------------------------------------------------------------------------------------------+
| :class:`OperatorAdd <pysqllike.generic.column_operator.OperatorAdd>`                       |              | defines the addition                                                                              |
+--------------------------------------------------------------------------------------------+--------------+---------------------------------------------------------------------------------------------------+
| :class:`OperatorAnd <pysqllike.generic.column_operator.OperatorAnd>`                       |              | defines ``and``                                                                                   |
+--------------------------------------------------------------------------------------------+--------------+---------------------------------------------------------------------------------------------------+
| :class:`OperatorDiv <pysqllike.generic.column_operator.OperatorDiv>`                       |              | defines the division                                                                              |
+--------------------------------------------------------------------------------------------+--------------+---------------------------------------------------------------------------------------------------+
| :class:`OperatorDivN <pysqllike.generic.column_operator.OperatorDivN>`                     |              | defines the division //                                                                           |
+--------------------------------------------------------------------------------------------+--------------+---------------------------------------------------------------------------------------------------+
| :class:`OperatorEq <pysqllike.generic.column_operator.OperatorEq>`                         |              | defines ==                                                                                        |
+--------------------------------------------------------------------------------------------+--------------+---------------------------------------------------------------------------------------------------+
| :class:`OperatorFunc <pysqllike.generic.column_operator.OperatorFunc>`                     |              | defines a function call                                                                           |
+--------------------------------------------------------------------------------------------+--------------+---------------------------------------------------------------------------------------------------+
| :class:`OperatorGe <pysqllike.generic.column_operator.OperatorGe>`                         |              | defines >=                                                                                        |
+--------------------------------------------------------------------------------------------+--------------+---------------------------------------------------------------------------------------------------+
| :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``                                                                |
+--------------------------------------------------------------------------------------------+--------------+---------------------------------------------------------------------------------------------------+
| :class:`OperatorGt <pysqllike.generic.column_operator.OperatorGt>`                         |              | defines >                                                                                         |
+--------------------------------------------------------------------------------------------+--------------+---------------------------------------------------------------------------------------------------+
| :class:`OperatorId <pysqllike.generic.column_operator.OperatorId>`                         |              | defines a constant                                                                                |
+--------------------------------------------------------------------------------------------+--------------+---------------------------------------------------------------------------------------------------+
| :class:`OperatorLe <pysqllike.generic.column_operator.OperatorLe>`                         |              | defines <=                                                                                        |
+--------------------------------------------------------------------------------------------+--------------+---------------------------------------------------------------------------------------------------+
| :class:`OperatorLt <pysqllike.generic.column_operator.OperatorLt>`                         |              | defines <                                                                                         |
+--------------------------------------------------------------------------------------------+--------------+---------------------------------------------------------------------------------------------------+
| :class:`OperatorMod <pysqllike.generic.column_operator.OperatorMod>`                       |              | defines the operator mod                                                                          |
+--------------------------------------------------------------------------------------------+--------------+---------------------------------------------------------------------------------------------------+
| :class:`OperatorMul <pysqllike.generic.column_operator.OperatorMul>`                       |              | defines the multiplication                                                                        |
+--------------------------------------------------------------------------------------------+--------------+---------------------------------------------------------------------------------------------------+
| :class:`OperatorNe <pysqllike.generic.column_operator.OperatorNe>`                         |              | defines !=                                                                                        |
+--------------------------------------------------------------------------------------------+--------------+---------------------------------------------------------------------------------------------------+
| :class:`OperatorNot <pysqllike.generic.column_operator.OperatorNot>`                       |              | defines ``not``                                                                                   |
+--------------------------------------------------------------------------------------------+--------------+---------------------------------------------------------------------------------------------------+
| :class:`OperatorOr <pysqllike.generic.column_operator.OperatorOr>`                         |              | defines ``or``                                                                                    |
+--------------------------------------------------------------------------------------------+--------------+---------------------------------------------------------------------------------------------------+
| :class:`OperatorPow <pysqllike.generic.column_operator.OperatorPow>`                       |              | defines the power                                                                                 |
+--------------------------------------------------------------------------------------------+--------------+---------------------------------------------------------------------------------------------------+
| :class:`OperatorSub <pysqllike.generic.column_operator.OperatorSub>`                       |              | defines the subtraction                                                                           |
+--------------------------------------------------------------------------------------------+--------------+---------------------------------------------------------------------------------------------------+
| :class:`SchemaException <pysqllike.generic.iter_exceptions.SchemaException>`               |              | custom exception                                                                                  |
+--------------------------------------------------------------------------------------------+--------------+---------------------------------------------------------------------------------------------------+
| :class:`Translate2Python <pysqllike.translation.translation_to_python.Translate2Python>`   |              | Translates a code into :epkg:`Python`.                                                            |
+--------------------------------------------------------------------------------------------+--------------+---------------------------------------------------------------------------------------------------+
| :class:`TranslateClass <pysqllike.translation.translation_class.TranslateClass>`           |              | Interface for a class which translates a code written in pseudo-SQL syntax into another language. |
+--------------------------------------------------------------------------------------------+--------------+---------------------------------------------------------------------------------------------------+
| :class:`long <pysqllike.generic.others_types.long>`                                        |              | Defines the long type as int.                                                                     |
+--------------------------------------------------------------------------------------------+--------------+---------------------------------------------------------------------------------------------------+