Treasury Analytics Core
  • Home
  • API Reference
  • Examples
  • Credentials
  • Global Settings
  1. API Reference
  2. Utilities
  3. query_timer
  • Overview
    • Treasury Analytics Core
  • Credential Management
    • Secure Credential Management
    • Global Settings
  • Examples
    • Example Projects
  • API Reference
    • Function reference
    • Core Components
      • FinanceDataEngine
      • engine_factory
      • engine
      • database
      • cache
      • processor
      • analyzer
    • Configuration
      • settings
      • settings_factory
      • global_settings_manager
    • Utilities
      • credentials
      • dataframe_utils
      • setup_logging
      • env_checker
      • query_timer
      • setup_helper
      • logging
      • constants
      • types
    • Scripts
      • configure_db
      • create_project
      • manage_settings

On this page

  • query_timer
    • Classes
      • QueryTimer

Other Formats

  • Github (GFM)
  1. API Reference
  2. Utilities
  3. query_timer

query_timer

utils.query_timer

Query timing utility.

Classes

Name Description
QueryTimer Utility for tracking and reporting query execution times.

QueryTimer

utils.query_timer.QueryTimer(self, console=None)

Utility for tracking and reporting query execution times.

Methods

Name Description
add_query Add a query execution record.
end_query End timing a query and record stats.
get_statistics Get query execution statistics.
get_total_duration Get the total duration of all queries.
print_summary Print query execution summary table.
start_query Start timing a query.
add_query
utils.query_timer.QueryTimer.add_query(name, duration, rows)

Add a query execution record.

Parameters
Name Type Description Default
name str Query name required
duration float Execution time in seconds required
rows int Number of rows returned required
end_query
utils.query_timer.QueryTimer.end_query(row_count)

End timing a query and record stats.

Parameters
Name Type Description Default
row_count int Number of rows returned by the query required
get_statistics
utils.query_timer.QueryTimer.get_statistics()

Get query execution statistics.

Returns
Name Type Description
Dict Dictionary with query statistics
get_total_duration
utils.query_timer.QueryTimer.get_total_duration()

Get the total duration of all queries.

Returns
Name Type Description
float Total execution time in seconds for all queries. Returns 0.0 if no queries have been recorded.
print_summary
utils.query_timer.QueryTimer.print_summary()

Print query execution summary table.

start_query
utils.query_timer.QueryTimer.start_query(query_name)

Start timing a query.

Parameters
Name Type Description Default
query_name str Name of the query being executed required
env_checker
setup_helper
 
 
  • Built with [Quarto](https://quarto.org/) and [quartodoc](https://machow.github.io/quartodoc/)