Struct SelectQuery 

pub struct SelectQuery {

    pub with: With,
    pub hints: Hints,
    pub modifiers: Modifiers,
    pub select_list: SelectList,
    pub from: TableRef,
    pub extra_from: Vec<TableRef>,
    pub where_: Where,
    pub group_by: GroupBy,
    pub having: Having,
    pub windows: Windows,
    pub order_by: OrderBy,
    pub limit: Limit,
    pub offset: Offset,
    pub locks: Locks,
    pub lock_in_share_mode: bool,
    pub combines: Combines,
}

A MySQL SELECT.

The field order is the clause order of https://dev.mysql.com/doc/refman/8.4/en/select.html:

[WITH [RECURSIVE] with_query [, ...]]
SELECT [hint_comment]
    [ALL | DISTINCT | DISTINCTROW] [HIGH_PRIORITY] [STRAIGHT_JOIN]
    [SQL_SMALL_RESULT] [SQL_BIG_RESULT] [SQL_BUFFER_RESULT]
    [SQL_NO_CACHE] [SQL_CALC_FOUND_ROWS]
    select_expr [, select_expr] ...
    [FROM table_references]
    [WHERE where_condition]
    [GROUP BY {col_name | expr | position}, ... [WITH ROLLUP]]
    [HAVING where_condition]
    [WINDOW window_name AS (window_spec) [, ...]]
    [ORDER BY {col_name | expr | position} [ASC | DESC], ...]
    [LIMIT {[offset,] row_count | row_count OFFSET offset}]
    [FOR {UPDATE | SHARE} [OF tbl_name [, ...]] [NOWAIT | SKIP LOCKED]
      | LOCK IN SHARE MODE]

Two differences from PostgreSQL are worth stating.

The locking clause has two shapes, and they are alternatives. FOR UPDATE and FOR SHARE are Locks; LOCK IN SHARE MODE is a production of its own with no OF list and no wait option, so it is a flag rather than a Lock strength. Setting both is a caller error the server refuses.

LIMIT gates OFFSET. MySQL’s grammar spells the pair as one clause, so OFFSET alone does not parse. Nothing here prevents it — the server is what says no.

Fields

with: With

WITH ….

hints: Hints

/*+ … */.

modifiers: Modifiers

DISTINCT, HIGH_PRIORITY, STRAIGHT_JOIN, …

select_list: SelectList

The projection. Empty renders *.

from: TableRef

The first FROM item, with its joins.

extra_from: Vec<TableRef>

Further comma-separated FROM items.

where_: Where

WHERE ….

group_by: GroupBy

GROUP BY … [WITH ROLLUP].

having: Having

HAVING ….

windows: Windows

WINDOW ….

order_by: OrderBy

ORDER BY … — this query’s own.

limit: Limit

LIMIT … — this query’s own.

offset: Offset

OFFSET … — this query’s own. Needs a LIMIT to be legal.

locks: Locks

FOR UPDATE … / FOR SHARE ….

lock_in_share_mode: bool

LOCK IN SHARE MODE, the pre-8.0 spelling of FOR SHARE.

combines: Combines

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

Implementations

impl SelectQuery

pub fn new() -> SelectQuery

An empty SELECT, which renders SELECT *.

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

Apply more mods to an existing query.

Trait Implementations

impl Clone for SelectQuery

fn clone(&self) -> SelectQuery

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SelectQuery

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

Formats the value using the given formatter.

impl Default for SelectQuery

fn default() -> SelectQuery

Returns the “default value” for a type.

impl Expression for SelectQuery

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

Append this fragment to w.

impl HasCombines for SelectQuery

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

The set operations to modify.

impl HasExtraTables for SelectQuery

fn extra_tables_mut(&mut self) -> &mut Vec<TableRef>

The additional table references to modify.

impl HasGroupBy for SelectQuery

fn group_by_mut(&mut self) -> &mut GroupBy

The GROUP BY clause to modify.

impl HasHaving for SelectQuery

fn having_mut(&mut self) -> &mut Having

The HAVING clause to modify.

impl HasHints for SelectQuery

fn hints_mut(&mut self) -> &mut Hints

The hints to add to.

impl HasJoins for SelectQuery

fn joins_mut(&mut self) -> &mut Vec<Join>

The join list to modify.

impl HasLimit for SelectQuery

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

The LIMIT clause to modify.

impl HasLocks for SelectQuery

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

The locking clauses to modify.

impl HasModifiers for SelectQuery

fn modifiers_mut(&mut self) -> &mut Modifiers

The modifiers to add to.

impl HasOffset for SelectQuery

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

The OFFSET clause to modify.

impl HasOrderBy for SelectQuery

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

The ORDER BY clause to modify.

impl HasSelectList for SelectQuery

fn select_list_mut(&mut self) -> &mut SelectList

The projection to modify.

impl HasTableRef for SelectQuery

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

The table reference to modify.

impl HasWhere for SelectQuery

fn where_mut(&mut self) -> &mut Where

The WHERE clause to modify.

impl HasWindows for SelectQuery

fn windows_mut(&mut self) -> &mut Windows

The WINDOW clause to modify.

impl HasWith for SelectQuery

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

The WITH clause to modify.

impl IntoExpr for SelectQuery

fn into_expr(self) -> Expr

Perform the conversion.

impl IntoExprList for SelectQuery

fn into_expr_list(self) -> Vec<Expr>

Perform the conversion.

impl Query for SelectQuery

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 SelectQuery

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.