.. _f-dbengine:

module ``dbengine``
===================





.. inheritance-diagram:: lightmlboard.dbengine


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

module ``lightmlboard.dbengine``

Manages a sqlite3 database.


:githublink:`%|py|5`




Classes
+++++++

+----------------------------------------------------------+----------------------------------------------+
| class                                                    | truncated documentation                      |
+==========================================================+==============================================+
| :class:`Database <lightmlboard.dbengine.Database>`       | Common functions about sqlite3.              |
+----------------------------------------------------------+----------------------------------------------+
| :class:`DBException <lightmlboard.dbengine.DBException>` | Exception raised by class :class:`Database`. |
+----------------------------------------------------------+----------------------------------------------+










Methods
+++++++

+---------------------------------------------------------------------------------+-------------------------------------------------------------+
| method                                                                          | truncated documentation                                     |
+=================================================================================+=============================================================+
| :py:meth:`__init__ <lightmlboard.dbengine.Database.__init__>`                   |                                                             |
+---------------------------------------------------------------------------------+-------------------------------------------------------------+
| :py:meth:`_check_connection <lightmlboard.dbengine.Database._check_connection>` | Check the SQL connection.                                   |
+---------------------------------------------------------------------------------+-------------------------------------------------------------+
| :py:meth:`_is_memory <lightmlboard.dbengine.Database._is_memory>`               | Tells if the database takes place in memory (``:memory:``). |
+---------------------------------------------------------------------------------+-------------------------------------------------------------+
| :meth:`close <lightmlboard.dbengine.Database.close>`                            | Close the database.                                         |
+---------------------------------------------------------------------------------+-------------------------------------------------------------+
| :meth:`commit <lightmlboard.dbengine.Database.commit>`                          | Call this function after any insert request.                |
+---------------------------------------------------------------------------------+-------------------------------------------------------------+
| :meth:`connect <lightmlboard.dbengine.Database.connect>`                        | Opens a connection to the database.                         |
+---------------------------------------------------------------------------------+-------------------------------------------------------------+
| :meth:`create_table <lightmlboard.dbengine.Database.create_table>`              | Creates a table.                                            |
+---------------------------------------------------------------------------------+-------------------------------------------------------------+
| :meth:`execute <lightmlboard.dbengine.Database.execute>`                        | Open a cursor with a query and return it to the user.       |
+---------------------------------------------------------------------------------+-------------------------------------------------------------+
| :meth:`get_file <lightmlboard.dbengine.Database.get_file>`                      | Returns the file name.                                      |
+---------------------------------------------------------------------------------+-------------------------------------------------------------+
| :meth:`get_table_list <lightmlboard.dbengine.Database.get_table_list>`          | Returns the list of tables.                                 |
+---------------------------------------------------------------------------------+-------------------------------------------------------------+
| :meth:`has_rows <lightmlboard.dbengine.Database.has_rows>`                      | Tells if a table has rows.                                  |
+---------------------------------------------------------------------------------+-------------------------------------------------------------+


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

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