UnresolvedCatalogRelation Leaf Logical Operator

Author: jaceklaskowski

docs/SessionCatalog.md

@@ -325,3 +325,25 @@ getTableMetadata(
 
 !!! note "`CharType` and `VarcharType` Unsupported"
     The Spark SQL query engine does not support char/varchar types yet.
+
+## getRelation { #getRelation }
+
+```scala
+getRelation(
+  metadata: CatalogTable,
+  options: CaseInsensitiveStringMap): LogicalPlan
+```
+
+`getRelation` creates a [LogicalPlan](logical-operators/LogicalPlan.md) with a [SubqueryAlias](logical-operators/SubqueryAlias.md) logical operator with a child logical operator based on the [table type](CatalogTable.md#tableType) of the given [CatalogTable](CatalogTable.md) metadata:
+
+Table Type | Child Logical Operator
+-|-
+ `VIEW` | [fromCatalogTable](#fromCatalogTable)
+ `EXTERNAL` or `MANAGED` | [UnresolvedCatalogRelation](logical-operators/UnresolvedCatalogRelation.md)
+
+---
+
+`getRelation` is used when:
+
+* [ResolveRelations](logical-analysis-rules/ResolveRelations.md) logical analysis rule is executed
+* `SessionCatalog` is requested to [lookupRelation](#lookupRelation)

docs/logical-analysis-rules/ResolveRelations.md

@@ -18,26 +18,26 @@ title: ResolveRelations
 
 * `Analyzer` is requested for the [batches](../Analyzer.md#batches)
 
-## <span id="apply"> Executing Rule
+## Execute Rule { #apply }
 
-```scala
-apply(
-  plan: LogicalPlan): LogicalPlan
-```
+??? note "Rule"
 
-`apply` is part of the [Rule](../catalyst/Rule.md#apply) abstraction.
+    ```scala
+    apply(
+      plan: LogicalPlan): LogicalPlan
+    ```
 
----
+    `apply` is part of the [Rule](../catalyst/Rule.md#apply) abstraction.
 
 `apply` resolves the following operators in the given [LogicalPlan](../logical-operators/LogicalPlan.md) (from bottom to the top of the tree):
 
-* [InsertIntoStatement](../logical-operators/InsertIntoStatement.md)s
-* [V2WriteCommand](../logical-operators/V2WriteCommand.md)s
-* `UnresolvedRelation`s
-* `RelationTimeTravel`s
-* [UnresolvedTable](../logical-operators/UnresolvedTable.md)s
+* [InsertIntoStatement](../logical-operators/InsertIntoStatement.md)
+* [V2WriteCommand](../logical-operators/V2WriteCommand.md)
+* [UnresolvedRelation](../logical-operators/UnresolvedRelation.md)
+* [RelationTimeTravel](../logical-operators/RelationTimeTravel.md)
+* [UnresolvedTable](../logical-operators/UnresolvedTable.md)
 * `UnresolvedView`s
-* [UnresolvedTableOrView](../logical-operators/UnresolvedTableOrView.md)s
+* [UnresolvedTableOrView](../logical-operators/UnresolvedTableOrView.md)
 
 ## Demo
 

docs/logical-operators/UnresolvedCatalogRelation.md

@@ -0,0 +1,27 @@
+---
+title: UnresolvedCatalogRelation
+---
+
+# UnresolvedCatalogRelation Leaf Logical Operator
+
+`UnresolvedCatalogRelation` is an unresolved [leaf logical operator](LeafNode.md) (`UnresolvedLeafNode`) that represents a table relation.
+
+??? note "UnresolvedTable"
+    [UnresolvedTable](UnresolvedTable.md) leaf logical operator looks very similar.
+
+## Creating Instance
+
+`UnresolvedCatalogRelation` takes the following to be created:
+
+* <span id="tableMeta"> [CatalogTable](../CatalogTable.md)
+* <span id="options"> Case-insensitive Options
+* <span id="isStreaming"> `isStreaming` flag (default: `false`)
+
+!!! note
+    `UnresolvedCatalogRelation` asserts that the `database` is defined in the given [CatalogTable](#tableMeta) (in the `TableIdentifier`).
+
+`UnresolvedCatalogRelation` is created when:
+
+* [ResolveRelations](../logical-analysis-rules/ResolveRelations.md) logical analysis rule is executed
+* `SessionCatalog` is requested to [getRelation](../SessionCatalog.md#getRelation)
+* [FindDataSourceTable](../logical-analysis-rules/FindDataSourceTable.md) logical analysis rule is executed (to analyse an [AppendData](AppendData.md))

docs/logical-operators/UnresolvedTable.md

@@ -6,6 +6,9 @@ title: UnresolvedTable
 
 `UnresolvedTable` is an unresolved [leaf logical operator](LeafNode.md) (`UnresolvedLeafNode`) that represents a table that has yet to be looked up in a catalog.
 
+??? note "UnresolvedCatalogRelation"
+    [UnresolvedCatalogRelation](UnresolvedCatalogRelation.md) leaf logical operator looks very similar.
+
 ## Creating Instance
 
 `UnresolvedTable` takes the following to be created: