Struct IndexCatalog

pub struct IndexCatalog {

    pub id: IndexId,
    pub name: String,
    pub index_item: Vec<ExprImpl>,
    pub index_column_properties: Vec<PbIndexColumnProperties>,
    pub index_table: Arc<TableCatalog>,
    pub primary_table: Arc<TableCatalog>,
    pub primary_to_secondary_mapping: BTreeMap<usize, usize>,
    pub secondary_to_primary_mapping: BTreeMap<usize, usize>,
    pub function_mapping: HashMap<FunctionCall, usize>,
    pub index_columns_len: u32,
    pub created_at_epoch: Option<Epoch>,
    pub initialized_at_epoch: Option<Epoch>,
    pub created_at_cluster_version: Option<String>,
    pub initialized_at_cluster_version: Option<String>,
}

Fields

id: IndexId

name: String

index_item: Vec<ExprImpl>

Only InputRef and FuncCall type index is supported Now. The index of InputRef is the column index of the primary table. The index_item size is equal to the index table columns size The input args of FuncCall is also the column index of the primary table.

index_column_properties: Vec<PbIndexColumnProperties>

The properties of the index columns. https://www.postgresql.org/docs/current/functions-info.html#FUNCTIONS-INFO-INDEX-COLUMN-PROPS

index_table: Arc<TableCatalog>

primary_table: Arc<TableCatalog>

primary_to_secondary_mapping: BTreeMap<usize, usize>

secondary_to_primary_mapping: BTreeMap<usize, usize>

function_mapping: HashMap<FunctionCall, usize>

Map function call from the primary table to the index table. Use HashMap instead of BTreeMap, because FunctionCall can’t be used as the key for BTreeMap. BTW, the trait std::hash::Hash is not implemented for HashMap<function_call::FunctionCall, usize>, so we need to ignore it. It will not affect the correctness, since it can be derived by index_item.

index_columns_len: u32

created_at_epoch: Option<Epoch>

initialized_at_epoch: Option<Epoch>

created_at_cluster_version: Option<String>

initialized_at_cluster_version: Option<String>

Implementations

impl IndexCatalog

pub fn build_from( index_prost: &PbIndex, index_table: &TableCatalog, primary_table: &TableCatalog, ) -> Self

pub fn primary_table_pk_ref_to_index_table(&self) -> Vec<ColumnOrder>

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

pub fn full_covering(&self) -> bool

pub fn secondary_to_primary_mapping(&self) -> &BTreeMap<usize, usize>

A mapping maps the column index of the secondary index to the column index of the primary table.

pub fn primary_to_secondary_mapping(&self) -> &BTreeMap<usize, usize>

A mapping maps the column index of the primary table to the column index of the secondary index.

pub fn function_mapping(&self) -> &HashMap<FunctionCall, usize>

pub fn to_prost(&self, schema_id: u32, database_id: u32) -> PbIndex

pub fn get_column_properties( &self, column_idx: usize, ) -> Option<PbIndexColumnProperties>

Get the column properties of the index column.

pub fn get_column_def(&self, column_idx: usize) -> Option<String>

pub fn display(&self) -> IndexDisplay

Trait Implementations

impl Clone for IndexCatalog

fn clone(&self) -> IndexCatalog

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for IndexCatalog

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

Formats the value using the given formatter.

impl Hash for IndexCatalog

where IndexId: Hash, String: Hash, Vec<ExprImpl>: Hash, Vec<PbIndexColumnProperties>: Hash, Arc<TableCatalog>: Hash, BTreeMap<usize, usize>: Hash, u32: Hash, Option<Epoch>: Hash, Option<String>: Hash,

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 OwnedByUserCatalog for IndexCatalog

fn owner(&self) -> u32

Returns the owner of the catalog.

impl PartialEq for IndexCatalog

where IndexId: PartialEq, String: PartialEq, Vec<ExprImpl>: PartialEq, Vec<PbIndexColumnProperties>: PartialEq, Arc<TableCatalog>: PartialEq, BTreeMap<usize, usize>: PartialEq, u32: PartialEq, Option<Epoch>: PartialEq, Option<String>: PartialEq,

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

where IndexId: PartialEq, String: PartialEq, Vec<ExprImpl>: PartialEq, Vec<PbIndexColumnProperties>: PartialEq, Arc<TableCatalog>: PartialEq, BTreeMap<usize, usize>: PartialEq, u32: PartialEq, Option<Epoch>: PartialEq, Option<String>: PartialEq,