.. _f-databasemain:

module ``sql.database_main``
============================





.. inheritance-diagram:: pyensae.sql.database_main


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

module ``pyensae.sql.database_main``

generic class to access a SQL database


:githublink:`%|py|5`




Classes
+++++++

+--------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+
| class                                                  | truncated documentation                                                                                                |
+========================================================+========================================================================================================================+
| :class:`Database <pyensae.sql.database_main.Database>` | This class allows the user to load table from text files and store them into a SQL file which can be empty or not, ... |
+--------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+








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

+------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------+
| staticmethod                                                                 | truncated documentation                                                                    |
+==============================================================================+============================================================================================+
| :meth:`fill_sql_table <pyensae.sql.database_main.Database.fill_sql_table>`   | Returns a Database object, creates the database if it does not exists, same for the table. |
+------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------+
| :meth:`schema_database <pyensae.sql.database_main.Database.schema_database>` | Returns the schema for a database which would contains this database.                      |
+------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------+




Methods
+++++++

+--------------------------------------------------------------------------------+-----------------------------------------------------------------------+
| method                                                                         | truncated documentation                                               |
+================================================================================+=======================================================================+
| :py:meth:`__init__ <pyensae.sql.database_main.Database.__init__>`              |                                                                       |
+--------------------------------------------------------------------------------+-----------------------------------------------------------------------+
| :meth:`copy_to <pyensae.sql.database_main.Database.copy_to>`                   | Copies all tables into db, we assume both database are not connected. |
+--------------------------------------------------------------------------------+-----------------------------------------------------------------------+
| :meth:`import_dataframe <pyensae.sql.database_main.Database.import_dataframe>` | Imports a DataFrame into a table.                                     |
+--------------------------------------------------------------------------------+-----------------------------------------------------------------------+
| :meth:`to_df <pyensae.sql.database_main.Database.to_df>`                       | Converts a SQL request into a :epkg:`pandas:Dataframe`.               |
+--------------------------------------------------------------------------------+-----------------------------------------------------------------------+


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

.. automodule:: pyensae.sql.database_main
    :members:
    :special-members: __init__
    :show-inheritance: