Struct spacetimedb_sats::db::def::TableDef

pub struct TableDef {
    pub table_name: String,
    pub columns: Vec<ColumnDef>,
    pub indexes: Vec<IndexDef>,
    pub constraints: Vec<ConstraintDef>,
    pub sequences: Vec<SequenceDef>,
    pub table_type: StTableType,
    pub table_access: StAccess,
}

A data structure representing the definition of a database table.

This struct holds information about the table, including its name, columns, indexes, constraints, sequences, type, and access rights.

Fields

table_name: String

columns: Vec<ColumnDef>

indexes: Vec<IndexDef>

constraints: Vec<ConstraintDef>

sequences: Vec<SequenceDef>

table_type: StTableType

table_access: StAccess

Implementations

impl TableDef

pub fn new(table_name: String, columns: Vec<ColumnDef>) -> Self

Create a new TableDef instance with the specified table_name and columns.

Parameters

• table_name: The name of the table.
• columns: A vec of ColumnDef instances representing the columns of the table.

pub fn with_type(self, table_type: StTableType) -> Self

Set the type of the table and return a new TableDef instance with the updated type.

pub fn with_access(self, table_access: StAccess) -> Self

Set the access rights for the table and return a new TableDef instance with the updated access rights.

pub fn with_constraints(self, constraints: Vec<ConstraintDef>) -> Self

Set the constraints for the table and return a new TableDef instance with the updated constraints.

pub fn with_column_constraint( self, kind: Constraints, columns: impl Into<ColList> ) -> Self

Generate a ConstraintDef using the supplied columns.

pub fn with_indexes(self, indexes: Vec<IndexDef>) -> Self

Set the indexes for the table and return a new TableDef instance with the updated indexes.

pub fn with_column_index( self, columns: impl Into<ColList>, is_unique: bool ) -> Self

Generate a IndexDef using the supplied columns.

pub fn with_sequences(self, sequences: Vec<SequenceDef>) -> Self

Set the sequences for the table and return a new TableDef instance with the updated sequences.

pub fn with_column_sequence(self, columns: ColId) -> Self

Generate a SequenceDef using the supplied columns.

pub fn from_product(table_name: &str, row: ProductType) -> Self

Create a TableDef from a product type and table name.

NOTE: If the [ProductType.name] is None then it auto-generate a name like col_{col_pos}

pub fn generated_indexes(&self) -> impl Iterator<Item = IndexDef> + '_

Get an iterator deriving IndexDef from the constraints that require them like UNIQUE.

It looks into Self::constraints for possible duplicates and remove them from the result

pub fn generated_sequences(&self) -> impl Iterator<Item = SequenceDef> + '_

Get an iterator deriving SequenceDef from the constraints that require them like IDENTITY.

It looks into Self::constraints for possible duplicates and remove them from the result

pub fn generated_constraints(&self) -> impl Iterator<Item = ConstraintDef> + '_

Get an iterator deriving ConstraintDef from the indexes that require them like UNIQUE.

It looks into Self::constraints for possible duplicates and remove them from the result

pub fn into_schema(self, table_id: TableId) -> TableSchema

Create a new TableSchema from Self and a table id.

pub fn get_column_by_field(&self, field: &FieldName) -> Option<&ColumnDef>

Check if the name of the FieldName exist on this TableDef

Warning: It ignores the table_name

pub fn get_column(&self, pos: usize) -> Option<&ColumnDef>

pub fn get_column_by_name(&self, col_name: &str) -> Option<&ColumnDef>

Check if the col_name exist on this TableSchema

Warning: It ignores the table_name

Trait Implementations

impl Clone for TableDef

fn clone(&self) -> TableDef

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for TableDef

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for TableDef

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

Deserialize this value from the given deserializer.

impl From<TableSchema> for TableDef

fn from(value: TableSchema) -> Self

Converts to this type from the input type.

impl Ord for TableDef

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

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

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

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 TableDef

impl StructuralPartialEq for TableDef