mirar.database.transactions package

Central module for all DB transaction types.

Submodules

mirar.database.transactions.insert module

Module to export data to a database table

mirar.database.transactions.select module

Module to select database entries

mirar.database.transactions.select.check_table_exists(sql_table: BaseTable) bool[source]

Check if a table exists

Parameters:

sql_table – database SQL table

Returns:

True if table exists, False otherwise

mirar.database.transactions.select.is_populated(sql_table: BaseTable) bool[source]

Function to check if a table is populated

Parameters:

sql_table – database SQL table

Returns:

boolean

mirar.database.transactions.select.run_select(query: Select, sql_table: BaseTable, columns: list[str] | None = None) DataFrame[source]

Run a select query

Parameters:
  • query – select query to run

  • sql_table – table to run query on

  • columns – columns to output (default: all)

Returns:

results

mirar.database.transactions.select.select_from_table(db_constraints: DBQueryConstraints, sql_table: BaseTable, output_columns: list[str] | None = None, max_num_results: int | None = None) DataFrame[source]

Select database entries

Parameters:
  • db_constraints – database query constraints

  • sql_table – database SQL table

  • output_columns – columns to output (default: all)

  • max_num_results – maximum number of results to return (default: all)

Returns:

results

mirar.database.transactions.update module

Module to update database entries