Struct Table

pub struct Table<'a> {
    pub typ: TableType<'a>,
    pub alias: Option<Cow<'a, str>>,
    pub database: Option<Cow<'a, str>>,
    /* private fields */
}

A table definition

Fields

typ: TableType<'a>

alias: Option<Cow<'a, str>>

database: Option<Cow<'a, str>>

Implementations

impl<'a> Table<'a>

pub fn database<T>(self, database: T) -> Self

where T: Into<Cow<'a, str>>,

Define in which database the table is located

pub fn asterisk(self) -> Expression<'a>

A qualified asterisk to this table

pub fn add_unique_index(self, i: impl Into<IndexDefinition<'a>>) -> Self

Add unique index definition.

pub fn left_join<J>(self, join: J) -> Self

where J: Into<JoinData<'a>>,

Adds a LEFT JOIN clause to the query, specifically for that table. Useful to positionally add a JOIN clause in case you are selecting from multiple tables.

let join = "posts".alias("p").on(("p", "visible").equals(true));
let joined_table = Table::from("users").left_join(join);
let query = Select::from_table(joined_table).and_from("comments");
let (sql, params) = Sqlite::build(query)?;

assert_eq!(
    "SELECT `users`.*, `comments`.* FROM \
    `users` LEFT JOIN `posts` AS `p` ON `p`.`visible` = ?, \
    `comments`",
    sql
);

assert_eq!(
    vec![
        Value::from(true),
    ],
    params
);

pub fn inner_join<J>(self, join: J) -> Self

where J: Into<JoinData<'a>>,

Adds an INNER JOIN clause to the query, specifically for that table. Useful to positionally add a JOIN clause in case you are selecting from multiple tables.

let join = "posts".alias("p").on(("p", "visible").equals(true));
let joined_table = Table::from("users").inner_join(join);
let query = Select::from_table(joined_table).and_from("comments");
let (sql, params) = Sqlite::build(query)?;

assert_eq!(
    "SELECT `users`.*, `comments`.* FROM \
    `users` INNER JOIN `posts` AS `p` ON `p`.`visible` = ?, \
    `comments`",
    sql
);

assert_eq!(
    vec![
        Value::from(true),
    ],
    params
);

pub fn right_join<J>(self, join: J) -> Self

where J: Into<JoinData<'a>>,

Adds a RIGHT JOIN clause to the query, specifically for that table. Useful to positionally add a JOIN clause in case you are selecting from multiple tables.

let join = "posts".alias("p").on(("p", "visible").equals(true));
let joined_table = Table::from("users").right_join(join);
let query = Select::from_table(joined_table).and_from("comments");
let (sql, params) = Sqlite::build(query)?;

assert_eq!(
    "SELECT `users`.*, `comments`.* FROM \
    `users` RIGHT JOIN `posts` AS `p` ON `p`.`visible` = ?, \
    `comments`",
    sql
);

assert_eq!(
    vec![
        Value::from(true),
    ],
    params
);

pub fn full_join<J>(self, join: J) -> Self

where J: Into<JoinData<'a>>,

Adds a FULL JOIN clause to the query, specifically for that table. Useful to positionally add a JOIN clause in case you are selecting from multiple tables.

let join = "posts".alias("p").on(("p", "visible").equals(true));
let joined_table = Table::from("users").full_join(join);
let query = Select::from_table(joined_table).and_from("comments");
let (sql, params) = Sqlite::build(query)?;

assert_eq!(
    "SELECT `users`.*, `comments`.* FROM \
    `users` FULL JOIN `posts` AS `p` ON `p`.`visible` = ?, \
    `comments`",
    sql
);

assert_eq!(
    vec![
        Value::from(true),
    ],
    params
);

Trait Implementations

impl<'a> Aliasable<'a> for Table<'a>

type Target = Table<'a>

fn alias<T>(self, alias: T) -> Self::Target

where T: Into<Cow<'a, str>>,

Alias table for usage elsewhere in the query.

impl<'a> Clone for Table<'a>

fn clone(&self) -> Table<'a>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for Table<'a>

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

Formats the value using the given formatter.

impl<'a> From<&'a String> for Table<'a>

fn from(s: &'a String) -> Table<'a>

Converts to this type from the input type.

impl<'a> From<&'a str> for Table<'a>

fn from(s: &'a str) -> Table<'a>

Converts to this type from the input type.

impl<'a> From<(&'a String, &'a String)> for Table<'a>

fn from(s: (&'a String, &'a String)) -> Table<'a>

Converts to this type from the input type.

impl<'a> From<(&'a String, &'a str)> for Table<'a>

fn from(s: (&'a String, &'a str)) -> Table<'a>

Converts to this type from the input type.

impl<'a> From<(&'a str, &'a String)> for Table<'a>

fn from(s: (&'a str, &'a String)) -> Table<'a>

Converts to this type from the input type.

impl<'a> From<(&'a str, &'a str)> for Table<'a>

fn from(s: (&'a str, &'a str)) -> Table<'a>

Converts to this type from the input type.

impl<'a> From<(String, String)> for Table<'a>

fn from(s: (String, String)) -> Table<'a>

Converts to this type from the input type.

impl<'a> From<Select<'a>> for Table<'a>

fn from(select: Select<'a>) -> Self

Converts to this type from the input type.

impl<'a> From<String> for Table<'a>

fn from(s: String) -> Self

Converts to this type from the input type.

impl<'a> From<Values<'a>> for Table<'a>

fn from(values: Values<'a>) -> Self

Converts to this type from the input type.

impl<'a> From<Vec<Row<'a>>> for Table<'a>

fn from(values: Vec<Row<'a>>) -> Self

Converts to this type from the input type.

impl<'a> PartialEq for Table<'a>

fn eq(&self, other: &Table<'_>) -> bool

Tests for self and other values to be equal, and is used by ==.

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

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