MetricViewPlanner¶

planRead¶

planRead(
  metadata: CatalogTable,
  yaml: String,
  sqlParser: ParserInterface,
  expectedSchema: StructType): MetricViewPlaceholder

planRead creates a MetricView (from the given yaml text).

In the end, planRead returns a MetricViewPlaceholder.

planRead is used when:

• SessionCatalog is requested to parse a metric view definition

planWrite¶

planWrite(
  metadata: CatalogTable,
  yaml: String,
  sqlParser: ParserInterface): (MetricViewPlaceholder, MetricView)

planWrite creates a MetricView (from the given yaml text).

In the end, planWrite returns a MetricViewPlaceholder with isCreate flag enabled (to differentiate planWrite from planRead) and the MetricView.

planWrite is used when:

• MetricViewHelper is requested to analyzeMetricViewText

Create MetricView from YAML Definition File¶

parseYAML(
  yaml: String,
  sqlParser: ParserInterface): (MetricView, LogicalPlan)

parseYAML creates a MetricView from YAML definition.

parseYAML is used when:

• MetricViewPlanner is requested to planRead and planWrite