.. _f-sqlinterface:

module ``sql.sql_interface``
============================





.. inheritance-diagram:: pyensae.sql.sql_interface


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

module ``pyensae.sql.sql_interface``

Abstract class to connect to a SQL server using various way.
It will be used to implement magic functions


:githublink:`%|py|7`




Classes
+++++++

+--------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------+
| class                                                                                | truncated documentation                                                                                   |
+======================================================================================+===========================================================================================================+
| :class:`AutoCompletionSQLObject <pyensae.sql.sql_interface.AutoCompletionSQLObject>` | a simple class which allows auto completion for tables, columns...                                        |
+--------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------+
| :class:`InterfaceSQL <pyensae.sql.sql_interface.InterfaceSQL>`                       | Abstract class to connect to a SQL server using various way. It will be used to implement magic functions |
+--------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------+
| :class:`InterfaceSQLException <pyensae.sql.sql_interface.InterfaceSQLException>`     | a specific exception                                                                                      |
+--------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------+






Properties
++++++++++

+----------------------------------------------------------------------+-------------------------------------+
| property                                                             | truncated documentation             |
+======================================================================+=====================================+
| :py:meth:`_ <pyensae.sql.sql_interface.AutoCompletionSQLObject._>`   | returns the true name of the object |
+----------------------------------------------------------------------+-------------------------------------+
| :py:meth:`_f <pyensae.sql.sql_interface.AutoCompletionSQLObject._f>` | returns the filtered name           |
+----------------------------------------------------------------------+-------------------------------------+




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

+------------------------------------------------------------------------------------------+--------------------------------+
| staticmethod                                                                             | truncated documentation        |
+==========================================================================================+================================+
| :py:meth:`_filter_name <pyensae.sql.sql_interface.AutoCompletionSQLObject._filter_name>` | removes unavailable characters |
+------------------------------------------------------------------------------------------+--------------------------------+
| :meth:`create <pyensae.sql.sql_interface.InterfaceSQL.create>`                           |                                |
+------------------------------------------------------------------------------------------+--------------------------------+




Methods
+++++++

+------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+
| method                                                                                   | truncated documentation                                                                                              |
+==========================================================================================+======================================================================================================================+
| :py:meth:`__init__ <pyensae.sql.sql_interface.AutoCompletionSQLObject.__init__>`         | creates an instance with a given name                                                                                |
+------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+
| :py:meth:`__init__ <pyensae.sql.sql_interface.InterfaceSQL.__init__>`                    | Initializes the object.                                                                                              |
+------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+
| :py:meth:`__init__ <pyensae.sql.sql_interface.InterfaceSQLException.__init__>`           |                                                                                                                      |
+------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+
| :py:meth:`__str__ <pyensae.sql.sql_interface.InterfaceSQLException.__str__>`             | usual                                                                                                                |
+------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+
| :py:meth:`_add <pyensae.sql.sql_interface.AutoCompletionSQLObject._add>`                 | add a subname to the class                                                                                           |
+------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+
| :meth:`add_function <pyensae.sql.sql_interface.InterfaceSQL.add_function>`               | add a function to the database which can be called in a SELECT statement                                             |
+------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+
| :meth:`close <pyensae.sql.sql_interface.InterfaceSQL.close>`                             | close the connection to the database                                                                                 |
+------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+
| :meth:`connect <pyensae.sql.sql_interface.InterfaceSQL.connect>`                         | connection to the database                                                                                           |
+------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+
| :meth:`drop_table <pyensae.sql.sql_interface.InterfaceSQL.drop_table>`                   | drops a table                                                                                                        |
+------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+
| :meth:`execute <pyensae.sql.sql_interface.InterfaceSQL.execute>`                         | execute a SQL query                                                                                                  |
+------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+
| :meth:`execute_clean_query <pyensae.sql.sql_interface.InterfaceSQL.execute_clean_query>` | The function does the same thing as :meth:`execute` but it does not replace autocompletion object. It is ...         |
+------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+
| :meth:`get_table_columns <pyensae.sql.sql_interface.InterfaceSQL.get_table_columns>`     | returns the list of columns in a table                                                                               |
+------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+
| :meth:`get_table_list <pyensae.sql.sql_interface.InterfaceSQL.get_table_list>`           | returns the list of tables in the database                                                                           |
+------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+
| :meth:`import_dataframe <pyensae.sql.sql_interface.InterfaceSQL.import_dataframe>`       | import a dataframe into the database                                                                                 |
+------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+
| :meth:`import_flat_file <pyensae.sql.sql_interface.InterfaceSQL.import_flat_file>`       | import a flat file as a table, we assume the columns separator is ``\t`` and the file name contains a header         |
+------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+
| :meth:`populate_completion <pyensae.sql.sql_interface.InterfaceSQL.populate_completion>` | the method create an object which contains a class the user could use to speed the typing SQL queries, functions ... |
+------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+
| :meth:`process_query <pyensae.sql.sql_interface.InterfaceSQL.process_query>`             | replaces autocompletion object by their real names                                                                   |
+------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+
| :meth:`refresh_completion <pyensae.sql.sql_interface.InterfaceSQL.refresh_completion>`   | refresh the auto completion                                                                                          |
+------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+


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

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