rick_db.profiler¶

Classes related to the SQL Profiler implementation.

Class rick_db.profiler.Event¶

Dataclass for a single event entry. Available properties:

@dataclass
class Event:
    timestamp: float
    query: str
    parameters: dict
    elapsed: float

Class rick_db.profiler.EventCollection¶

A list-based class to hold a collection of Event objects.

EventCollection.filter_duration(duration: float)¶

Retrieve a list of Event objects whose duration is bigger than or equal to duration.

Class rick_db.profiler.ProfilerInterface¶

Base profiler interface. Defines the interface for all Profiler implementations.

ProfilerInterface.add_event(query: str, parameters: dict, duration: float)¶

Create a new profiling event based on the passed query, parameters and duration, and add it to the internal event collection.

ProfilerInterface.clear()¶

Purge (clear) all stored events.

ProfilerInterface.get_events()¶

Return internal profiling event collection.

Class rick_db.profiler.NullProfiler¶

A ProfilerInterface-based class with dummy behaviour, to be used when no profiler is desired. All methods are no-ops. get_events() returns a fresh empty EventCollection on each call.

Class rick_db.profiler.DefaultProfiler¶

A ProfilerInterface-based class. Events are kept in-memory.

Thread-safe: all methods are protected by a lock, making it safe to share a single DefaultProfiler instance across multiple connections (e.g. via a connection pool). get_events() returns a snapshot copy of the internal collection, so iterating over events is not affected by concurrent add_event() calls.