Struct sql::plan::statement::show::ShowSelect

pub struct ShowSelect<'a> {
    scx: &'a StatementContext<'a>,
    stmt: SelectStatement<Raw>,
}

An intermediate result when planning a SHOW query.

Can be interrogated for its columns, or converted into a proper Plan.

Fields

scx: &'a StatementContext<'a>

stmt: SelectStatement<Raw>

Implementations

impl<'a> ShowSelect<'a>

fn new(
    scx: &'a StatementContext<'_>,
    query: String,
    filter: Option<ShowStatementFilter<Raw>>,
    order: Option<&str>,
    projection: Option<&[&str]>
) -> ShowSelect<'a>

Constructs a new ShowSelect from a query that provides the base data and an optional user-supplied filter, order column, and projection on that data.

Note that the query must return a column named name, as the filter may implicitly reference this column. Any ORDER BY in the query is ignored. ShowSelectss are always ordered in ascending order by all columns from left to right unless an order field is supplied.

pub fn describe(self) -> Result<StatementDesc, Error>

Computes the shape of this ShowSelect.

pub fn plan(self) -> Result<Plan, Error>

Converts this ShowSelect into a Plan.