Struct SourceColumnDesc

pub struct SourceColumnDesc {
    pub name: String,
    pub data_type: DataType,
    pub column_id: ColumnId,
    pub fields: Vec<ColumnDesc>,
    pub additional_column: AdditionalColumn,
    pub column_type: SourceColumnType,
    pub is_pk: bool,
    pub is_hidden_addition_col: bool,
}

SourceColumnDesc is used to describe a column in the Source.

See the implementation of From<&ColumnDesc> for the difference between SourceColumnDesc and ColumnDesc.

Fields

name: String

data_type: DataType

column_id: ColumnId

fields: Vec<ColumnDesc>

additional_column: AdditionalColumn

additional_column and column_type are orthogonal additional_column is used to indicate the column is from which part of the message column_type is used to indicate the type of the column, only used in cdc scenario

column_type: SourceColumnType

is_pk: bool

is_pk is used to indicate whether the column is part of the primary key columns.

is_hidden_addition_col: bool

is_hidden_addition_col is used to indicate whether the column is a hidden addition column.

Implementations

impl SourceColumnDesc

pub fn simple( name: impl Into<String>, data_type: DataType, column_id: ColumnId, ) -> Self

Create a SourceColumnDesc without composite types.

pub fn hidden_addition_col_from_column_desc(c: &ColumnDesc) -> Self

pub fn is_row_id(&self) -> bool

pub fn is_meta(&self) -> bool

pub fn is_offset(&self) -> bool

pub fn is_visible(&self) -> bool

Trait Implementations

impl Clone for SourceColumnDesc

fn clone(&self) -> SourceColumnDesc

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for SourceColumnDesc

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

Formats the value using the given formatter.

impl From<&ColumnDesc> for SourceColumnDesc

fn from(_: &ColumnDesc) -> Self

Converts to this type from the input type.

impl From<&SourceColumnDesc> for ColumnDesc

fn from(_: &SourceColumnDesc) -> Self

Converts to this type from the input type.