.. _f-iterrows:

module ``generic.iter_rows``
============================





.. inheritance-diagram:: pysqllike.generic.iter_rows


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

module ``pysqllike.generic.iter_rows``

An class which iterates on any set.


:githublink:`%|py|6`




Classes
+++++++

+--------------------------------------------------------+-----------------------------------------------+
| class                                                  | truncated documentation                       |
+========================================================+===============================================+
| :class:`IterRow <pysqllike.generic.iter_rows.IterRow>` | Defines an iterator which mimic SQL behavior. |
+--------------------------------------------------------+-----------------------------------------------+






Properties
++++++++++

+-------------------------------------------------------------+-------------------------+
| property                                                    | truncated documentation |
+=============================================================+=========================+
| :meth:`Schema <pysqllike.generic.iter_rows.IterRow.Schema>` | return _schema          |
+-------------------------------------------------------------+-------------------------+






Methods
+++++++

+--------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
| method                                                                   | truncated documentation                                                                 |
+==========================================================================+=========================================================================================+
| :py:meth:`__call__ <pysqllike.generic.iter_rows.IterRow.__call__>`       | evaluate                                                                                |
+--------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
| :py:meth:`__init__ <pysqllike.generic.iter_rows.IterRow.__init__>`       | Initializes the iterator.                                                               |
+--------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
| :py:meth:`__iter__ <pysqllike.generic.iter_rows.IterRow.__iter__>`       | iterator, returns this row, it always outputs a list of list                            |
+--------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
| :py:meth:`__str__ <pysqllike.generic.iter_rows.IterRow.__str__>`         | usual                                                                                   |
+--------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
| :py:meth:`_findschema <pysqllike.generic.iter_rows.IterRow._findschema>` | look for column index whose name is name                                                |
+--------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
| :meth:`groupby <pysqllike.generic.iter_rows.IterRow.groupby>`            | This function applies a groupby (same behavior as SQL's version)                        |
+--------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
| :meth:`orderby <pysqllike.generic.iter_rows.IterRow.orderby>`            | This function sorts elements from an IterRow instance.                                  |
+--------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
| :meth:`print_schema <pysqllike.generic.iter_rows.IterRow.print_schema>`  | calls :meth:`print_parent` on each column                                               |
+--------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
| :meth:`select <pysqllike.generic.iter_rows.IterRow.select>`              | This function takes an undefined number of arguments. It can be used the following way: |
+--------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
| :meth:`unionall <pysqllike.generic.iter_rows.IterRow.unionall>`          | Concatenates this table with another one                                                |
+--------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
| :meth:`where <pysqllike.generic.iter_rows.IterRow.where>`                | This function filters elements from an :class:`IterRow` instance.                       |
+--------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+


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

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