delete_metric_definition
Important
Some or all of this functionality is available as part of a preview release. The content and the functionality are subject to change.
delete_metric_definition(metric_id: int)
Parameters:
- metric_id (int): ID of the metric to be deleted.
Description:
Deletes a metric definition by its metric ID. Note, this function only deletes the definition of the metric. Post deleting the definition, user should delete the metrics output from the ComputedESGMetrics table to maintain data integrity and avoid orphan metric outputs. Before deleting the metric, note the metric ID and use the same to find the metric in the ComputedESGMetrics table and delete the output.
Raises:
ValueError: If the metric ID isn't found.
Example usage:
metrics_manager = MetricsManager()
metrics_manager.delete_metric_definition(metric_id=1)
