duckdb::ActiveTimer Struct Reference

Collaboration diagram for duckdb::ActiveTimer:

Public Member Functions
	ActiveTimer (QueryMetrics &query_metrics, const MetricType metric, const bool is_active=true)
	ActiveTimer (const ActiveTimer &other)=delete
ActiveTimer &	operator= (const ActiveTimer &)=delete
	ActiveTimer (ActiveTimer &&other) noexcept
	enable move constructors
ActiveTimer &	operator= (ActiveTimer &&other) noexcept
void	EndTimer ()
void	Reset ()

Private Attributes
optional_ptr< QueryMetrics >	query_metrics
MetricType	metric
Profiler	profiler
bool	is_active

Constructor & Destructor Documentation

ActiveTimer() [1/3]

duckdb::ActiveTimer::ActiveTimer ( )

inline

                  : metric(MetricType::EXTRA_INFO), is_active(false) {
    }

ActiveTimer() [2/3]

duckdb::ActiveTimer::ActiveTimer ( QueryMetrics &  query_metrics, const MetricType  metric, const bool  is_active = true  )

inline

                                                                                                   : query_metrics(query_metrics), metric(metric), is_active(is_active) {
        // start on constructor
        if (!is_active) {
            return;
        }
        profiler.Start();
    }

~ActiveTimer()

duckdb::ActiveTimer::~ActiveTimer ( )

inline

                   {
        if (is_active) {
            // automatically end in destructor
            EndTimer();
        }
    }

ActiveTimer() [3/3]

duckdb::ActiveTimer::ActiveTimer ( ActiveTimer &&  other )

inlinenoexcept

enable move constructors

                                              : is_active(false) {
        std::swap(query_metrics, other.query_metrics);
        std::swap(metric, other.metric);
        std::swap(profiler, other.profiler);
        std::swap(is_active, other.is_active);
    }

Member Function Documentation

operator=()

ActiveTimer & duckdb::ActiveTimer::operator= ( ActiveTimer &&  other )

inlinenoexcept

                                                         {
        std::swap(query_metrics, other.query_metrics);
        std::swap(metric, other.metric);
        std::swap(profiler, other.profiler);
        std::swap(is_active, other.is_active);
        return *this;
    }

EndTimer()

void duckdb::ActiveTimer::EndTimer ( )

inline

                    {
        if (!is_active) {
            return;
        }
        // stop profiling and report
        is_active = false;
        profiler.End();
        query_metrics->UpdateMetric(metric, profiler.ElapsedNanos());
    }

Reset()

void duckdb::ActiveTimer::Reset ( )

inline

                 {
        if (!is_active) {
            return;
        }
        profiler.Reset();
        is_active = false;
    }

---

The documentation for this struct was generated from the following file:

• external/duckdb/duckdb.hpp