Struct TableRef 

pub struct TableRef {
    pub name: String,
    pub alias: Option<String>,
    pub sub: Option<Box<Select>>,
    pub args: Option<Vec<Expr>>,
    pub col_aliases: Vec<String>,
    pub lateral: bool,
}

Fields

name: String

The table name as written, minus quoting. A pg_catalog. qualifier is preserved here and resolved by the caller, because information_schema table names collide with plausible user collection names.

For a derived table this is the literal (subquery), and for a table function it is the function’s bare name — both only ever shown in a plan, never resolved as a relation.

alias: Option<String>

sub: Option<Box<Select>>

FROM (SELECT ...) AS t — the relation is the subquery’s output. psql’s \dd is one seven-arm UNION ALL wrapped exactly this way.

args: Option<Vec<Expr>>

FROM generate_series(0, n) s / FROM unnest(arr) AS t(x) — a table function with its arguments. Evaluated in the enclosing row’s scope, because psql writes unnest(evttags) over the OUTER row’s column.

col_aliases: Vec<String>

AS t(x, y) — column aliases for a derived table or table function.

lateral: bool

LATERAL (SELECT ...) — the derived table may read the FROM items before it, so it is re-evaluated once per row of those. psql’s \dP+ sizes each partitioned table this way.

Implementations

impl TableRef

pub fn named(name: impl Into<String>, alias: Option<String>) -> TableRef

A plain named relation.

pub fn binding(&self) -> String

How this table’s columns are addressed: the alias when given, else the table’s own bare name, which is what SQL says.

Trait Implementations

impl Clone for TableRef

fn clone(&self) -> TableRef

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for TableRef

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

Formats the value using the given formatter.

impl PartialEq for TableRef

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for TableRef