Skip to main content Module stream_plan Copy item path Source add_mutation Nested message and enum types in AddMutation. 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. compaction_resolver_node Nested message and enum types in CompactionResolverNode. connector_props_change_mutation Nested message and enum types in ConnectorPropsChangeMutation. dispatch_output_mapping Nested message and enum types in DispatchOutputMapping. expand_node Nested message and enum types in ExpandNode. iceberg_pk_index_compaction_context Nested message and enum types in IcebergPkIndexCompactionContext. lookup_node Nested message and enum types in LookupNode. match_recognize_after_match_skip Nested message and enum types in MatchRecognizeAfterMatchSkip. match_recognize_define_slot Nested message and enum types in MatchRecognizeDefineSlot. match_recognize_measure_slot Nested message and enum types in MatchRecognizeMeasureSlot. match_recognize_pattern_node Nested message and enum types in MatchRecognizePatternNode. match_recognize_quantifier Nested message and enum types in MatchRecognizeQuantifier. now_node Nested message and enum types in NowNode. sink_schema_change Nested message and enum types in SinkSchemaChange. stream_fragment_graph Nested message and enum types in StreamFragmentGraph. stream_message Nested message and enum types in StreamMessage. stream_message_batch Nested message and enum types in StreamMessageBatch. 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. 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 BackfillOrder 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 Columns CompactionResolverNode Leaf of the inactive pk-index compaction pipeline rendered with the sink job. ConnectorPropsChangeMutation 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. DispatchOutputMapping The method to map the upstream columns in the dispatcher before dispatching. 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 EowcGapFillNode EowcOverWindowNode ExchangeNode passed from frontend to meta, used by fragmenter to generate MergeNode
and maybe DispatcherNode later. ExpandNode FilterNode GapFillNode GlobalApproxPercentileNode GroupTopNNode HashAggNode HashJoinNode HashJoinWatermarkHandleDesc HopWindowNode IcebergPkIndexCompactionContext Context for an ongoing iceberg pk-index compaction. IcebergWithPkIndexPositionDeleteMergerNode IcebergWithPkIndexWriterNode InequalityPair Deprecated: Use InequalityPairV2 instead. InequalityPairV2 InjectSourceOffsetsMutation Inject specific offsets into source splits (UNSAFE - admin only).
This overwrites the stored offsets and can cause data duplication or loss. JoinKeyWatermarkIndex ListFinishMutation LoadFinishMutation LocalApproxPercentileNode LocalityProviderNode 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. MatchRecognizeAfterMatchSkip The AFTER MATCH SKIP clause: where the scan resumes after an emitted match. MatchRecognizeDefine A DEFINE predicate. The condition is evaluated, per candidate row during matching, over a
synthetic row whose i-th column is produced by slots[i] from the candidate row, its physical
neighbours, and the in-progress match’s labels. MatchRecognizeDefineSlot One input a DEFINE predicate reads. MatchRecognizeMeasure One MEASURES item. The expression is evaluated over a synthetic per-match row whose i-th column is
produced by slots\[i\]; the executor materializes that row once the match and its per-row pattern
variable labels are known. MatchRecognizeMeasureSlot One navigation input of a measure expression. MatchRecognizeNode SQL:2016 MATCH_RECOGNIZE (row pattern recognition). v1: append-only input,
ONE ROW PER MATCH. PARTITION BY / ORDER BY are input column indices. MatchRecognizePatternNode A node in the structured row pattern tree, mirroring the executor-side pattern AST. Groups and
anchors are not represented: parenthesized groups are flattened during lowering, and anchors /
exclusions are rejected at planning time (not supported in v1). MatchRecognizePatternSeq An ordered list of sub-patterns (the operands of a concatenation or alternation). MatchRecognizePermutePattern PERMUTE(a, b, ...) over the listed pattern variables.MatchRecognizeQuantifiedPattern A sub-pattern with a quantifier, e.g. A+, A*?, A{1,3}. MatchRecognizeQuantifier A row-pattern quantifier. 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. MaterializedExprsNode MergeNode NoOpNode NowModeGenerateSeries NowModeUpdateCurrent NowNode OverWindowNode PauseMutation ProjectNode ProjectSetNode RefreshStartMutation ResetSourceMutation ResumeMutation RowIdGenNode RowMergeNode SimpleAggNode SinkAddColumnsOp Add columns operation SinkDesc SinkDropColumnsOp Drop columns operation SinkNode SinkSchemaChange Schema change operation for sink SortNode Sorts inputs and outputs ordered data based on watermark. SourceBackfillNode / It’s input must be a MergeNode, which connects to the upstream source job.
/ See StreamSourceScan::adhoc_to_stream_prost for the plan. SourceChangeSplitMutation SourceNode StartFragmentBackfillMutation 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 StreamMessageBatch 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 SyncLogStoreNode TemporalJoinNode ThrottleMutation TopNNode UnionNode Acts like a merger, but on different inputs. UpdateMutation UpstreamSinkInfo UpstreamSinkUnionNode ValuesNode VectorIndexLookupJoinNode VectorIndexWriteNode Watermark WatermarkFilterNode WatermarkFilter needs to filter the upstream data by the water mark. AggNodeVersion DispatcherType InequalityType JoinEncodingType MatchRecognizeInputMode OverWindowCachePolicy SinkLogStoreType StreamScanType Decides which kind of Executor will be used PbActorMapping PbAddMutation PbAggCallState PbAggNodeVersion PbArrangeNode PbArrangementInfo PbAsOfJoinNode PbBackfillOrder PbBarrier PbBarrierMutation PbBarrierRecvNode PbBatchPlanNode PbCdcFilterNode PbChangeLogNode PbColumns PbCompactionResolverNode PbConnectorPropsChangeMutation PbDedupNode PbDeltaExpression PbDeltaIndexJoinNode PbDispatchOutputMapping PbDispatchStrategy PbDispatcher PbDispatcherType PbDispatchers PbDmlNode PbDropSubscriptionsMutation PbDynamicFilterNode PbEowcGapFillNode PbEowcOverWindowNode PbExchangeNode PbExpandNode PbFilterNode PbGapFillNode PbGlobalApproxPercentileNode PbGroupTopNNode PbHashAggNode PbHashJoinNode PbHashJoinWatermarkHandleDesc PbHopWindowNode PbIcebergPkIndexCompactionContext PbIcebergWithPkIndexPositionDeleteMergerNode PbIcebergWithPkIndexWriterNode PbInequalityPair PbInequalityPairV2 PbInequalityType PbInjectSourceOffsetsMutation PbJoinEncodingType PbJoinKeyWatermarkIndex PbListFinishMutation PbLoadFinishMutation PbLocalApproxPercentileNode PbLocalityProviderNode PbLookupNode PbLookupUnionNode PbMatchRecognizeAfterMatchSkip PbMatchRecognizeDefine PbMatchRecognizeDefineSlot PbMatchRecognizeInputMode PbMatchRecognizeMeasure PbMatchRecognizeMeasureSlot PbMatchRecognizeNode PbMatchRecognizePatternNode PbMatchRecognizePatternSeq PbMatchRecognizePermutePattern PbMatchRecognizeQuantifiedPattern PbMatchRecognizeQuantifier PbMaterializeNode PbMaterializedExprsNode PbMergeNode PbNoOpNode PbNowModeGenerateSeries PbNowModeUpdateCurrent PbNowNode PbOverWindowCachePolicy PbOverWindowNode PbPauseMutation PbProjectNode PbProjectSetNode PbRefreshStartMutation PbResetSourceMutation PbResumeMutation PbRowIdGenNode PbRowMergeNode PbSimpleAggNode PbSinkAddColumnsOp PbSinkDesc PbSinkDropColumnsOp PbSinkLogStoreType PbSinkNode PbSinkSchemaChange PbSortNode PbSourceBackfillNode PbSourceChangeSplitMutation PbSourceNode PbStartFragmentBackfillMutation PbStopMutation PbStreamActor PbStreamCdcScanNode PbStreamCdcScanOptions PbStreamContext PbStreamFragmentGraph PbStreamFsFetch PbStreamFsFetchNode PbStreamMessage PbStreamMessageBatch PbStreamNode PbStreamScanNode PbStreamScanType PbStreamSource PbSubscriptionUpstreamInfo PbSyncLogStoreNode PbTemporalJoinNode PbThrottleMutation PbTopNNode PbUnionNode PbUpdateMutation PbUpstreamSinkInfo PbUpstreamSinkUnionNode PbValuesNode PbVectorIndexLookupJoinNode PbVectorIndexWriteNode PbWatermark PbWatermarkFilterNode