API Reference

SQLPyHelper

class sqlpyhelper.db_helper.SQLPyHelper(db_type: str | None = None, host: str | None = None, user: str | None = None, password: str | None = None, database: str | None = None, driver: str | None = None, port: str | None = None, oracle_sid: str | None = None)

Bases: object

backup_table(table_name: str, backup_file: str) → None

Exports table data into a CSV file. Example: backup_table(‘users’, ‘users_backup.csv’)

begin_transaction() → None

Begin an explicit transaction. Works across all supported databases.

close() → None

Closes the cursor and database connection.

commit_transaction() → None

Commit the current transaction.

create_table(table_name: str, columns: dict[str, str]) → None

Creates a table dynamically using a dictionary format. Example: columns = {‘id’: ‘INTEGER PRIMARY KEY’, ‘name’: ‘TEXT’, ‘age’: ‘INTEGER’}

execute_query(query: str, params: tuple | None = None) → None

Executes a query with optional parameters

fetch_all() → list[tuple]

Fetches all rows from the last executed query

fetch_by_param(table_name: str, column_name: str, value: Any) → list[tuple]

Fetches rows from a table where a column matches the given value.

fetch_one() → tuple | None

Fetches a single row

get_connection_from_pool() → Any

Fetches a connection from the pool.

insert_bulk(table_name: str, data: list[dict[str, Any]]) → None

Inserts multiple rows at once. Example: data = [{‘id’: 1, ‘name’: ‘Alice’}, {‘id’: 2, ‘name’: ‘Bob’}]

insert_dynamic(table: str, data: dict[str, Any]) → None

Dynamically constructs and executes an INSERT query with database-specific placeholders.

reconnect() → None

Reconnects to the database if connection is lost

return_connection_to_pool(connection: Any = None) → None

Returns a connection back to the pool.

rollback_transaction() → None

Roll back the current transaction.

setup_connection_pool(min_conn: int = 1, max_conn: int = 5, pool_size: int = 5) → None

Sets up connection pooling based on the database type

Exceptions

class sqlpyhelper.db_helper.SQLPyHelperError

Bases: Exception

Base exception for SQLPyHelper errors.

class sqlpyhelper.db_helper.ConnectionError

Bases: SQLPyHelperError

Raised when a database connection fails.

class sqlpyhelper.db_helper.QueryError

Bases: SQLPyHelperError

Raised when a query fails to execute.

class sqlpyhelper.db_helper.BackupError

Bases: SQLPyHelperError

Raised when a backup operation fails.