Struct TableQuery 

pub struct TableQuery {
    pub with: With,
    pub table: TableRef,
    pub order_by: OrderBy,
    pub limit: Limit,
    pub offset: Offset,
    pub fetch: Fetch,
    pub locks: Locks,
    pub combines: Combines,
}

The PostgreSQL TABLE command — TABLE name is SELECT * FROM name.

From https://www.postgresql.org/docs/17/sql-select.html (the TABLE section): TABLE [ ONLY ] table_name [ * ], and

it can be used as a top-level command or as a space-saving syntax variant in parts of complex queries. Only the WITH, UNION, INTERSECT, EXCEPT, ORDER BY, LIMIT, OFFSET, FETCH and FOR locking clauses can be used with TABLE; the WHERE clause and any form of aggregation cannot be used.

The struct is that sentence: exactly those clauses, and no others — a table::where_ is a compile error because HasWhere is not implemented.

Fields

with: With

WITH ….

table: TableRef

The table: TABLE [ ONLY ] name. Grammar takes a name only — no alias, no column list.

order_by: OrderBy

ORDER BY … — this statement’s own.

limit: Limit

LIMIT … — this statement’s own.

offset: Offset

OFFSET … — this statement’s own.

fetch: Fetch

FETCH … — this statement’s own.

locks: Locks

FOR UPDATE ….

combines: Combines

The set operations, and the trailing clauses that belong to their result.

Implementations

impl TableQuery

pub fn new() -> TableQuery

A TABLE with no table yet — which does not build until it has one.

pub fn apply(&mut self, mods: impl Mod<TableQuery>)

Apply more mods to an existing query.

Trait Implementations

impl Clone for TableQuery

fn clone(&self) -> TableQuery

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for TableQuery

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

Formats the value using the given formatter.

impl Default for TableQuery

fn default() -> TableQuery

Returns the “default value” for a type.

impl Expression for TableQuery

fn write_sql(&self, w: &mut SqlWriter<'_>)

Append this fragment to w.

impl HasCombines for TableQuery

fn combines_mut(&mut self) -> &mut Combines

The set operations to modify.

impl HasFetch for TableQuery

fn fetch_mut(&mut self) -> &mut Fetch

The FETCH clause to modify.

impl HasLimit for TableQuery

fn limit_mut(&mut self) -> &mut Limit

The LIMIT clause to modify.

impl HasLocks for TableQuery

fn locks_mut(&mut self) -> &mut Locks

The locking clauses to modify.

impl HasOffset for TableQuery

fn offset_mut(&mut self) -> &mut Offset

The OFFSET clause to modify.

impl HasOrderBy for TableQuery

fn order_by_mut(&mut self) -> &mut OrderBy

The ORDER BY clause to modify.

impl HasTableRef for TableQuery

fn table_ref_mut(&mut self) -> &mut TableRef

The table reference to modify.

impl HasWith for TableQuery

fn with_mut(&mut self) -> &mut With

The WITH clause to modify.

impl IntoExpr for TableQuery

fn into_expr(self) -> Expr

Perform the conversion.

impl IntoExprList for TableQuery

fn into_expr_list(self) -> Vec<Expr>

Perform the conversion.

impl Query for TableQuery

fn query_type(&self) -> QueryType

Which statement this renders.

fn dialect(&self) -> &dyn Dialect

The dialect this query renders itself in.

fn build(&self) -> Result<(String, Vec<Value>), Error>

Render to SQL and arguments, numbering placeholders from 1.

fn build_from(&self, start: usize) -> Result<(String, Vec<Value>), Error>

build with a different first placeholder position, for splicing into a statement that already has arguments — bob’s BuildN.

impl<H, L, M> QueryExtensions<H, L, M> for TableQuery

fn hooks(&self) -> &[Hook]

Hooks to run before this query executes.

fn loaders(&self) -> &[Loader]

Loaders to run after this query executes, for eagerly loaded relations.

fn mapper_mods(&self) -> &[MapperMod]

Adjustments to the row mapper, for relations loaded in the same query.