Struct StreamCdcScanNode

pub struct StreamCdcScanNode {
    pub table_id: u32,
    pub upstream_column_ids: Vec<i32>,
    pub output_indices: Vec<u32>,
    pub state_table: Option<Table>,
    pub cdc_table_desc: Option<ExternalTableDesc>,
    pub rate_limit: Option<u32>,
    pub disable_backfill: bool,
    pub options: Option<StreamCdcScanOptions>,
}

Fields

table_id: u32

upstream_column_ids: Vec<i32>

The columns from the upstream table that’ll be internally required by this stream scan node. Contains Primary Keys and Output columns.

output_indices: Vec<u32>

Strips the primary key columns if they’re unnecessary.

state_table: Option<Table>

The state table used by CdcBackfill operator for persisting internal state

cdc_table_desc: Option<ExternalTableDesc>

The external table that will be backfilled for CDC.

rate_limit: Option<u32>

The backfill rate limit for the stream cdc scan node.

disable_backfill: bool

Whether skip the backfill and only consume from upstream. keep it for backward compatibility, new stream plan will use options.disable_backfill

options: Option<StreamCdcScanOptions>

Implementations

impl StreamCdcScanNode

pub fn rate_limit(&self) -> u32

Returns the value of rate_limit, or the default value if rate_limit is unset.

impl StreamCdcScanNode

pub fn get_table_id(&self) -> u32

pub fn get_upstream_column_ids(&self) -> &Vec<i32>

pub fn get_output_indices(&self) -> &Vec<u32>

pub fn get_state_table(&self) -> Result<&Table, PbFieldNotFound>

pub fn get_cdc_table_desc(&self) -> Result<&ExternalTableDesc, PbFieldNotFound>

pub fn get_rate_limit(&self) -> Result<&u32, PbFieldNotFound>

pub fn get_disable_backfill(&self) -> bool

pub fn get_options(&self) -> Result<&StreamCdcScanOptions, PbFieldNotFound>

Trait Implementations

impl Clone for StreamCdcScanNode

fn clone(&self) -> StreamCdcScanNode

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for StreamCdcScanNode

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

Formats the value using the given formatter.

impl Default for StreamCdcScanNode

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for StreamCdcScanNode

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Message for StreamCdcScanNode

fn encoded_len(&self) -> usize

Returns the encoded length of the message without a length delimiter.

fn clear(&mut self)

Clears the message, resetting all fields to their default.

fn encode(&self, buf: &mut impl BufMut) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message to a buffer.

fn encode_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message to a newly allocated buffer.

fn encode_length_delimited( &self, buf: &mut impl BufMut, ) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message with a length-delimiter to a buffer.

fn encode_length_delimited_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message with a length-delimiter to a newly allocated buffer.

fn decode(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes an instance of the message from a buffer.

fn decode_length_delimited(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes a length-delimited instance of the message from the buffer.

fn merge(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes an instance of the message from a buffer, and merges it into self.

fn merge_length_delimited(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes a length-delimited instance of the message from buffer, and merges it into self.

impl PartialEq for StreamCdcScanNode

fn eq(&self, other: &StreamCdcScanNode) -> 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 Serialize for StreamCdcScanNode

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>

where S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for StreamCdcScanNode