Struct TableMeta

pub struct TableMeta {
    pub schema: SchemaRef,
    pub primary_key_indices: Vec<usize>,
    pub value_indices: Vec<usize>,
    pub engine: String,
    pub region_numbers: Vec<u32>,
    pub next_column_id: ColumnId,
    pub options: TableOptions,
    pub created_on: DateTime<Utc>,
    pub partition_key_indices: Vec<usize>,
}

The table metadata.

Note: if you add new fields to this struct, please ensure ‘new_meta_builder’ function works. TODO(dennis): find a better way to ensure ‘new_meta_builder’ works when adding new fields.

Fields

schema: SchemaRef

primary_key_indices: Vec<usize>

The indices of columns in primary key. Note that the index of timestamp column is not included in these indices.

value_indices: Vec<usize>

engine: String

region_numbers: Vec<u32>

next_column_id: ColumnId

options: TableOptions

Table options.

created_on: DateTime<Utc>

partition_key_indices: Vec<usize>

Implementations

impl TableMeta

pub fn row_key_column_names(&self) -> impl Iterator<Item = &String>

pub fn field_column_names(&self) -> impl Iterator<Item = &String>

pub fn builder_with_alter_kind( &self, table_name: &str, alter_kind: &AlterKind, add_if_not_exists: bool, ) -> Result<TableMetaBuilder>

Returns the new TableMetaBuilder after applying given alter_kind.

The returned builder would derive the next column id of this meta.

fn change_table_options( &self, requests: &[ChangeOption], ) -> Result<TableMetaBuilder>

Creates a TableMetaBuilder with modified table options.

fn change_column_fulltext_options( &self, table_name: &str, column_name: &str, options: &FulltextOptions, ) -> Result<TableMetaBuilder>

Creates a TableMetaBuilder with modified column fulltext options.

pub fn alloc_new_column( &mut self, table_name: &str, new_column: &ColumnSchema, ) -> Result<ColumnDescriptor>

Allocate a new column for the table.

This method would bump the next_column_id of the meta.

fn new_meta_builder(&self) -> TableMetaBuilder

Create a TableMetaBuilder.

Note: please always use this function to create the builder.

fn add_columns( &self, table_name: &str, requests: &[AddColumnRequest], add_if_not_exists: bool, ) -> Result<TableMetaBuilder>

fn remove_columns( &self, table_name: &str, column_names: &[String], ) -> Result<TableMetaBuilder>

fn change_column_types( &self, table_name: &str, requests: &[ChangeColumnTypeRequest], ) -> Result<TableMetaBuilder>

fn split_requests_by_column_location<'a>( &self, table_name: &str, requests: &'a [AddColumnRequest], ) -> Result<SplitResult<'a>>

Split requests into different groups using column location info.

Trait Implementations

impl Clone for TableMeta

fn clone(&self) -> TableMeta

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for TableMeta

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

Formats the value using the given formatter.

impl From<TableMeta> for RawTableMeta

fn from(meta: TableMeta) -> RawTableMeta

Converts to this type from the input type.

impl PartialEq for TableMeta

fn eq(&self, other: &TableMeta) -> 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 TryFrom<RawTableMeta> for TableMeta

type Error = Error

The type returned in the event of a conversion error.

fn try_from(raw: RawTableMeta) -> ConvertResult<TableMeta>

Performs the conversion.

impl Eq for TableMeta

impl StructuralPartialEq for TableMeta