Struct TableCatalogBuilder

pub struct TableCatalogBuilder {
    columns: Vec<ColumnCatalog>,
    pk: Vec<ColumnOrder>,
    value_indices: Option<Vec<usize>>,
    vnode_col_idx: Option<usize>,
    column_names: HashMap<String, i32>,
    watermark_columns: Option<FixedBitSet>,
    dist_key_in_pk: Option<Vec<usize>>,
}

Fields

columns: Vec<ColumnCatalog>

All columns in this table

pk: Vec<ColumnOrder>

value_indices: Option<Vec<usize>>

vnode_col_idx: Option<usize>

column_names: HashMap<String, i32>

watermark_columns: Option<FixedBitSet>

dist_key_in_pk: Option<Vec<usize>>

Implementations

impl TableCatalogBuilder

For DRY, mainly used for construct internal table catalog in stateful streaming executors. Be careful of the order of add column.

pub fn add_column(&mut self, field: &Field) -> usize

Add a column from Field info, return the column index of the table

pub fn extend_columns(&mut self, columns: &[ColumnCatalog]) -> Vec<usize>

Extend the columns with column ids reset. The input columns should NOT have duplicate names.

Returns the indices of the extended columns.

pub fn add_order_column(&mut self, column_index: usize, order_type: OrderType)

Check whether need to add a ordered column. Different from value, order desc equal pk in semantics and they are encoded as storage key.

pub fn get_current_pk_len(&self) -> usize

get the current exist field number of the primary key.

pub fn set_vnode_col_idx(&mut self, vnode_col_idx: usize)

pub fn set_value_indices(&mut self, value_indices: Vec<usize>)

pub fn set_dist_key_in_pk(&mut self, dist_key_in_pk: Vec<usize>)

fn avoid_duplicate_col_name(&mut self, column_desc: &mut ColumnDesc)

Check the column name whether exist before. if true, record occurrence and change the name to avoid duplicate.

pub fn build( self, distribution_key: Vec<usize>, read_prefix_len_hint: usize, ) -> TableCatalog

Consume builder and create TableCatalog (for proto). The read_prefix_len_hint is the anticipated read prefix pattern (number of fields) for the table, which can be utilized for implementing the table’s bloom filter or other storage optimization techniques.

pub fn columns(&self) -> &[ColumnCatalog]

Trait Implementations

impl Default for TableCatalogBuilder

fn default() -> TableCatalogBuilder

Returns the “default value” for a type.