aito.utils.sql_connection.SQLConnection

class aito.utils.sql_connection.SQLConnection(sql_driver: str, sql_server: str = None, sql_port: str = None, sql_database: str = None, sql_username: str = None, sql_password: str = None)

Bases: object

Connection to a SQL Database using the pyodbc module

Parameters
  • sql_driver (str) – ODBC driver name

  • sql_server (str, optional) – database server, defaults to None

  • sql_port (str, optional) – database port, defaults to None

  • sql_database (str, optional) – database name, defaults to None

  • sql_username (str, optional) – database username, defaults to None

  • sql_password (str, optional) – database password, defaults to None

Raises

SQLConnectionError – An error occurred during the establishment of the connection

Methods

close()

close the connection

execute_query(query_string)

execute a query

execute_query_and_save_result(query)

execute a query and save the result to pandas DataFrame

save_cursor_result_to_df(cursor)

Save the executed query cursor to a pandas DataFrame

close()

close the connection

execute_query(query_string: str) → pyodbc.Cursor

execute a query

Parameters

query_string (str) – input query

Raises

SQLConnectionError – An error occurred during the execution of the query

Returns

cursor

Return type

pyodbc.Cursor

execute_query_and_save_result(query: str) → pandas.DataFrame

execute a query and save the result to pandas DataFrame

Parameters

query (str) – input query

Returns

result Pandas DataFrame

Return type

pd.DataFrame

static save_cursor_result_to_df(cursor: pyodbc.Cursor) → pandas.DataFrame

Save the executed query cursor to a pandas DataFrame

Parameters

cursor (pyodbc.Cursor) – query cursor

Returns

result Pandas DataFrame

Return type

pd.DataFrame