Skip to main content
export_query_metrics(options=)[source]

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

Parameters

options (dict of str to str) –

Optional parameters. Allowed keys are:

  • expression – Filter for multi query export.

  • filepath – Path to export target specified as a filename or existing directory.

  • format – Specifies which format to export the metrics. Allowed values are:

    • json – Generic JSON output.

    • json_trace_event – Chromium/Perfetto trace event format.

    The default value is ‘json’.

  • job_id – Export query metrics for the currently running job.

  • limit – Record limit per file for multi query export.

The default value is an empty dict ( ).

Returns

A dict with the following entries–

info (dict of str to str) –

Additional information. Allowed keys are:

  • exported_files – Comma separated list of filenames exported if applicable.

  • output – Exported metrics if no other destination specified.

The default value is an empty dict ( ).