Struct IndexEntity

pub struct IndexEntity {
    pub custom_features: Option<HashMap<String, Value>>,
    pub name: Option<String>,
    pub table_columns: Option<Vec<String>>,
    pub table_columns_descending: Option<Vec<bool>>,
    pub type_: Option<String>,
    pub unique: Option<bool>,
}

Index is not used as an independent entity, it is retrieved as part of a Table entity.

This type is not used in any activity, and only used as part of another schema.

Fields

custom_features: Option<HashMap<String, Value>>

Custom engine specific features.

name: Option<String>

The name of the index.

table_columns: Option<Vec<String>>

Table columns used as part of the Index, for example B-TREE index should list the columns which constitutes the index.

table_columns_descending: Option<Vec<bool>>

For each table_column, mark whether it’s sorting order is ascending (false) or descending (true). If no value is defined, assume all columns are sorted in ascending order. Otherwise, the number of items must match that of table_columns with each value specifying the direction of the matched column by its index.

type_: Option<String>

Type of index, for example B-TREE.

unique: Option<bool>

Boolean value indicating whether the index is unique.

Trait Implementations

impl Clone for IndexEntity

fn clone(&self) -> IndexEntity

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for IndexEntity

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

Formats the value using the given formatter.

impl Default for IndexEntity

fn default() -> IndexEntity

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for IndexEntity

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for IndexEntity

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Part for IndexEntity