[SDP] UnresolvedFlow et al.

Author: jaceklaskowski

docs/declarative-pipelines/AppendOnceFlow.md

@@ -0,0 +1,14 @@
+# AppendOnceFlow
+
+`AppendOnceFlow` is a [ResolvedFlow](ResolvedFlow.md) with [once](Flow.md#once) enabled.
+
+## Creating Instance
+
+`AppendOnceFlow` takes the following to be created:
+
+* <span id="flow"> [UnresolvedFlow](UnresolvedFlow.md)
+* <span id="funcResult"> `FlowFunctionResult`
+
+`AppendOnceFlow` is created when:
+
+* `FlowResolver` is requested to [convertResolvedToTypedFlow](FlowResolver.md#convertResolvedToTypedFlow) (for [UnresolvedFlow](UnresolvedFlow.md)s with [once](UnresolvedFlow.md#once) enabled)

docs/declarative-pipelines/CompleteFlow.md

@@ -1,3 +1,17 @@
 # CompleteFlow
 
-`CompleteFlow` is...FIXME
+`CompleteFlow` is a [ResolvedFlow](ResolvedFlow.md) that may or may not be [append](#mustBeAppend).
+
+`CompleteFlow` is planned for execution as [BatchTableWrite](BatchTableWrite.md) by [FlowPlanner](FlowPlanner.md#plan).
+
+## Creating Instance
+
+`CompleteFlow` takes the following to be created:
+
+* <span id="flow"> [UnresolvedFlow](UnresolvedFlow.md)
+* <span id="funcResult"> `FlowFunctionResult`
+* <span id="mustBeAppend"> `mustBeAppend` flag (default: `false`)
+
+`CompleteFlow` is created when:
+
+* `FlowResolver` is requested to [convertResolvedToTypedFlow](FlowResolver.md#convertResolvedToTypedFlow) (for [UnresolvedFlow](UnresolvedFlow.md)s that are neither [once](UnresolvedFlow.md#once) nor their results are streaming dataframes)

docs/declarative-pipelines/ResolutionFailedFlow.md

@@ -0,0 +1,14 @@
+# ResolutionFailedFlow
+
+`ResolutionFailedFlow` is a [ResolutionCompletedFlow](ResolutionCompletedFlow.md).
+
+## Creating Instance
+
+`ResolutionFailedFlow` takes the following to be created:
+
+* <span id="flow"> [UnresolvedFlow](UnresolvedFlow.md)
+* <span id="funcResult"> `FlowFunctionResult`
+
+`ResolutionFailedFlow` is created when:
+
+* `FlowResolver` is requested to [attemptResolveFlow](FlowResolver.md#attemptResolveFlow)

docs/declarative-pipelines/StreamingFlow.md

@@ -1,8 +1,8 @@
 # StreamingFlow
 
-`StreamingFlow` is a [ResolvedFlow](ResolvedFlow.md).
+`StreamingFlow` is a [ResolvedFlow](ResolvedFlow.md) that may or may not be [append](#mustBeAppend).
 
-`StreamingFlow` is [planned for execution](FlowPlanner.md#plan) as a [StreamingTableWrite](StreamingTableWrite.md).
+`StreamingFlow` is planned for execution as [StreamingTableWrite](StreamingTableWrite.md) by [FlowPlanner](FlowPlanner.md#plan).
 
 ## Creating Instance
 
@@ -14,4 +14,4 @@
 
 `StreamingFlow` is created when:
 
-* `FlowResolver` is requested to [convertResolvedToTypedFlow](FlowResolver.md#convertResolvedToTypedFlow)
+* `FlowResolver` is requested to [convertResolvedToTypedFlow](FlowResolver.md#convertResolvedToTypedFlow) (for [UnresolvedFlow](UnresolvedFlow.md)s with their results being streaming dataframes)

docs/declarative-pipelines/UnresolvedFlow.md

@@ -1,3 +1,31 @@
 # UnresolvedFlow
 
-`UnresolvedFlow` is...FIXME
+`UnresolvedFlow` is a [Flow](Flow.md).
+
+`UnresolvedFlow` is registered to a [GraphRegistrationContext](GraphRegistrationContext.md) with [registerFlow](GraphRegistrationContext.md#registerFlow).
+
+`UnresolvedFlow` is analyzed and resolved to [ResolvedFlow](ResolvedFlow.md) (by [FlowResolver](FlowResolver.md#attemptResolveFlow) when [DataflowGraph](DataflowGraph.md) is requested to [resolve](DataflowGraph.md#resolve)).
+
+`UnresolvedFlow` [must have unique identifiers](GraphRegistrationContext.md#assertFlowIdentifierIsUnique) (or an `AnalysisException` is reported).
+
+## Creating Instance
+
+`UnresolvedFlow` takes the following to be created:
+
+* <span id="identifier"> `TableIdentifier`
+* <span id="destinationIdentifier"> Flow destination (`TableIdentifier`)
+* <span id="func"> `FlowFunction`
+* <span id="queryContext"> `QueryContext`
+* <span id="sqlConf"> SQL Config
+* <span id="once"> `once` flag
+* <span id="origin"> `QueryOrigin`
+
+`UnresolvedFlow` is created when:
+
+* `PipelinesHandler` is requested to [define a flow](PipelinesHandler.md#defineFlow)
+* `SqlGraphRegistrationContext` is requested to [handle the following pipeline commands](SqlGraphRegistrationContext.md#processSqlQuery):
+    * [CreateFlowCommand](SqlGraphRegistrationContext.md#CreateFlowCommand)
+    * [CreateMaterializedViewAsSelect](SqlGraphRegistrationContext.md#CreateMaterializedViewAsSelect)
+    * [CreateView](SqlGraphRegistrationContext.md#CreateView)
+    * [CreateStreamingTableAsSelect](SqlGraphRegistrationContext.md#CreateStreamingTableAsSelect)
+    * [CreateViewCommand](SqlGraphRegistrationContext.md#CreateViewCommand)