Struct ColumnDesc 

pub struct ColumnDesc {
    pub data_type: DataType,
    pub column_id: ColumnId,
    pub name: String,
    pub generated_or_default_column: Option<GeneratedOrDefaultColumn>,
    pub description: Option<String>,
    pub additional_column: AdditionalColumn,
    pub version: ColumnDescVersion,
    pub system_column: Option<SystemColumn>,
    pub nullable: bool,
}

Fields

data_type: DataType

column_id: ColumnId

name: String

generated_or_default_column: Option<GeneratedOrDefaultColumn>

description: Option<String>

additional_column: AdditionalColumn

version: ColumnDescVersion

system_column: Option<SystemColumn>

Currently the system column is used for _rw_timestamp only and is generated at runtime, so this field is not persisted.

nullable: bool

Whether the column is nullable. If a column is not nullable, BatchInsert/BatchUpdate operations will throw an error when NULL is inserted/updated into. The row contains NULL for this column will be ignored when streaming data into the table.

Implementations

impl ColumnDesc

pub fn unnamed(column_id: ColumnId, data_type: DataType) -> ColumnDesc

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

pub fn named_with_default_value( name: impl Into<String>, column_id: ColumnId, data_type: DataType, snapshot_value: Datum, ) -> ColumnDesc

pub fn named_with_additional_column( name: impl Into<String>, column_id: ColumnId, data_type: DataType, additional_column_type: AdditionalColumn, ) -> ColumnDesc

pub fn named_with_system_column( name: impl Into<String>, column_id: ColumnId, data_type: DataType, system_column: SystemColumn, ) -> ColumnDesc

pub fn to_protobuf(&self) -> PbColumnDesc

Convert to proto

pub fn from_field_with_column_id(field: &Field, id: i32) -> Self

pub fn from_field_without_column_id(field: &Field) -> Self

pub fn is_generated(&self) -> bool

pub fn get_id_to_op_idx_mapping( columns: &[impl AsRef<Self>], output_col_ids: Option<&[usize]>, ) -> HashMap<ColumnId, usize>

fn get_id_to_op_idx_mapping_inner( columns: &[impl AsRef<Self>], output_col_ids: impl Iterator<Item = usize>, ) -> HashMap<ColumnId, usize>

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 AsRef<ColumnDesc> for ColumnDesc

fn as_ref(&self) -> &ColumnDesc

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

impl Clone for ColumnDesc

fn clone(&self) -> ColumnDesc

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ColumnDesc

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

Formats the value using the given formatter.

impl FieldLike for ColumnDesc

fn data_type(&self) -> &DataType

fn name(&self) -> &str

impl From<&ColumnDesc> for ColumnDesc

fn from(prost: &PbColumnDesc) -> Self

Converts to this type from the input type.

impl From<&ColumnDesc> for PbColumnDesc

fn from(c: &ColumnDesc) -> Self

Converts to this type from the input type.

impl From<&ColumnDesc> for Field

fn from(desc: &ColumnDesc) -> Self

Converts to this type from the input type.

impl From<ColumnDesc> for ColumnDesc

fn from(prost: PbColumnDesc) -> Self

Converts to this type from the input type.

impl From<ColumnDesc> for Field

fn from(column_desc: ColumnDesc) -> Self

Converts to this type from the input type.

impl Hash for ColumnDesc

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 ColumnDesc

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

impl StructuralPartialEq for ColumnDesc