Struct ColumnCatalog 

pub struct ColumnCatalog {
    pub column_desc: ColumnDesc,
    pub is_hidden: bool,
}

Fields

column_desc: ColumnDesc

is_hidden: bool

Implementations

impl ColumnCatalog

pub fn visible(column_desc: ColumnDesc) -> Self

pub fn hidden(column_desc: ColumnDesc) -> Self

pub fn is_hidden(&self) -> bool

Get the column catalog’s is hidden.

pub fn is_generated(&self) -> bool

If the column is a generated column

pub fn can_dml(&self) -> bool

pub fn is_defined_in_columns_clause(&self) -> bool

Returns whether the column is defined by user within the column definition clause in the CREATE TABLE statement.

pub fn generated_expr(&self) -> Option<&ExprNode>

If the column is a generated column

pub fn is_connector_additional_column(&self) -> bool

If the columns is an INCLUDE ... AS ... connector column.

pub fn data_type(&self) -> &DataType

Get a reference to the column desc’s data type.

pub fn nullable(&self) -> bool

Get nullable info of the column.

pub fn column_id(&self) -> ColumnId

Get the column desc’s column id.

pub fn name(&self) -> &str

Get a reference to the column desc’s name.

pub fn to_protobuf(&self) -> PbColumnCatalog

Convert column catalog to proto

pub fn row_id_column() -> Self

Creates a row ID column (for implicit primary key). It’ll always have the ID 0.

pub fn is_rw_sys_column(&self) -> bool

pub fn rw_timestamp_column() -> Self

pub fn is_rw_timestamp_column(&self) -> bool

pub fn iceberg_hidden_cols() -> [Self; 3]

pub fn debezium_cdc_source_cols() -> [Self; 3]

Note: these columns are added in SourceStreamChunkRowWriter::do_action. May also look for the usage of SourceColumnType.

pub fn is_row_id_column(&self) -> bool

pub fn is_iceberg_hidden_column(&self) -> bool

impl ColumnCatalog

pub fn name_with_hidden(&self) -> Cow<'_, str>

Methods from Deref<Target = ColumnDesc>

pub fn to_protobuf(&self) -> PbColumnDesc

Convert to proto

pub fn is_generated(&self) -> bool

Trait Implementations

impl AsRef<ColumnDesc> for ColumnCatalog

fn as_ref(&self) -> &ColumnDesc

Converts this type into a shared reference of the (usually inferred) input type.

impl Clone for ColumnCatalog

fn clone(&self) -> ColumnCatalog

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ColumnCatalog

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

Formats the value using the given formatter.

impl Deref for ColumnCatalog

type Target = ColumnDesc

The resulting type after dereferencing.

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

Dereferences the value.

impl FieldLike for ColumnCatalog

fn data_type(&self) -> &DataType

fn name(&self) -> &str

impl From<ColumnCatalog> for ColumnCatalog

fn from(prost: PbColumnCatalog) -> Self

Converts to this type from the input type.

impl Hash for ColumnCatalog

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 ColumnCatalog

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

impl StructuralPartialEq for ColumnCatalog