.. _f-dbmanager:

module ``dbmanager``
====================





.. inheritance-diagram:: lightmlboard.dbmanager


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

module ``lightmlboard.dbmanager``

Manages a sqlite3 database to store the results.


:githublink:`%|py|5`




Classes
+++++++

+---------------------------------------------------------------------------+------------------------------------------------------------+
| class                                                                     | truncated documentation                                    |
+===========================================================================+============================================================+
| :class:`DatabaseCompetition <lightmlboard.dbmanager.DatabaseCompetition>` | Holds the data used for competitions. Tables: Competitions |
+---------------------------------------------------------------------------+------------------------------------------------------------+






Properties
++++++++++

+----------------------------------------------------------------------------+-------------------------+
| property                                                                   | truncated documentation |
+============================================================================+=========================+
| :meth:`Connection <lightmlboard.dbmanager.DatabaseCompetition.Connection>` | Returns the connexion.  |
+----------------------------------------------------------------------------+-------------------------+




Static Methods
++++++++++++++

+-----------------------------------------------------------------------------------------------+-------------------------+
| staticmethod                                                                                  | truncated documentation |
+===============================================================================================+=========================+
| :py:meth:`_col_competitions <lightmlboard.dbmanager.DatabaseCompetition._col_competitions>`   |                         |
+-----------------------------------------------------------------------------------------------+-------------------------+
| :py:meth:`_col_players <lightmlboard.dbmanager.DatabaseCompetition._col_players>`             |                         |
+-----------------------------------------------------------------------------------------------+-------------------------+
| :py:meth:`_col_submissions <lightmlboard.dbmanager.DatabaseCompetition._col_submissions>`     |                         |
+-----------------------------------------------------------------------------------------------+-------------------------+
| :py:meth:`_col_teams <lightmlboard.dbmanager.DatabaseCompetition._col_teams>`                 |                         |
+-----------------------------------------------------------------------------------------------+-------------------------+
| :py:meth:`_dummy_submissions <lightmlboard.dbmanager.DatabaseCompetition._dummy_submissions>` |                         |
+-----------------------------------------------------------------------------------------------+-------------------------+




Methods
+++++++

+------------------------------------------------------------------------------------------+---------------------------------------------------------------------+
| method                                                                                   | truncated documentation                                             |
+==========================================================================================+=====================================================================+
| :py:meth:`__init__ <lightmlboard.dbmanager.DatabaseCompetition.__init__>`                |                                                                     |
+------------------------------------------------------------------------------------------+---------------------------------------------------------------------+
| :py:meth:`_init <lightmlboard.dbmanager.DatabaseCompetition._init>`                      | Creates the tables if not present.                                  |
+------------------------------------------------------------------------------------------+---------------------------------------------------------------------+
| :meth:`get_competition <lightmlboard.dbmanager.DatabaseCompetition.get_competition>`     | Retrieves a competition.                                            |
+------------------------------------------------------------------------------------------+---------------------------------------------------------------------+
| :meth:`get_competitions <lightmlboard.dbmanager.DatabaseCompetition.get_competitions>`   | Returns the list of competitions as list of ``(cpt_id, cpt_name)``. |
+------------------------------------------------------------------------------------------+---------------------------------------------------------------------+
| :meth:`get_cpt_id <lightmlboard.dbmanager.DatabaseCompetition.get_cpt_id>`               | Returns the list of competation id.                                 |
+------------------------------------------------------------------------------------------+---------------------------------------------------------------------+
| :meth:`get_player_id <lightmlboard.dbmanager.DatabaseCompetition.get_player_id>`         | Returns the list of competation id.                                 |
+------------------------------------------------------------------------------------------+---------------------------------------------------------------------+
| :meth:`get_results <lightmlboard.dbmanager.DatabaseCompetition.get_results>`             | Retrieves the results of a competition.                             |
+------------------------------------------------------------------------------------------+---------------------------------------------------------------------+
| :meth:`init_from_options <lightmlboard.dbmanager.DatabaseCompetition.init_from_options>` | Initializes the database. It skips a table if it exists.            |
+------------------------------------------------------------------------------------------+---------------------------------------------------------------------+
| :meth:`submit <lightmlboard.dbmanager.DatabaseCompetition.submit>`                       | Adds a submission to the database.                                  |
+------------------------------------------------------------------------------------------+---------------------------------------------------------------------+
| :meth:`to_df <lightmlboard.dbmanager.DatabaseCompetition.to_df>`                         | Returns the content of a table as a dataframe.                      |
+------------------------------------------------------------------------------------------+---------------------------------------------------------------------+


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

.. automodule:: lightmlboard.dbmanager
    :members:
    :special-members: __init__
    :show-inheritance: