Skip to main content

TableDef

Struct TableDef 

Source
pub struct TableDef {
    pub name: String,
    pub columns: Vec<ColumnDef>,
    pub primary_key: Vec<String>,
    pub indexes: Vec<IndexDef>,
    pub constraints: Vec<Constraint>,
    pub version: u32,
    pub created_at: u64,
    pub updated_at: u64,
}
Expand description

Table definition containing all metadata.

Fields§

§name: String

Table name (unique within database).

§columns: Vec<ColumnDef>

Column definitions in order.

§primary_key: Vec<String>

Primary key column names (can be composite).

§indexes: Vec<IndexDef>

Index definitions.

§constraints: Vec<Constraint>

Table-level constraints.

§version: u32

Schema version (for migrations).

§created_at: u64

Creation timestamp.

§updated_at: u64

Last modification timestamp.

Implementations§

Source§

impl TableDef

Source

pub fn new(name: impl Into<String>) -> Self

Create a new table definition.

Source

pub fn add_column(self, column: ColumnDef) -> Self

Add a column to the table.

Source

pub fn primary_key(self, columns: Vec<String>) -> Self

Set primary key columns.

Source

pub fn add_index(self, index: IndexDef) -> Self

Add an index.

Source

pub fn add_constraint(self, constraint: Constraint) -> Self

Add a constraint.

Source

pub fn get_column(&self, name: &str) -> Option<&ColumnDef>

Get a column by name.

Source

pub fn column_index(&self, name: &str) -> Option<usize>

Get a column’s ordinal by name.

Source

pub fn is_primary_key_column(&self, name: &str) -> bool

Check whether a column is part of the primary key.

Source

pub fn validate(&self) -> Result<(), TableDefError>

Validate references within the table definition.

Trait Implementations§

Source§

impl Clone for TableDef

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for TableDef

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Display for TableDef

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Eq for TableDef

Source§

impl PartialEq for TableDef

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for TableDef

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T> ToString for T
where T: Display + ?Sized,

Source§

fn to_string(&self) -> String

Converts the given value to a String. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.