Struct barrel::table::Table

pub struct Table {
    pub meta: TableMeta,
    // some fields omitted
}

Fields

meta: TableMeta

Implementations

impl Table

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

pub fn add_column<S: Into<String>>(&mut self, name: S, _type: Type) -> &mut Type

Add a new column to a table

table.add_column("id", types::primary());
table.add_column("name", types::varchar(64));

pub fn drop_column<S: Into<String>>(&mut self, name: S)

pub fn rename_column<S: Into<String>>(&mut self, old: S, new: S)

pub fn inject_custom<S: Into<String>>(&mut self, sql: S)

Inject a line of custom SQL into the table block

This is a bypass to the barrel typesystem, in case there is something your database supports that barrel doesn’t, or if there is an issue with the way that barrel represents types. It does however mean that the SQL provided needs to be specific for one database, meaning that future migrations might become cumbersome.

pub fn add_index<S: Into<String>>(&mut self, name: S, columns: Type)

Add a new index to a table, spanning over multiple columns

pub fn add_constraint<S: Into<String>>(&mut self, name: S, columns: Type)

pub fn add_partial_index<S: Into<String>>(
    &mut self,
    name: S,
    columns: Type,
    conditions: S
)

pub fn drop_index<S: Into<String>>(&mut self, name: S)

Drop an index on this table

pub fn add_foreign_key(
    &mut self,
    columns_on_this_side: &[&str],
    related_table: &str,
    columns_on_that_side: &[&str]
)

pub fn set_primary_key(&mut self, columns: &[&str])

pub fn make<T: SqlGenerator>(
    &mut self,
    ex: bool,
    schema: Option<&str>
) -> SqlChanges

Generate Sql for this table.

Trait Implementations

impl Clone for Table

fn clone(&self) -> Table

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Table

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

Formats the value using the given formatter.