Skip to content

Commit 0f04f6f

Browse files
jaceklaskowskijaceklaskowski
committed
[MINOR] Add titles to logical operators
1 parent cdffda6 commit 0f04f6f

File tree

92 files changed

+511
-127
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

92 files changed

+511
-127
lines changed

‎docs/logical-operators/AddColumns.md‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,7 @@
1+
---
2+
title: AddColumns
3+
---
4+
15
# AddColumns Logical Operator
26

37
`AddColumns` is an `AlterTableCommand` logical operator that represents [ALTER TABLE ADD COLUMNS](../sql/AstBuilder.md#visitAddTableColumns) SQL statement (in a logical query plan).

‎docs/logical-operators/Aggregate.md‎

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,7 @@
1+
---
2+
title: Aggregate
3+
---
4+
15
# Aggregate Logical Operator
26

37
`Aggregate` is a [unary logical operator](LogicalPlan.md#UnaryNode) for [Aggregation Queries](../aggregations/index.md) and can represent the following high-level operators in a [logical query plan](LogicalPlan.md):
@@ -94,7 +98,7 @@ In the end, `supportsHashAggregate` [isAggregateBufferMutable](#isAggregateBuffe
9498
* `AggUtils` is requested to [create a physical operator for aggregation](../aggregations/AggUtils.md#createAggregate)
9599
* `HashAggregateExec` physical operator is created (to assert that the [aggregateBufferAttributes](../physical-operators/HashAggregateExec.md#aggregateBufferAttributes) are supported)
96100

97-
## <span id="isAggregateBufferMutable"> isAggregateBufferMutable
101+
## isAggregateBufferMutable { #isAggregateBufferMutable }
98102

99103
```scala
100104
isAggregateBufferMutable(

‎docs/logical-operators/AlterTable.md‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,7 @@
1+
---
2+
title: AlterTable
3+
---
4+
15
# AlterTable Logical Command
26

37
`AlterTable` is a [Command](Command.md) for `ALTER TABLE` SQL commands:

‎docs/logical-operators/AlterTableAddColumnsCommand.md‎

Lines changed: 14 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,7 @@
1+
---
2+
title: AlterTableAddColumnsCommand
3+
---
4+
15
# AlterTableAddColumnsCommand Logical Runnable Command
26

37
`AlterTableAddColumnsCommand` is a [LeafRunnableCommand](LeafRunnableCommand.md) that represents [AddColumns](AddColumns.md) logical operator.
@@ -13,12 +17,16 @@
1317

1418
* [ResolveSessionCatalog](../logical-analysis-rules/ResolveSessionCatalog.md) logical resolution rule is executed (and resolves [AddColumns](AddColumns.md) logical operator)
1519

16-
## <span id="run"> Executing Command
20+
## Executing Command { #run }
1721

18-
```scala
19-
run(
20-
sparkSession: SparkSession): Seq[Row]
21-
```
22+
??? note "RunnableCommand"
23+
24+
```scala
25+
run(
26+
sparkSession: SparkSession): Seq[Row]
27+
```
28+
29+
`run` is part of the [RunnableCommand](RunnableCommand.md#run) abstraction.
2230

2331
`run` [verifyAlterTableAddColumn](#verifyAlterTableAddColumn) (with the [SessionCatalog](../SessionCatalog.md)).
2432

@@ -30,11 +38,7 @@ run(
3038

3139
`run` requests the `SessionCatalog` to [alterTableDataSchema](../SessionCatalog.md#alterTableDataSchema).
3240

33-
---
34-
35-
`run` is part of the [RunnableCommand](RunnableCommand.md#run) abstraction.
36-
37-
### <span id="verifyAlterTableAddColumn"> verifyAlterTableAddColumn
41+
### verifyAlterTableAddColumn { #verifyAlterTableAddColumn }
3842

3943
```scala
4044
verifyAlterTableAddColumn(

‎docs/logical-operators/AnalyzeColumn.md‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,7 @@
1+
---
2+
title: AnalyzeColumn
3+
---
4+
15
# AnalyzeColumn Logical Command
26

37
`AnalyzeColumn` is a [Command](Command.md) for [ANALYZE TABLE FOR COLUMNS](../sql/AstBuilder.md#visitAnalyze) SQL statement.

‎docs/logical-operators/AnalyzeColumnCommand.md‎

Lines changed: 17 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,7 @@
1+
---
2+
title: AnalyzeColumnCommand
3+
---
4+
15
# AnalyzeColumnCommand Logical Command
26

37
`AnalyzeColumnCommand` is a [logical command](RunnableCommand.md) to represent [AnalyzeColumn](AnalyzeColumn.md) logical operator.
@@ -16,21 +20,23 @@
1620

1721
* [ResolveSessionCatalog](../logical-analysis-rules/ResolveSessionCatalog.md) logical resolution rule is executed (to resolve an [AnalyzeColumn](AnalyzeColumn.md))
1822

19-
## <span id="run"> Executing Logical Command
23+
## Executing Command { #run }
2024

21-
```scala
22-
run(
23-
sparkSession: SparkSession): Seq[Row]
24-
```
25+
??? note "RunnableCommand"
26+
27+
```scala
28+
run(
29+
sparkSession: SparkSession): Seq[Row]
30+
```
2531

26-
`run` is part of [RunnableCommand](RunnableCommand.md#run) abstraction.
32+
`run` is part of [RunnableCommand](RunnableCommand.md#run) abstraction.
2733

2834
`run` calculates the following statistics:
2935

30-
* sizeInBytes
36+
* `sizeInBytes`
3137
* stats for each column
3238

33-
### <span id="computeColumnStats"> Computing Statistics for Specified Columns
39+
### Computing Statistics for Specified Columns { #computeColumnStats }
3440

3541
```scala
3642
computeColumnStats(
@@ -41,7 +47,7 @@ computeColumnStats(
4147

4248
`computeColumnStats`...FIXME
4349

44-
### <span id="computePercentiles"> Computing Percentiles
50+
### Computing Percentiles { #computePercentiles }
4551

4652
```scala
4753
computePercentiles(
@@ -52,7 +58,7 @@ computePercentiles(
5258

5359
`computePercentiles`...FIXME
5460

55-
### <span id="analyzeColumnInCatalog"> analyzeColumnInCatalog
61+
### analyzeColumnInCatalog { #analyzeColumnInCatalog }
5662

5763
```scala
5864
analyzeColumnInCatalog(
@@ -79,7 +85,7 @@ Property | Value
7985

8086
In the end, `analyzeColumnInCatalog` requests the [SessionCatalog](../SessionState.md#catalog) to [alter](../SessionCatalog.md#alterTableStats) the [table](#tableIdent) with the new [CatalogStatistics](../CatalogStatistics.md).
8187

82-
#### <span id="analyzeColumnInCatalog-AnalysisException"> AnalysisException
88+
#### AnalysisException { #analyzeColumnInCatalog-AnalysisException }
8389

8490
`analyzeColumnInCatalog` throws the following `AnalysisException` unless the catalog view is cached:
8591

‎docs/logical-operators/AnalyzePartitionCommand.md‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,7 @@
1+
---
2+
title: AnalyzePartitionCommand
3+
---
4+
15
# AnalyzePartitionCommand Logical Command
26

37
`AnalyzePartitionCommand` is a [LeafRunnableCommand](LeafRunnableCommand.md) that represents [ANALYZE TABLE PARTITION COMPUTE STATISTICS](../sql/AstBuilder.md#visitAnalyze) ([AnalyzeTable](AnalyzeTable.md) logical command with [partition specification](#partitionSpec)) at analysis.

‎docs/logical-operators/AnalyzeTableCommand.md‎

Lines changed: 13 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,7 @@
1+
---
2+
title: AnalyzeTableCommand
3+
---
4+
15
# AnalyzeTableCommand Logical Command
26

37
`AnalyzeTableCommand` is a [LeafRunnableCommand](LeafRunnableCommand.md) that [computes statistics](#run) (and stores them in a metastore).
@@ -13,19 +17,21 @@
1317

1418
* [ResolveSessionCatalog](../logical-analysis-rules/ResolveSessionCatalog.md) logical resolution rule is executed (and resolves an [AnalyzeTable](AnalyzeTable.md) logical operator with no `PARTITION`s)
1519

16-
## <span id="run"> run
20+
## Executing Command { #run }
1721

18-
```scala
19-
run(
20-
sparkSession: SparkSession): Seq[Row]
21-
```
22+
??? note "RunnableCommand"
23+
24+
```scala
25+
run(
26+
sparkSession: SparkSession): Seq[Row]
27+
```
28+
29+
`run` is part of the [RunnableCommand](RunnableCommand.md#run) abstraction.
2230

2331
`run` [analyzes](../CommandUtils.md#analyzeTable) the given [table](#tableIdent).
2432

2533
`run` returns an empty collection.
2634

27-
`run` is part of the [RunnableCommand](RunnableCommand.md#run) abstraction.
28-
2935
## Demo
3036

3137
### AnalyzeTableCommand

‎docs/logical-operators/AnalyzeTablesCommand.md‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,7 @@
1+
---
2+
title: AnalyzeTablesCommand
3+
---
4+
15
# AnalyzeTablesCommand Logical Command
26

37
`AnalyzeTablesCommand` is a [LeafRunnableCommand](LeafRunnableCommand.md) that represents `ANALYZE TABLES COMPUTE STATISTICS` SQL statement (`AnalyzeTables` logical command) at query execution.

‎docs/logical-operators/AppendData.md‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,7 @@
1+
---
2+
title: AppendData
3+
---
4+
15
# AppendData Logical Command
26

37
`AppendData` is a [V2WriteCommand](V2WriteCommand.md) that represents appending data (the result of executing a [structured query](#query)) to a [table](#table) (with the [columns matching](#isByName) by [name](#byName) or [position](#byPosition)).

0 commit comments

Comments
 (0)