[SDP] GraphElement

Author: jaceklaskowski

docs/declarative-pipelines/FlowAnalysis.md

@@ -31,7 +31,7 @@ In the end, `FlowFunction` creates a [FlowFunctionResult](FlowFunctionResult.md)
 `createFlowFunctionFromLogicalPlan` is used when:
 
 * `PipelinesHandler` is requested to [define a flow](PipelinesHandler.md#defineFlow)
-* `SqlGraphRegistrationContext` is requested to [handle the following logical commands](SqlGraphRegistrationContext.md#processSqlQuery):
+* `SqlGraphRegistrationContext` is requested to [handle the following queries](SqlGraphRegistrationContext.md#processSqlQuery):
  * [CreateFlowCommand](SqlGraphRegistrationContext.md#CreateFlowCommand)
  * [CreateMaterializedViewAsSelect](SqlGraphRegistrationContext.md#CreateMaterializedViewAsSelect)
  * [CreateView](SqlGraphRegistrationContext.md#CreateView)

docs/declarative-pipelines/GraphElement.md

@@ -1,3 +1,33 @@
 # GraphElement
 
-`GraphElement` is...FIXME
+`GraphElement` is an [abstraction](#contract) of [dataflow graph elements](#implementations) that have an [identifier](#identifier) and an [origin](#origin).
+
+## Contract
+
+### Identifier { #identifier }
+
+```scala
+identifier: TableIdentifier
+```
+
+### QueryOrigin { #origin }
+
+```scala
+origin: QueryOrigin
+```
+
+Used when:
+
+* `PipelinesHandler` is requested to [define a flow](PipelinesHandler.md#defineFlow) and an [output](PipelinesHandler.md#defineOutput)
+* `SqlGraphRegistrationContext` is requested to [process a single SQL query](SqlGraphRegistrationContext.md#processSqlQuery)
+* `FlowResolver` is requested to [attemptResolveFlow](FlowResolver.md#attemptResolveFlow)
+* `DatasetManager` is requested to [materialize datasets](DatasetManager.md#materializeDatasets) (for error reporting)
+* `FlowExecution` is requested for the [QueryOrigin](FlowExecution.md#getOrigin)
+* [FlowProgressEventLogger](FlowProgressEventLogger.md) is requested to report an event
+
+## Implementations
+
+* [Flow](Flow.md)
+* [Input](Input.md)
+* [Sink](Sink.md)
+* [View](View.md)

docs/declarative-pipelines/GraphRegistrationContext.md

@@ -105,7 +105,7 @@ registerFlow(
 `registerFlow` is used when:
 
 * `PipelinesHandler` is requested to [define a flow](PipelinesHandler.md#defineFlow)
-* `SqlGraphRegistrationContext` is requested to [process the following logical commands](SqlGraphRegistrationContext.md#processSqlQuery):
+* `SqlGraphRegistrationContext` is requested to [process the following SQL queries](SqlGraphRegistrationContext.md#processSqlQuery):
  * [CREATE FLOW ... AS INSERT INTO ... BY NAME](../logical-operators/CreateFlowCommand.md)
  * [CREATE MATERIALIZED VIEW ... AS](../logical-operators/CreateMaterializedViewAsSelect.md)
  * [CREATE STREAMING TABLE ... AS](../logical-operators/CreateStreamingTableAsSelect.md)
@@ -141,7 +141,7 @@ registerTable(
 `registerTable` is used when:
 
 * `PipelinesHandler` is requested to [define an output](PipelinesHandler.md#defineOutput)
-* `SqlGraphRegistrationContext` is requested to [process the following logical commands](SqlGraphRegistrationContext.md#processSqlQuery):
+* `SqlGraphRegistrationContext` is requested to [process the following SQL queries](SqlGraphRegistrationContext.md#processSqlQuery):
  * [CREATE MATERIALIZED VIEW ... AS](../logical-operators/CreateMaterializedViewAsSelect.md)
  * [CREATE STREAMING TABLE ... AS](../logical-operators/CreateStreamingTableAsSelect.md)
  * [CREATE STREAMING TABLE](../logical-operators/CreateStreamingTable.md)

docs/declarative-pipelines/SqlGraphRegistrationContext.md

@@ -37,7 +37,7 @@ processSqlFile(
 
 * `PipelinesHandler` is requested to [defineSqlGraphElements](PipelinesHandler.md#defineSqlGraphElements)
 
-### Process Single Logical Command { #processSqlQuery }
+### Process Single SQL Query { #processSqlQuery }
 
 ```scala
 processSqlQuery(

docs/declarative-pipelines/UnresolvedFlow.md

@@ -29,7 +29,7 @@
 `UnresolvedFlow` is created when:
 
 * `PipelinesHandler` is requested to [define a flow](PipelinesHandler.md#defineFlow)
-* `SqlGraphRegistrationContext` is requested to [handle the following logical commands](SqlGraphRegistrationContext.md#processSqlQuery):
+* `SqlGraphRegistrationContext` is requested to [handle the following SQL queries](SqlGraphRegistrationContext.md#processSqlQuery):
  * [CreateFlowCommand](SqlGraphRegistrationContext.md#CreateFlowCommand)
  * [CreateMaterializedViewAsSelect](SqlGraphRegistrationContext.md#CreateMaterializedViewAsSelect)
  * [CreateView](SqlGraphRegistrationContext.md#CreateView)

docs/declarative-pipelines/View.md

@@ -0,0 +1,3 @@
+# View
+
+`View` is...FIXME