Struct SinkDesc

pub struct SinkDesc {

    pub id: u32,
    pub name: String,
    pub definition: String,
    pub plan_pk: Vec<ColumnOrder>,
    pub downstream_pk: Vec<u32>,
    pub distribution_key: Vec<u32>,
    pub properties: BTreeMap<String, String>,
    pub sink_type: i32,
    pub column_catalogs: Vec<ColumnCatalog>,
    pub db_name: String,
    pub sink_from_name: String,
    pub format_desc: Option<SinkFormatDesc>,
    pub target_table: Option<u32>,
    pub extra_partition_col_idx: Option<u64>,
    pub secret_refs: BTreeMap<String, SecretRef>,
}

Fields

id: u32

name: String

definition: String

plan_pk: Vec<ColumnOrder>

downstream_pk: Vec<u32>

distribution_key: Vec<u32>

properties: BTreeMap<String, String>

sink_type: i32

to be deprecated

column_catalogs: Vec<ColumnCatalog>

db_name: String

sink_from_name: String

If the sink is from table or mv, this is name of the table/mv. Otherwise it is the name of the sink itself.

format_desc: Option<SinkFormatDesc>

target_table: Option<u32>

extra_partition_col_idx: Option<u64>

secret_refs: BTreeMap<String, SecretRef>

Implementations

impl SinkDesc

pub fn sink_type(&self) -> SinkType

Returns the enum value of sink_type, or the default if the field is set to an invalid enum value.

pub fn set_sink_type(&mut self, value: SinkType)

Sets sink_type to the provided enum value.

pub fn target_table(&self) -> u32

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

pub fn extra_partition_col_idx(&self) -> u64

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

impl SinkDesc

pub fn get_id(&self) -> u32

pub fn get_name(&self) -> &String

pub fn get_definition(&self) -> &String

pub fn get_plan_pk(&self) -> &Vec<ColumnOrder>

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

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

pub fn get_properties(&self) -> &BTreeMap<String, String>

pub fn get_sink_type(&self) -> Result<SinkType, PbFieldNotFound>

pub fn get_column_catalogs(&self) -> &Vec<ColumnCatalog>

pub fn get_db_name(&self) -> &String

pub fn get_sink_from_name(&self) -> &String

pub fn get_format_desc(&self) -> Result<&SinkFormatDesc, PbFieldNotFound>

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

pub fn get_extra_partition_col_idx(&self) -> Result<&u64, PbFieldNotFound>

pub fn get_secret_refs(&self) -> &BTreeMap<String, SecretRef>

Trait Implementations

impl Clone for SinkDesc

fn clone(&self) -> SinkDesc

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for SinkDesc

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

Formats the value using the given formatter.

impl Default for SinkDesc

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for SinkDesc

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

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Message for SinkDesc

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 SinkDesc

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

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 SinkDesc