[MINOR] Add title preamble in physical operators

jaceklaskowski · jaceklaskowski · commit 64049087ed28 · 2024-05-05T16:47:51.000+02:00
diff --git a/docs/physical-operators/AQEShuffleReadExec.md b/docs/physical-operators/AQEShuffleReadExec.md
@@ -1,3 +1,7 @@
+---
+title: AQEShuffleReadExec
+---
+
 # AQEShuffleReadExec Physical Operator
 
 `AQEShuffleReadExec` is a [unary physical operator](UnaryExecNode.md) in [Adaptive Query Execution](../adaptive-query-execution/index.md).
diff --git a/docs/physical-operators/AdaptiveSparkPlanExec.md b/docs/physical-operators/AdaptiveSparkPlanExec.md
@@ -1,3 +1,7 @@
+---
+title: AdaptiveSparkPlanExec
+---
+
 # AdaptiveSparkPlanExec Leaf Physical Operator
 
 `AdaptiveSparkPlanExec` is a [leaf physical operator](SparkPlan.md#LeafExecNode) for [Adaptive Query Execution](../adaptive-query-execution/index.md).
diff --git a/docs/physical-operators/AggregateCodegenSupport.md b/docs/physical-operators/AggregateCodegenSupport.md
@@ -1,3 +1,7 @@
+---
+title: AggregateCodegenSupport
+---
+
 # AggregateCodegenSupport Physical Operators
 
 `AggregateCodegenSupport` is an [extension](#contract) of the [BaseAggregateExec](BaseAggregateExec.md) abstraction for [aggregate physical operators](#implementations) that support [Whole-Stage Java Code Generation](../whole-stage-code-generation/index.md) (with [produce](#doProduce) and [consume](#doConsume) code execution paths).
diff --git a/docs/physical-operators/AliasAwareOutputExpression.md b/docs/physical-operators/AliasAwareOutputExpression.md
@@ -1,3 +1,7 @@
+---
+title: AliasAwareOutputExpression
+---
+
 # AliasAwareOutputExpression Physical Operators
 
 `AliasAwareOutputExpression` is an [abstraction](#contract) of [physical operators](#implementations) with the [output named expressions](#outputExpressions).
diff --git a/docs/physical-operators/AliasAwareQueryOutputOrdering.md b/docs/physical-operators/AliasAwareQueryOutputOrdering.md
@@ -1,3 +1,7 @@
+---
+title: AliasAwareQueryOutputOrdering
+---
+
 # AliasAwareQueryOutputOrdering Unary Physical Operators
 
 `AliasAwareQueryOutputOrdering` is an [extension](#contract) of the [AliasAwareOutputExpression](AliasAwareOutputExpression.md) abstraction for [unary physical operators](#implementations) with [alias-aware ordering expressions](#orderingExpressions).
diff --git a/docs/physical-operators/AtomicTableWriteExec.md b/docs/physical-operators/AtomicTableWriteExec.md
@@ -1,3 +1,7 @@
+---
+title: AtomicTableWriteExec
+---
+
 # AtomicTableWriteExec Physical Commands
 
 `AtomicTableWriteExec` is an extension of the [V2TableWriteExec](V2TableWriteExec.md) abstraction for [physical commands](#implementations) that [writeToStagedTable](#writeToStagedTable) and support V1 write path (`SupportsV1Write`).
diff --git a/docs/physical-operators/BaseAggregateExec.md b/docs/physical-operators/BaseAggregateExec.md
@@ -1,3 +1,7 @@
+---
+title: BaseAggregateExec
+---
+
 # BaseAggregateExec Unary Physical Operators
 
 `BaseAggregateExec` is an [extension](#contract) of the [UnaryExecNode](UnaryExecNode.md) abstraction for [aggregate unary physical operators](#implementations).
diff --git a/docs/physical-operators/BaseJoinExec.md b/docs/physical-operators/BaseJoinExec.md
@@ -1,3 +1,7 @@
+---
+title: BaseJoinExec
+---
+
 # BaseJoinExec Physical Operators
 
 `BaseJoinExec` is an [extension](#contract) of the `BinaryExecNode` abstraction for [join physical operators](#implementations).
diff --git a/docs/physical-operators/BaseSubqueryExec.md b/docs/physical-operators/BaseSubqueryExec.md
@@ -1,3 +1,7 @@
+---
+title: BaseSubqueryExec
+---
+
 # BaseSubqueryExec Physical Operators
 
 `BaseSubqueryExec` is an [extension](#contract) of the [SparkPlan](SparkPlan.md) abstraction for [physical operators](#implementations) with a [child subquery plan](#child).
diff --git a/docs/physical-operators/BatchWriteHelper.md b/docs/physical-operators/BatchWriteHelper.md
@@ -1,3 +1,7 @@
+---
+title: BatchWriteHelper
+---
+
 # BatchWriteHelper Physical Operators
 
 `BatchWriteHelper` is an [abstraction](#contract) of [physical operators](#implementations) that [build batch writes](#newWriteBuilder).
diff --git a/docs/physical-operators/BroadcastExchangeExec.md b/docs/physical-operators/BroadcastExchangeExec.md
@@ -1,3 +1,7 @@
+---
+title: BroadcastExchangeExec
+---
+
 # BroadcastExchangeExec Unary Physical Operator for Broadcast Joins
 
 `BroadcastExchangeExec` is an [BroadcastExchangeLike](BroadcastExchangeLike.md) unary physical operator to collect and broadcast rows of a child relation (to worker nodes).
diff --git a/docs/physical-operators/BroadcastExchangeLike.md b/docs/physical-operators/BroadcastExchangeLike.md
@@ -1,3 +1,7 @@
+---
+title: BroadcastExchangeLike
+---
+
 # BroadcastExchangeLike Physical Operators
 
 `BroadcastExchangeLike` is an [extension](#contract) of the [Exchange](Exchange.md) abstraction for [physical operators](#implementations) that...FIXME
diff --git a/docs/physical-operators/BroadcastHashJoinExec.md b/docs/physical-operators/BroadcastHashJoinExec.md
@@ -1,3 +1,7 @@
+---
+title: BroadcastHashJoinExec
+---
+
 # BroadcastHashJoinExec Physical Operator
 
 `BroadcastHashJoinExec` is a [hash-based join physical operator](HashJoin.md) for [broadcast hash join](#doExecute).
diff --git a/docs/physical-operators/BroadcastNestedLoopJoinExec.md b/docs/physical-operators/BroadcastNestedLoopJoinExec.md
@@ -1,3 +1,7 @@
+---
+title: BroadcastNestedLoopJoinExec
+---
+
 # BroadcastNestedLoopJoinExec Binary Physical Operator
 
 `BroadcastNestedLoopJoinExec` is a binary physical operator that is <<creating-instance, created>> (and converted to) when [JoinSelection](../execution-planning-strategies/JoinSelection.md) physical plan strategy finds a Join.md[Join] logical operator that meets either case:
diff --git a/docs/physical-operators/BroadcastQueryStageExec.md b/docs/physical-operators/BroadcastQueryStageExec.md
@@ -1,3 +1,7 @@
+---
+title: BroadcastQueryStageExec
+---
+
 # BroadcastQueryStageExec Physical Operator
 
 `BroadcastQueryStageExec` is a [QueryStageExec](QueryStageExec.md).
diff --git a/docs/physical-operators/CollectLimitExec.md b/docs/physical-operators/CollectLimitExec.md
@@ -1,3 +1,7 @@
+---
+title: CollectLimitExec
+---
+
 # CollectLimitExec Physical Operator
 
 `CollectLimitExec` is a unary physical operator that represents [GlobalLimit](../logical-operators/GlobalLimit.md) unary logical operator at execution time.
diff --git a/docs/physical-operators/CollectMetricsExec.md b/docs/physical-operators/CollectMetricsExec.md
@@ -1,3 +1,7 @@
+---
+title: CollectMetricsExec
+---
+
 # CollectMetricsExec Physical Operator
 
 `CollectMetricsExec` is a [unary physical operator](UnaryExecNode.md).
diff --git a/docs/physical-operators/ColumnarToRowExec.md b/docs/physical-operators/ColumnarToRowExec.md
@@ -1,3 +1,7 @@
+---
+title: ColumnarToRowExec
+---
+
 # ColumnarToRowExec Physical Operator
 
 `ColumnarToRowExec` is a [ColumnarToRowTransition](ColumnarToRowTransition.md) unary physical operator to [translate an RDD of ColumnarBatches into an RDD of InternalRows](#doExecute) in [Columnar Processing](../columnar-execution/index.md).
diff --git a/docs/physical-operators/ColumnarToRowTransition.md b/docs/physical-operators/ColumnarToRowTransition.md
@@ -1,3 +1,7 @@
+---
+title: ColumnarToRowTransition
+---
+
 # ColumnarToRowTransition Unary Physical Operators
 
 `ColumnarToRowTransition` is a marker extension of the [UnaryExecNode](UnaryExecNode.md) abstraction for [unary physical operators](#implementations) that can transition from columns to rows (when [executed](SparkPlan.md#doExecute)).
diff --git a/docs/physical-operators/CreateTableAsSelectExec.md b/docs/physical-operators/CreateTableAsSelectExec.md
@@ -1,3 +1,7 @@
+---
+title: CreateTableAsSelectExec
+---
+
 # CreateTableAsSelectExec Physical Command
 
 `CreateTableAsSelectExec` is a [TableWriteExecHelper](TableWriteExecHelper.md) that represents [CreateTableAsSelect](../logical-operators/CreateTableAsSelect.md) logical operator at execution time.
diff --git a/docs/physical-operators/DataSourceScanExec.md b/docs/physical-operators/DataSourceScanExec.md
@@ -1,3 +1,7 @@
+---
+title: DataSourceScanExec
+---
+
 # DataSourceScanExec Leaf Physical Operators
 
 `DataSourceScanExec` is an [extension](#contract) of the `LeafExecNode` abstraction for [leaf physical operators](#implementations) that represent scans over a [BaseRelation](#relation).
diff --git a/docs/physical-operators/DataWritingCommandExec.md b/docs/physical-operators/DataWritingCommandExec.md
@@ -1,3 +1,7 @@
+---
+title: DataWritingCommandExec
+---
+
 # DataWritingCommandExec Physical Operator
 
 `DataWritingCommandExec` is a [UnaryExecNode](UnaryExecNode.md) that is the execution environment for a [DataWritingCommand](#cmd) logical command at [execution time](#doExecute).
diff --git a/docs/physical-operators/DebugExec.md b/docs/physical-operators/DebugExec.md
@@ -1,3 +1,7 @@
+---
+title: DebugExec
+---
+
 # DebugExec Unary Physical Operator
 
 `DebugExec` is a [unary physical operator](UnaryExecNode.md).
diff --git a/docs/physical-operators/DescribeTableExec.md b/docs/physical-operators/DescribeTableExec.md
@@ -1,3 +1,7 @@
+---
+title: DescribeTableExec
+---
+
 # DescribeTableExec Physical Command
 
 `DescribeTableExec` is a [physical command](V2CommandExec.md) that represents [DescribeRelation](../logical-operators/DescribeRelation.md) logical command at execution time.
diff --git a/docs/physical-operators/EvalPythonExec.md b/docs/physical-operators/EvalPythonExec.md
@@ -1,3 +1,7 @@
+---
+title: EvalPythonExec
+---
+
 # EvalPythonExec Physical Operators
 
 `EvalPythonExec` is an [extension](#contract) of the [UnaryExecNode](UnaryExecNode.md) abstraction for [unary physical operators](#implementations) that can [evaluate PythonUDFs](#evaluate).
diff --git a/docs/physical-operators/Exchange.md b/docs/physical-operators/Exchange.md
@@ -1,3 +1,7 @@
+---
+title: Exchange
+---
+
 # Exchange Unary Physical Operators
 
 `Exchange` is an [extension](#contract) of the [UnaryExecNode](UnaryExecNode.md) abstraction for [unary physical operators](#implementations) to exchange data (among tasks).
diff --git a/docs/physical-operators/ExecutedCommandExec.md b/docs/physical-operators/ExecutedCommandExec.md
@@ -1,3 +1,7 @@
+---
+title: ExecutedCommandExec
+---
+
 # ExecutedCommandExec Physical Operator
 
 `ExecutedCommandExec` is a leaf physical operator for executing [runnable logical commands](../logical-operators/RunnableCommand.md).
diff --git a/docs/physical-operators/ExternalRDDScanExec.md b/docs/physical-operators/ExternalRDDScanExec.md
@@ -1,3 +1,7 @@
+---
+title: ExternalRDDScanExec
+---
+
 # ExternalRDDScanExec Leaf Physical Operator
 
 `ExternalRDDScanExec` is a leaf physical operator.
diff --git a/docs/physical-operators/FileSourceScanExec.md b/docs/physical-operators/FileSourceScanExec.md
@@ -1,3 +1,7 @@
+---
+title: FileSourceScanExec
+---
+
 # FileSourceScanExec Physical Operator
 
 `FileSourceScanExec` is a [DataSourceScanExec](DataSourceScanExec.md) that represents a scan over a [HadoopFsRelation](#relation).
diff --git a/docs/physical-operators/HashJoin.md b/docs/physical-operators/HashJoin.md
@@ -1,3 +1,7 @@
+---
+title: HashJoin
+---
+
 # HashJoin &mdash; Hash-Based Join Physical Operators
 
 `HashJoin` is an [extension](#contract) of the [JoinCodegenSupport](JoinCodegenSupport.md) abstraction for [hash-based join physical operators](#implementations) with support for [Java code generation](#CodegenSupport).
diff --git a/docs/physical-operators/InMemoryTableScanExec.md b/docs/physical-operators/InMemoryTableScanExec.md
@@ -1,3 +1,7 @@
+---
+title: InMemoryTableScanExec
+---
+
 # InMemoryTableScanExec Leaf Physical Operator
 
 `InMemoryTableScanExec` is a [leaf physical operator](SparkPlan.md#LeafExecNode) that represents an [InMemoryRelation](#relation) logical operator at execution time.
diff --git a/docs/physical-operators/InputAdapter.md b/docs/physical-operators/InputAdapter.md
@@ -1,3 +1,7 @@
+---
+title: InputAdapter
+---
+
 # InputAdapter Unary Physical Operator
 
 `InputAdapter` is a [unary physical operator](UnaryExecNode.md) that is an adapter for the [child](../catalyst/TreeNode.md#children) physical operator that does not meet the requirements of [whole-stage Java code generation](CodegenSupport.md) (possibly due to [supportCodegen](CodegenSupport.md#supportCodegen) flag turned off) but is between operators that participate in whole-stage Java code generation optimization.
diff --git a/docs/physical-operators/LocalTableScanExec.md b/docs/physical-operators/LocalTableScanExec.md
@@ -1,3 +1,7 @@
+---
+title: LocalTableScanExec
+---
+
 # LocalTableScanExec Leaf Physical Operator
 
 `LocalTableScanExec` is a [leaf physical operator](SparkPlan.md#LeafExecNode) that represents the following at execution:
diff --git a/docs/physical-operators/ObjectConsumerExec.md b/docs/physical-operators/ObjectConsumerExec.md
@@ -1,4 +1,8 @@
-# ObjectConsumerExec -- Unary Physical Operators with Child Physical Operator with One-Attribute Output Schema
+---
+title: ObjectConsumerExec
+---
+
+# ObjectConsumerExec &mdash; Unary Physical Operators with Child Physical Operator with One-Attribute Output Schema
 
 `ObjectConsumerExec` is the <<contract, contract>> of <<implementations, unary physical operators>> with the child physical operator using a one-attribute <<catalyst/QueryPlan.md#output, output schema>>.
 
diff --git a/docs/physical-operators/ObjectHashAggregateExec.md b/docs/physical-operators/ObjectHashAggregateExec.md
@@ -1,3 +1,7 @@
+---
+title: ObjectHashAggregateExec
+---
+
 # ObjectHashAggregateExec Physical Operator
 
 `ObjectHashAggregateExec` is an [aggregate unary physical operator](BaseAggregateExec.md) for **object aggregation**.
diff --git a/docs/physical-operators/OverwriteByExpressionExec.md b/docs/physical-operators/OverwriteByExpressionExec.md
@@ -1,3 +1,7 @@
+---
+title: OverwriteByExpressionExec
+---
+
 # OverwriteByExpressionExec Physical Command
 
 `OverwriteByExpressionExec` is a [V2TableWriteExec](V2TableWriteExec.md) with [BatchWriteHelper](BatchWriteHelper.md).
diff --git a/docs/physical-operators/PartitioningPreservingUnaryExecNode.md b/docs/physical-operators/PartitioningPreservingUnaryExecNode.md
@@ -1,3 +1,7 @@
+---
+title: PartitioningPreservingUnaryExecNode
+---
+
 # PartitioningPreservingUnaryExecNode Unary Physical Operators
 
 `PartitioningPreservingUnaryExecNode` is an extension of the [UnaryExecNode](UnaryExecNode.md) abstraction for [unary physical operators](#implementations) with well-determined [output partitioning](#outputPartitioning).
diff --git a/docs/physical-operators/ProjectExec.md b/docs/physical-operators/ProjectExec.md
@@ -1,3 +1,7 @@
+---
+title: ProjectExec
+---
+
 # ProjectExec Unary Physical Operator
 
 `ProjectExec` is a [unary physical operator](UnaryExecNode.md) with support for [Java code generation](CodegenSupport.md) that represents [Project](../logical-operators/Project.md) logical operator at execution.
diff --git a/docs/physical-operators/QueryStageExec.md b/docs/physical-operators/QueryStageExec.md
@@ -1,3 +1,7 @@
+---
+title: QueryStageExec
+---
+
 # QueryStageExec Leaf Physical Operators
 
 `QueryStageExec` is an [extension](#contract) of the [LeafExecNode](SparkPlan.md#LeafExecNode) abstraction for [leaf physical operators](#implementations) for [Adaptive Query Execution](../adaptive-query-execution/index.md).
diff --git a/docs/physical-operators/RangeExec.md b/docs/physical-operators/RangeExec.md
@@ -1,3 +1,7 @@
+---
+title: RangeExec
+---
+
 # RangeExec Leaf Physical Operator
 
 `RangeExec` is a [leaf physical operator](SparkPlan.md#LeafExecNode).
diff --git a/docs/physical-operators/ReusedExchangeExec.md b/docs/physical-operators/ReusedExchangeExec.md
@@ -1,3 +1,7 @@
+---
+title: ReusedExchangeExec
+---
+
 # ReusedExchangeExec Leaf Physical Operator
 
 `ReusedExchangeExec` is a leaf physical operator.
diff --git a/docs/physical-operators/ReusedSubqueryExec.md b/docs/physical-operators/ReusedSubqueryExec.md
@@ -1,3 +1,7 @@
+---
+title: ReusedSubqueryExec
+---
+
 # ReusedSubqueryExec Physical Operator
 
 `ReusedSubqueryExec` is a [BaseSubqueryExec](BaseSubqueryExec.md) and a `LeafExecNode` with a [child BaseSubqueryExec](#child) physical operator.
diff --git a/docs/physical-operators/RowDataSourceScanExec.md b/docs/physical-operators/RowDataSourceScanExec.md
@@ -1,3 +1,7 @@
+---
+title: RowDataSourceScanExec
+---
+
 # RowDataSourceScanExec Leaf Physical Operator
 
 `RowDataSourceScanExec` is a [DataSourceScanExec](DataSourceScanExec.md) (and so indirectly a leaf physical operator) for scanning data from a [BaseRelation](#relation).
diff --git a/docs/physical-operators/RowToColumnarExec.md b/docs/physical-operators/RowToColumnarExec.md
@@ -1,3 +1,7 @@
+---
+title: RowToColumnarExec
+---
+
 # RowToColumnarExec Physical Operator
 
 `RowToColumnarExec` is a `RowToColumnarTransition` for [Columnar Execution](../columnar-execution/index.md).
diff --git a/docs/physical-operators/SerializeFromObjectExec.md b/docs/physical-operators/SerializeFromObjectExec.md
@@ -1,3 +1,7 @@
+---
+title: SerializeFromObjectExec
+---
+
 # SerializeFromObjectExec Unary Physical Operator
 
 `SerializeFromObjectExec` is a [unary physical operator](UnaryExecNode.md) that supports [Java code generation](CodegenSupport.md).
diff --git a/docs/physical-operators/SetCatalogAndNamespaceExec.md b/docs/physical-operators/SetCatalogAndNamespaceExec.md
@@ -1,3 +1,7 @@
+---
+title: SetCatalogAndNamespaceExec
+---
+
 # SetCatalogAndNamespaceExec Physical Command
 
 `SetCatalogAndNamespaceExec` is a [physical command](V2CommandExec.md) that represents [SetCatalogAndNamespace](../logical-operators/SetCatalogAndNamespace.md) logical command at execution time.
diff --git a/docs/physical-operators/ShowCreateTableExec.md b/docs/physical-operators/ShowCreateTableExec.md
@@ -1,3 +1,7 @@
+---
+title: ShowCreateTableExec
+---
+
 # ShowCreateTableExec Physical Command
 
 `ShowCreateTableExec` is a [V2CommandExec](V2CommandExec.md) physical command that represents [ShowCreateTable](../logical-operators/ShowCreateTable.md) logical operator at execution.
diff --git a/docs/physical-operators/ShowTablePropertiesExec.md b/docs/physical-operators/ShowTablePropertiesExec.md
@@ -1,3 +1,7 @@
+---
+title: ShowTablePropertiesExec
+---
+
 # ShowTablePropertiesExec Physical Command
 
 `ShowTablePropertiesExec` is a [physical command](V2CommandExec.md) that represents [ShowTableProperties](../logical-operators/ShowTableProperties.md) logical command at execution time (for non-[ShowTablePropertiesCommand](../logical-operators/ShowTablePropertiesCommand.md) cases).
diff --git a/docs/physical-operators/ShowTablesExec.md b/docs/physical-operators/ShowTablesExec.md
@@ -1,3 +1,7 @@
+---
+title: ShowTablesExec
+---
+
 # ShowTablesExec Physical Command
 
 `ShowTablesExec` is a [physical command](V2CommandExec.md) that represents a [ShowTables](../logical-operators/ShowTables.md) logical command at execution time.
diff --git a/docs/physical-operators/ShuffleExchangeLike.md b/docs/physical-operators/ShuffleExchangeLike.md
diff --git a/docs/physical-operators/ShuffleQueryStageExec.md b/docs/physical-operators/ShuffleQueryStageExec.md
diff --git a/docs/physical-operators/ShuffledHashJoinExec.md b/docs/physical-operators/ShuffledHashJoinExec.md
diff --git a/docs/physical-operators/ShuffledJoin.md b/docs/physical-operators/ShuffledJoin.md
diff --git a/docs/physical-operators/SortExec.md b/docs/physical-operators/SortExec.md
diff --git a/docs/physical-operators/SubqueryExec.md b/docs/physical-operators/SubqueryExec.md
diff --git a/docs/physical-operators/TableWriteExecHelper.md b/docs/physical-operators/TableWriteExecHelper.md
diff --git a/docs/physical-operators/WholeStageCodegenExec.md b/docs/physical-operators/WholeStageCodegenExec.md
