Struct spacetimedb_sats::db::def::IndexDef

pub struct IndexDef {
    pub index_name: String,
    pub is_unique: bool,
    pub index_type: IndexType,
    pub columns: ColList,
}

A struct representing the definition of a database index.

Fields

index_name: String

is_unique: bool

index_type: IndexType

columns: ColList

List of column positions that compose the index.

Implementations

impl IndexDef

pub fn btree( index_name: String, columns: impl Into<ColList>, is_unique: bool ) -> Self

Creates a new IndexDef with the provided parameters.

WARNING: Only [IndexType::Btree] are supported for now…

Arguments

• index_name: The name of the index.
• columns: List of column positions that compose the index.
• is_unique: Indicates whether the index enforces uniqueness.

pub fn for_column( table: &str, index_or_name: &str, columns: impl Into<ColList>, is_unique: bool ) -> Self

Creates an IndexDef of type IndexType::BTree for a specific column of a table.

This method generates an index name based on the table name, index name, column positions, and uniqueness constraint.

Example

use spacetimedb_primitives::ColList;
use spacetimedb_sats::db::def::*;

let index_def = IndexDef::for_column("my_table", "test", ColList::new(1u32.into()), true);
assert_eq!(index_def.index_name, "idx_my_table_test_unique");

Trait Implementations

impl Clone for IndexDef

fn clone(&self) -> IndexDef

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for IndexDef

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for IndexDef

fn deserialize<D: Deserializer<'de>>(deserializer: D) -> Result<Self, D::Error>

Deserialize this value from the given deserializer.

impl From<IndexSchema> for IndexDef

fn from(value: IndexSchema) -> Self

Converts to this type from the input type.

impl Ord for IndexDef

fn cmp(&self, other: &IndexDef) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized + PartialOrd,

Restrict a value to a certain interval.

impl PartialEq for IndexDef

fn eq(&self, other: &IndexDef) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for IndexDef

fn partial_cmp(&self, other: &IndexDef) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl Serialize for IndexDef

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

Serialize self in the data format of S using the provided serializer.

impl Eq for IndexDef

impl StructuralPartialEq for IndexDef