gpudb::ExportQueryMetricsRequest Struct Reference

A set of parameters for GPUdb::exportQueryMetrics. More...

#include <gpudb/protocol/export_query_metrics.h>

Public Member Functions
	ExportQueryMetricsRequest ()
	Constructs an ExportQueryMetricsRequest object with default parameters. More...
	ExportQueryMetricsRequest (const std::map< std::string, std::string > &options_)
	Constructs an ExportQueryMetricsRequest object with the specified parameters. More...

Public Attributes
std::map< std::string, std::string >	options
	Optional parameters. More...

Detailed Description

A set of parameters for GPUdb::exportQueryMetrics.

Export query metrics to a given destination. Returns query metrics.

Definition at line 19 of file export_query_metrics.h.

Constructor & Destructor Documentation

ExportQueryMetricsRequest() [1/2]

gpudb::ExportQueryMetricsRequest::ExportQueryMetricsRequest ( )

inline

Constructs an ExportQueryMetricsRequest object with default parameters.

Definition at line 25 of file export_query_metrics.h.

ExportQueryMetricsRequest() [2/2]

gpudb::ExportQueryMetricsRequest::ExportQueryMetricsRequest ( const std::map< std::string, std::string > &  options_ )

inline

Constructs an ExportQueryMetricsRequest object with the specified parameters.

Parameters

[in]

options_

Optional parameters. export_query_metrics_expression: Filter for multi query export export_query_metrics_filepath: Path to export target specified as a filename or existing directory. export_query_metrics_format: Specifies which format to export the metrics. Supported values: export_query_metrics_json: Generic json output export_query_metrics_json_trace_event: Chromium/Perfetto trace event format The default value is export_query_metrics_json. export_query_metrics_job_id: Export query metrics for the currently running job export_query_metrics_limit: Record limit per file for multi query export The default value is an empty map.

Definition at line 74 of file export_query_metrics.h.

Member Data Documentation

options

std::map<std::string, std::string> gpudb::ExportQueryMetricsRequest::options

Optional parameters.

• export_query_metrics_expression: Filter for multi query export
• export_query_metrics_filepath: Path to export target specified as a filename or existing directory.
• export_query_metrics_format: Specifies which format to export the metrics. Supported values:
  • export_query_metrics_json: Generic json output
  • export_query_metrics_json_trace_event: Chromium/Perfetto trace event format
  The default value is export_query_metrics_json.
• export_query_metrics_job_id: Export query metrics for the currently running job
• export_query_metrics_limit: Record limit per file for multi query export

The default value is an empty map.

Definition at line 110 of file export_query_metrics.h.

---

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

• gpudb/protocol/export_query_metrics.h