Struct StreamSink

pub struct StreamSink {
    pub base: PlanBase<Stream>,
    input: PlanRef,
    sink_desc: SinkDesc,
    log_store_type: SinkLogStoreType,
}

StreamSink represents a table/connector sink at the very end of the graph.

Fields

base: PlanBase<Stream>

input: PlanRef

sink_desc: SinkDesc

log_store_type: SinkLogStoreType

Implementations

impl StreamSink

pub fn new( input: PlanRef, sink_desc: SinkDesc, log_store_type: SinkLogStoreType, ) -> Self

pub fn sink_desc(&self) -> &SinkDesc

fn derive_iceberg_sink_distribution( input: PlanRef, partition_info: Option<PartitionComputeInfo>, columns: &[ColumnCatalog], ) -> Result<(RequiredDist, PlanRef, Option<usize>), RwError>

pub fn create( input: PlanRef, name: String, db_name: String, sink_from_table_name: String, target_table: Option<Arc<TableCatalog>>, target_table_mapping: Option<Vec<Option<usize>>>, user_distributed_by: RequiredDist, user_order_by: Order, user_cols: FixedBitSet, out_names: Vec<String>, definition: String, properties: WithOptionsSecResolved, format_desc: Option<SinkFormatDesc>, partition_info: Option<PartitionComputeInfo>, ) -> Result<Self, RwError>

fn is_user_defined_append_only( properties: &WithOptionsSecResolved, ) -> Result<bool, RwError>

fn is_user_force_append_only( properties: &WithOptionsSecResolved, ) -> Result<bool, RwError>

fn derive_sink_type( input_append_only: bool, properties: &WithOptionsSecResolved, format_desc: Option<&SinkFormatDesc>, ) -> Result<SinkType, RwError>

fn parse_downstream_pk( columns: &[ColumnCatalog], downstream_pk_str: Option<&String>, ) -> Result<Vec<usize>, RwError>

Extract user-defined downstream pk columns from with options. Return the indices of the pk columns.

The format of downstream_pk_str should be ‘col1,col2,…’ (delimited by ,) in order to get parsed.

fn infer_kv_log_store_table_catalog(&self) -> TableCatalog

The table schema is: | epoch | seq id | row op | sink columns | Pk is: | epoch | seq id |

Methods from Deref<Target = PlanBase<Stream>>

pub fn clone_with_new_plan_id(&self) -> Self

pub fn clone_with_new_distribution(&self, dist: Distribution) -> Self

Clone the plan node with a new distribution.

Panics if the plan node is not physical.

Trait Implementations

impl Clone for StreamSink

fn clone(&self) -> StreamSink

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl ColPrunable for StreamSink

fn prune_col( &self, _required_cols: &[usize], _ctx: &mut ColumnPruningContext, ) -> PlanRef

Transform the plan node to only output the required columns ordered by index number.

impl Debug for StreamSink

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Deref for StreamSink

type Target = PlanBase<Stream>

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl Distill for StreamSink

fn distill<'a>(&self) -> XmlNode<'a>

fn distill_to_string(&self) -> String

impl ExprRewritable for StreamSink

fn has_rewritable_expr(&self) -> bool

fn rewrite_exprs(&self, _r: &mut dyn ExprRewriter) -> PlanRef

impl ExprVisitable for StreamSink

fn visit_exprs(&self, _v: &mut dyn ExprVisitor)

impl Hash for StreamSink

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for StreamSink

fn eq(&self, other: &StreamSink) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PlanNodeMeta for StreamSink

const NODE_TYPE: PlanNodeType = PlanNodeType::StreamSink

type Convention = Stream

fn plan_base(&self) -> &PlanBase<Stream>

Get the reference to the PlanBase with corresponding convention.

fn plan_base_ref(&self) -> PlanBaseRef<'_>

Get the reference to the PlanBase with erased convention.

impl PlanTreeNode for StreamSink

fn clone_with_inputs(&self, inputs: &[PlanRef]) -> PlanRef

Clone the node with a list of new inputs.

fn inputs(&self) -> SmallVec<[PlanRef; 2]>

Get input nodes of the plan.

impl PlanTreeNodeUnary for StreamSink

fn input(&self) -> PlanRef

fn clone_with_input(&self, input: PlanRef) -> Self

fn rewrite_with_input( &self, _input: PlanRef, _input_col_change: ColIndexMapping, ) -> (Self, ColIndexMapping)

where Self: Sized,

Rewrites the plan node according to the schema change of its input node during rewriting.

impl PredicatePushdown for StreamSink

fn predicate_pushdown( &self, _predicate: Condition, _ctx: &mut PredicatePushdownContext, ) -> PlanRef

Push predicate down for every logical plan node.

impl StreamNode for StreamSink

fn to_stream_prost_body( &self, state: &mut BuildFragmentGraphState, ) -> PbNodeBody

impl ToBatch for StreamSink

fn to_batch(&self) -> Result<PlanRef, RwError>

to_batch is equivalent to to_batch_with_order_required(&Order::any())

fn to_batch_with_order_required( &self, required_order: &Order, ) -> Result<PlanRef, RwError>

convert the plan to batch physical plan and satisfy the required Order

impl ToDistributedBatch for StreamSink

fn to_distributed(&self) -> Result<PlanRef, RwError>

to_distributed is equivalent to to_distributed_with_required(&Order::any(), &RequiredDist::Any)

fn to_distributed_with_required( &self, required_order: &Order, required_dist: &RequiredDist, ) -> Result<PlanRef, RwError>

insert the exchange in batch physical plan to satisfy the required Distribution and Order.

impl ToLocalBatch for StreamSink

fn to_local(&self) -> Result<PlanRef, RwError>

fn to_local_with_order_required( &self, required_order: &Order, ) -> Result<PlanRef, RwError>

Convert the plan to batch local physical plan and satisfy the required Order

impl ToStream for StreamSink

fn to_stream(&self, _ctx: &mut ToStreamContext) -> Result<PlanRef, RwError>

to_stream is equivalent to to_stream_with_dist_required(RequiredDist::Any)

fn logical_rewrite_for_stream( &self, _ctx: &mut RewriteStreamContext, ) -> Result<(PlanRef, ColIndexMapping), RwError>

logical_rewrite_for_stream will rewrite the logical node, and return (new_plan_node, col_mapping), the col_mapping is for original columns have been changed into some other position.

fn to_stream_with_dist_required( &self, required_dist: &RequiredDist, ctx: &mut ToStreamContext, ) -> Result<PlanRef, RwError>

convert the plan to streaming physical plan and satisfy the required distribution

impl TryToBatchPb for StreamSink

fn try_to_batch_prost_body(&self) -> Result<NodeBody, SchedulerError>

impl Eq for StreamSink

impl PlanNode for StreamSink

impl StructuralPartialEq for StreamSink

impl ToPb for StreamSink