duckdb::ProfilingInfo Class Reference

Collaboration diagram for duckdb::ProfilingInfo:

Public Member Functions
	ProfilingInfo (const profiler_settings_t &n_settings, const idx_t depth=0)
	ProfilingInfo (ProfilingInfo &)=default
ProfilingInfo &	operator= (ProfilingInfo const &)=default
void	ResetMetrics ()
string	GetMetricAsString (const MetricType metric) const
void	WriteMetricsToLog (ClientContext &context)
void	WriteMetricsToJSON (duckdb_yyjson::yyjson_mut_doc *doc, duckdb_yyjson::yyjson_mut_val *destination)
template<class METRIC_TYPE >
METRIC_TYPE	GetMetricValue (const MetricType type) const
template<class METRIC_TYPE >
void	MetricUpdate (const MetricType type, const Value &value, const std::function< METRIC_TYPE(const METRIC_TYPE &, const METRIC_TYPE &)> &update_fun)
template<class METRIC_TYPE >
void	MetricUpdate (const MetricType type, const METRIC_TYPE &value, const std::function< METRIC_TYPE(const METRIC_TYPE &, const METRIC_TYPE &)> &update_fun)
template<class METRIC_TYPE >
void	MetricSum (const MetricType type, const Value &value)
template<class METRIC_TYPE >
void	MetricSum (const MetricType type, const METRIC_TYPE &value)
template<class METRIC_TYPE >
void	MetricMax (const MetricType type, const Value &value)
template<class METRIC_TYPE >
void	MetricMax (const MetricType type, const METRIC_TYPE &value)
template<>
InsertionOrderPreservingMap< string >	GetMetricValue (const MetricType type) const

Static Public Member Functions
static bool	Enabled (const profiler_settings_t &settings, const MetricType metric)
	Returns true, if the query profiler must collect this metric.
static void	Expand (profiler_settings_t &settings, const MetricType metric)
	Expand metrics depending on the collection of other metrics.

Public Attributes
profiler_settings_t	settings
	Enabling a metric adds it to this set.
profiler_settings_t	expanded_settings
	This set contains the expanded to-be-collected metrics, which can differ from 'settings'.
profiler_metrics_t	metrics
	Contains all enabled metrics.

Member Function Documentation

GetMetricValue() [1/2]

template<class METRIC_TYPE >

METRIC_TYPE duckdb::ProfilingInfo::GetMetricValue ( const MetricType  type ) const

inline

                                                            {
        auto val = metrics.at(type);
        return val.GetValue<METRIC_TYPE>();
    }

MetricUpdate() [1/2]

template<class METRIC_TYPE >

void duckdb::ProfilingInfo::MetricUpdate ( const MetricType  type, const Value &  value, const std::function< METRIC_TYPE(const METRIC_TYPE &, const METRIC_TYPE &)> &  update_fun  )

inline

                                                                                                            {
        if (metrics.find(type) == metrics.end()) {
            metrics[type] = value;
            return;
        }
        auto new_value = update_fun(metrics[type].GetValue<METRIC_TYPE>(), value.GetValue<METRIC_TYPE>());
        metrics[type] = Value::CreateValue(new_value);
    }

MetricUpdate() [2/2]

template<class METRIC_TYPE >

void duckdb::ProfilingInfo::MetricUpdate ( const MetricType  type, const METRIC_TYPE &  value, const std::function< METRIC_TYPE(const METRIC_TYPE &, const METRIC_TYPE &)> &  update_fun  )

inline

                                                                                                            {
        auto new_value = Value::CreateValue(value);
        MetricUpdate<METRIC_TYPE>(type, new_value, update_fun);
    }

MetricSum() [1/2]

template<class METRIC_TYPE >

void duckdb::ProfilingInfo::MetricSum ( const MetricType  type, const Value &  value  )

inline

                                                              {
        MetricUpdate<METRIC_TYPE>(type, value, [](const METRIC_TYPE &old_value, const METRIC_TYPE &new_value) {
            return old_value + new_value;
        });
    }

MetricSum() [2/2]

template<class METRIC_TYPE >

void duckdb::ProfilingInfo::MetricSum ( const MetricType  type, const METRIC_TYPE &  value  )

inline

                                                                    {
        auto new_value = Value::CreateValue(value);
        return MetricSum<METRIC_TYPE>(type, new_value);
    }

MetricMax() [1/2]

template<class METRIC_TYPE >

void duckdb::ProfilingInfo::MetricMax ( const MetricType  type, const Value &  value  )

inline

                                                              {
        MetricUpdate<METRIC_TYPE>(type, value, [](const METRIC_TYPE &old_value, const METRIC_TYPE &new_value) {
            return MaxValue(old_value, new_value);
        });
    }

MetricMax() [2/2]

template<class METRIC_TYPE >

void duckdb::ProfilingInfo::MetricMax ( const MetricType  type, const METRIC_TYPE &  value  )

inline

                                                                    {
        auto new_value = Value::CreateValue(value);
        return MetricMax<METRIC_TYPE>(type, new_value);
    }

GetMetricValue() [2/2]

template<>

InsertionOrderPreservingMap< string > duckdb::ProfilingInfo::GetMetricValue ( const MetricType  type ) const

inline

                                                                                              {
    auto val = metrics.at(type);
    InsertionOrderPreservingMap<string> result;
    auto children = MapValue::GetChildren(val);
    for (auto &child : children) {
        auto struct_children = StructValue::GetChildren(child);
        auto key = struct_children[0].GetValue<string>();
        auto value = struct_children[1].GetValue<string>();
        result.insert(key, value);
    }
    return result;
}

---

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

• external/duckdb/duckdb.hpp