Struct ExplainStatement 

pub struct ExplainStatement { /* private fields */ }

Implementations

impl ExplainStatement

pub fn new() -> Self

pub fn statement(self, statement: impl Into<ExplainableStatement>) -> Self

Set the statement to be explained.

impl ExplainStatement

pub fn analyze(self) -> Self

Available on crate features backend-mysql or backend-postgres only.

Set ANALYZE to true.

pub fn format(self, format: ExplainFormat) -> Self

Available on crate features backend-mysql or backend-postgres only.

Set the output format.

impl ExplainStatement

pub fn verbose(self, verbose: bool) -> Self

Available on crate feature backend-postgres only.

Set VERBOSE.

pub fn costs(self, costs: bool) -> Self

Available on crate feature backend-postgres only.

Set COSTS.

pub fn settings(self, settings: bool) -> Self

Available on crate feature backend-postgres only.

Set SETTINGS.

pub fn generic_plan(self, generic_plan: bool) -> Self

Available on crate feature backend-postgres only.

Set GENERIC_PLAN.

pub fn buffers(self, buffers: bool) -> Self

Available on crate feature backend-postgres only.

Set BUFFERS.

pub fn serialize_text(self) -> Self

Available on crate feature backend-postgres only.

Set SERIALIZE TEXT.

pub fn serialize_binary(self) -> Self

Available on crate feature backend-postgres only.

Set SERIALIZE BINARY.

pub fn serialize_none(self) -> Self

Available on crate feature backend-postgres only.

Set SERIALIZE NONE.

pub fn wal(self, wal: bool) -> Self

Available on crate feature backend-postgres only.

Set WAL.

pub fn timing(self, timing: bool) -> Self

Available on crate feature backend-postgres only.

Set TIMING.

pub fn summary(self, summary: bool) -> Self

Available on crate feature backend-postgres only.

Set SUMMARY.

pub fn memory(self, memory: bool) -> Self

Available on crate feature backend-postgres only.

Set MEMORY.

impl ExplainStatement

pub fn table(table: impl IntoTableRef) -> Self

Available on crate feature backend-mysql only.

Create a MySQL EXPLAIN for tbl_name [col_name | wild].

Examples

use sea_query::{ExplainStatement, MysqlQueryBuilder};

assert_eq!(
    ExplainStatement::table("glyph").to_string(MysqlQueryBuilder),
    "EXPLAIN `glyph`"
);
assert_eq!(
    ExplainStatement::table_with_column("glyph", "size").to_string(MysqlQueryBuilder),
    "EXPLAIN `glyph` `size`"
);
assert_eq!(
    ExplainStatement::table_with_wildcard("glyph", "size_%").to_string(MysqlQueryBuilder),
    "EXPLAIN `glyph` 'size_%'"
);

pub fn table_with_column( table: impl IntoTableRef, column: impl IntoIden, ) -> Self

Available on crate feature backend-mysql only.

pub fn table_with_wildcard( table: impl IntoTableRef, wildcard: &'static str, ) -> Self

Available on crate feature backend-mysql only.

pub fn into_variable(self, variable: impl Into<String>) -> Self

Available on crate feature backend-mysql only.

Store the EXPLAIN output into a MySQL user variable.

pub fn column(self, column: impl IntoIden) -> Self

Available on crate feature backend-mysql only.

Set the column name for EXPLAIN tbl_name col_name.

pub fn for_connection(self, id: u64) -> Self

Available on crate feature backend-mysql only.

Explain a statement for a specific connection id.

pub fn for_schema(self, schema: impl IntoIden) -> Self

Available on crate feature backend-mysql only.

Explain a statement for a specific schema.

pub fn for_database(self, database: impl IntoIden) -> Self

Available on crate feature backend-mysql only.

Explain a statement for a specific database.

impl ExplainStatement

pub fn query_plan(self) -> Self

Available on crate feature backend-sqlite only.

Use EXPLAIN QUERY PLAN.

impl ExplainStatement

pub fn build_collect_into( &self, query_builder: impl QueryBuilder, sql: &mut impl SqlWriter, )

Build SQL into the provided writer.

pub fn build_collect( &self, query_builder: impl QueryBuilder, sql: &mut impl SqlWriter, ) -> String

Build SQL into the provided writer and return the resulting string.

pub fn build(&self, query_builder: impl QueryBuilder) -> (String, Values)

Build SQL and collect values.

pub fn to_string(&self, query_builder: impl QueryBuilder) -> String

Build the SQL string.

Trait Implementations

impl Clone for ExplainStatement

fn clone(&self) -> ExplainStatement

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ExplainStatement

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

Formats the value using the given formatter.

impl Default for ExplainStatement

fn default() -> ExplainStatement

Returns the “default value” for a type.

impl PartialEq for ExplainStatement

fn eq(&self, other: &ExplainStatement) -> 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.

impl StructuralPartialEq for ExplainStatement