Module stream_plan

Modules

• agg_call_state
  Nested message and enum types in AggCallState.
• barrier
  Nested message and enum types in Barrier.
• barrier_mutation
  Nested message and enum types in BarrierMutation.
• expand_node
  Nested message and enum types in ExpandNode.
• lookup_node
  Nested message and enum types in LookupNode.
• now_node
  Nested message and enum types in NowNode.
• stream_fragment_graph
  Nested message and enum types in StreamFragmentGraph.
• stream_message
  Nested message and enum types in StreamMessage.
• stream_node
  Nested message and enum types in StreamNode.
• throttle_mutation
  Nested message and enum types in ThrottleMutation.
• update_mutation
  Nested message and enum types in UpdateMutation.
• values_node
  Nested message and enum types in ValuesNode.

Structs

• ActorMapping
  Hash mapping for compute node. Stores mapping from virtual node to actor id.
• AddMutation
• AggCallState
• ArrangeNode
  Special node for shared state, which will only be produced in fragmenter. ArrangeNode will produce a special Materialize executor, which materializes data for downstream to query.
• ArrangementInfo
• AsOfJoinNode
• Barrier
• BarrierMutation
• BarrierRecvNode
  The executor only for receiving barrier from the meta service. It always resides in the leaves of the streaming graph.
• BatchPlanNode
  BatchPlanNode is used for mv on mv snapshot read. BatchPlanNode is supposed to carry a batch plan that can be optimized with the streaming plan_common. Currently, streaming to batch push down is not yet supported, BatchPlanNode is simply a table scan.
• CdcFilterNode
• ChangeLogNode
• CombinedMutation
• DedupNode
• DeltaExpression
• DeltaIndexJoinNode
  Delta join with two indexes. This is a pseudo plan node generated on frontend. On meta service, it will be rewritten into lookup joins.
• DispatchStrategy
  The property of an edge in the fragment graph. This is essientially a “logical” version of Dispatcher. See the doc of Dispatcher for more details.
• Dispatcher
  A dispatcher redistribute messages. We encode both the type and other usage information in the proto.
• Dispatchers
• DmlNode
  Merges two streams from streaming and batch for data manipulation.
• DropSubscriptionsMutation
• DynamicFilterNode
• EowcOverWindowNode
• ExchangeNode
  passed from frontend to meta, used by fragmenter to generate MergeNode and maybe DispatcherNode later.
• ExpandNode
• FilterNode
• GlobalApproxPercentileNode
• GroupTopNNode
• HashAggNode
• HashJoinNode
• HopWindowNode
• InequalityPair
• LocalApproxPercentileNode
• LookupNode
  Special node for shared state. LookupNode will join an arrangement with a stream.
• LookupUnionNode
  Special node for shared state. Merge and align barrier from upstreams. Pipe inputs in order.
• MaterializeNode
  A materialized view is regarded as a table. In addition, we also specify primary key to MV for efficient point lookup during update and deletion.
• MergeNode
• NoOpNode
• NowModeGenerateSeries
• NowModeUpdateCurrent
• NowNode
• OverWindowNode
• PauseMutation
• ProjectNode
• ProjectSetNode
• ResumeMutation
• RowIdGenNode
• RowMergeNode
• SimpleAggNode
• SinkDesc
• SinkNode
• SortNode
  Sorts inputs and outputs ordered data based on watermark.
• SourceBackfillNode
• SourceChangeSplitMutation
• SourceNode
• StopMutation
• StreamActor
  A StreamActor is a running fragment of the overall stream graph,
• StreamCdcScanNode
• StreamCdcScanOptions
  Config options for CDC backfill
• StreamContext
  The streaming context associated with a stream plan
• StreamFragmentGraph
  Representation of a graph of stream fragments. Generated by the fragmenter in the frontend, only used in DDL requests and never persisted.
• StreamFsFetch
  copy contents from StreamSource to prevent compatibility issues in the future
• StreamFsFetchNode
• StreamMessage
• StreamNode
• StreamScanNode
  StreamScanNode reads data from upstream table first, and then pass all events to downstream. It always these 2 inputs in the following order:
• StreamSource
• SubscriptionUpstreamInfo
• TemporalJoinNode
• ThrottleMutation
• TopNNode
• UnionNode
  Acts like a merger, but on different inputs.
• UpdateMutation
• ValuesNode
• Watermark
• WatermarkFilterNode
  WatermarkFilter needs to filter the upstream data by the water mark.

Enums

• AggNodeVersion
• DispatcherType
• FragmentTypeFlag
  Indicates whether the fragment contains some special kind of nodes.
• OverWindowCachePolicy
• SinkLogStoreType
• StreamScanType
  Decides which kind of Executor will be used

Type Aliases

• PbActorMapping
  Alias for ActorMapping.
• PbAddMutation
  Alias for AddMutation.
• PbAggCallState
  Alias for AggCallState.
• PbAggNodeVersion
  Alias for AggNodeVersion.
• PbArrangeNode
  Alias for ArrangeNode.
• PbArrangementInfo
  Alias for ArrangementInfo.
• PbAsOfJoinNode
  Alias for AsOfJoinNode.
• PbBarrier
  Alias for Barrier.
• PbBarrierMutation
  Alias for BarrierMutation.
• PbBarrierRecvNode
  Alias for BarrierRecvNode.
• PbBatchPlanNode
  Alias for BatchPlanNode.
• PbCdcFilterNode
  Alias for CdcFilterNode.
• PbChangeLogNode
  Alias for ChangeLogNode.
• PbCombinedMutation
  Alias for CombinedMutation.
• PbDedupNode
  Alias for DedupNode.
• PbDeltaExpression
  Alias for DeltaExpression.
• PbDeltaIndexJoinNode
  Alias for DeltaIndexJoinNode.
• PbDispatchStrategy
  Alias for DispatchStrategy.
• PbDispatcher
  Alias for Dispatcher.
• PbDispatcherType
  Alias for DispatcherType.
• PbDispatchers
  Alias for Dispatchers.
• PbDmlNode
  Alias for DmlNode.
• PbDropSubscriptionsMutation
  Alias for DropSubscriptionsMutation.
• PbDynamicFilterNode
  Alias for DynamicFilterNode.
• PbEowcOverWindowNode
  Alias for EowcOverWindowNode.
• PbExchangeNode
  Alias for ExchangeNode.
• PbExpandNode
  Alias for ExpandNode.
• PbFilterNode
  Alias for FilterNode.
• PbFragmentTypeFlag
  Alias for FragmentTypeFlag.
• PbGlobalApproxPercentileNode
  Alias for GlobalApproxPercentileNode.
• PbGroupTopNNode
  Alias for GroupTopNNode.
• PbHashAggNode
  Alias for HashAggNode.
• PbHashJoinNode
  Alias for HashJoinNode.
• PbHopWindowNode
  Alias for HopWindowNode.
• PbInequalityPair
  Alias for InequalityPair.
• PbLocalApproxPercentileNode
  Alias for LocalApproxPercentileNode.
• PbLookupNode
  Alias for LookupNode.
• PbLookupUnionNode
  Alias for LookupUnionNode.
• PbMaterializeNode
  Alias for MaterializeNode.
• PbMergeNode
  Alias for MergeNode.
• PbNoOpNode
  Alias for NoOpNode.
• PbNowModeGenerateSeries
  Alias for NowModeGenerateSeries.
• PbNowModeUpdateCurrent
  Alias for NowModeUpdateCurrent.
• PbNowNode
  Alias for NowNode.
• PbOverWindowCachePolicy
  Alias for OverWindowCachePolicy.
• PbOverWindowNode
  Alias for OverWindowNode.
• PbPauseMutation
  Alias for PauseMutation.
• PbProjectNode
  Alias for ProjectNode.
• PbProjectSetNode
  Alias for ProjectSetNode.
• PbResumeMutation
  Alias for ResumeMutation.
• PbRowIdGenNode
  Alias for RowIdGenNode.
• PbRowMergeNode
  Alias for RowMergeNode.
• PbSimpleAggNode
  Alias for SimpleAggNode.
• PbSinkDesc
  Alias for SinkDesc.
• PbSinkLogStoreType
  Alias for SinkLogStoreType.
• PbSinkNode
  Alias for SinkNode.
• PbSortNode
  Alias for SortNode.
• PbSourceBackfillNode
  Alias for SourceBackfillNode.
• PbSourceChangeSplitMutation
  Alias for SourceChangeSplitMutation.
• PbSourceNode
  Alias for SourceNode.
• PbStopMutation
  Alias for StopMutation.
• PbStreamActor
  Alias for StreamActor.
• PbStreamCdcScanNode
  Alias for StreamCdcScanNode.
• PbStreamCdcScanOptions
  Alias for StreamCdcScanOptions.
• PbStreamContext
  Alias for StreamContext.
• PbStreamFragmentGraph
  Alias for StreamFragmentGraph.
• PbStreamFsFetch
  Alias for StreamFsFetch.
• PbStreamFsFetchNode
  Alias for StreamFsFetchNode.
• PbStreamMessage
  Alias for StreamMessage.
• PbStreamNode
  Alias for StreamNode.
• PbStreamScanNode
  Alias for StreamScanNode.
• PbStreamScanType
  Alias for StreamScanType.
• PbStreamSource
  Alias for StreamSource.
• PbSubscriptionUpstreamInfo
  Alias for SubscriptionUpstreamInfo.
• PbTemporalJoinNode
  Alias for TemporalJoinNode.
• PbThrottleMutation
  Alias for ThrottleMutation.
• PbTopNNode
  Alias for TopNNode.
• PbUnionNode
  Alias for UnionNode.
• PbUpdateMutation
  Alias for UpdateMutation.
• PbValuesNode
  Alias for ValuesNode.
• PbWatermark
  Alias for Watermark.
• PbWatermarkFilterNode
  Alias for WatermarkFilterNode.