Struct TableDesc

pub struct TableDesc {

    pub table_id: TableId,
    pub pk: Vec<ColumnOrder>,
    pub columns: Vec<ColumnDesc>,
    pub distribution_key: Vec<usize>,
    pub stream_key: Vec<usize>,
    pub vnode_col_index: Option<usize>,
    pub append_only: bool,
    pub retention_seconds: Option<u32>,
    pub value_indices: Vec<usize>,
    pub read_prefix_len_hint: usize,
    pub watermark_columns: FixedBitSet,
    pub vnode_count: usize,
    pub versioned: bool,
}

Includes necessary information for compute node to access data of the table.

It’s a subset of TableCatalog in frontend. Refer to TableCatalog for more details.

Fields

table_id: TableId

Id of the table, to find in storage.

pk: Vec<ColumnOrder>

The key used to sort in storage.

columns: Vec<ColumnDesc>

All columns in the table, noticed it is NOT sorted by columnId in the vec.

distribution_key: Vec<usize>

Distribution keys of this table, which corresponds to the corresponding column of the index. e.g., if distribution_key = [1, 2], then columns[1] and columns[2] are used as distribution key.

stream_key: Vec<usize>

Column indices for primary keys.

vnode_col_index: Option<usize>

append_only: bool

Whether the table source is append-only

retention_seconds: Option<u32>

value_indices: Vec<usize>

read_prefix_len_hint: usize

The prefix len of pk, used in bloom filter.

watermark_columns: FixedBitSet

the column indices which could receive watermarks.

vnode_count: usize

Total vnode count of the table.

versioned: bool

Whether the table is versioned. If true, column-aware row encoding will be used to be compatible with schema changes.

See version field in TableCatalog for more details.

Implementations

impl TableDesc

pub fn arrange_key_orders_protobuf(&self) -> Vec<PbColumnOrder>

pub fn order_column_indices(&self) -> Vec<usize>

pub fn order_column_ids(&self) -> Vec<ColumnId>

pub fn try_to_protobuf(&self) -> Result<StorageTableDesc>

pub fn get_id_to_op_idx_mapping(&self) -> HashMap<ColumnId, usize>

Helper function to create a mapping from column id to column index

pub fn from_pb_table(table: &Table) -> Self

Trait Implementations

impl Clone for TableDesc

fn clone(&self) -> TableDesc

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for TableDesc

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

Formats the value using the given formatter.

impl Default for TableDesc

fn default() -> TableDesc

Returns the “default value” for a type.

impl Hash for TableDesc

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 TableDesc

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

impl StructuralPartialEq for TableDesc