Skip to main content

TableDef

Struct TableDef 

Source
pub struct TableDef {
    pub table_id: TableId,
    pub columns: Vec<ColumnDef>,
    pub primary_key: Vec<ColumnName>,
    pub indexes: Vec<IndexDef>,
}
Expand description

Definition of a table in the schema.

Fields§

§table_id: TableId

Underlying store table ID.

§columns: Vec<ColumnDef>

Column definitions in order.

§primary_key: Vec<ColumnName>

Primary key column names (in order).

§indexes: Vec<IndexDef>

Secondary indexes on this table.

Implementations§

Source§

impl TableDef

Source

pub fn new( table_id: TableId, columns: Vec<ColumnDef>, primary_key: Vec<ColumnName>, ) -> Self

Creates a new table definition.

Source

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

Adds an index to this table definition.

Source

pub fn indexes(&self) -> &[IndexDef]

Returns all indexes for this table.

Source

pub fn find_index_for_column(&self, column: &ColumnName) -> Option<&IndexDef>

Finds an index that can be used for the given column.

Source

pub fn find_column(&self, name: &ColumnName) -> Option<(usize, &ColumnDef)>

Finds a column by name.

Source

pub fn is_primary_key(&self, name: &ColumnName) -> bool

Returns true if the given column is part of the primary key.

Source

pub fn primary_key_position(&self, name: &ColumnName) -> Option<usize>

Returns the index of a column in the primary key.

Source

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

Returns the column indices that form the primary key.

Trait Implementations§

Source§

impl Clone for TableDef

Source§

fn clone(&self) -> TableDef

Returns a duplicate of the value. Read more
1.0.0 · 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 PartialEq for TableDef

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl Eq for TableDef

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> Same for T

Source§

type Output = T

Should always be Self
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, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

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

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

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.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V