Struct SummaryResult 

pub struct SummaryResult {
    pub protobuf: SummaryResult,
    pub warnings: Vec<String>,
    pub tables: Vec<Table>,
    pub aliases: HashMap<String, String>,
    pub cte_names: Vec<String>,
    pub functions: Vec<Function>,
    pub filter_columns: Vec<FilterColumn>,
    pub truncated_query: String,
    pub statement_types: Vec<String>,
}

Result from calling summary. Where possible, this is API-compatible with ParseResult.

The main distinction is that summary does truncation on the C side, whereas parse does it on the Rust side. This requires passing the maximum length ahead of time to summary(query, max_length).

This means that summary(query, max_length).truncated_query is equivalent to parse(query).truncate(max_length)

For tables, functions, and filter_columns, SummaryResult stores more details than ParseResult, so the signatures have changed. However, the functions that correspond to them should be equivalent.

Fields

protobuf: SummaryResult

warnings: Vec<String>

tables: Vec<Table>

aliases: HashMap<String, String>

cte_names: Vec<String>

functions: Vec<Function>

filter_columns: Vec<FilterColumn>

truncated_query: String

statement_types: Vec<String>

Implementations

impl SummaryResult

pub fn new(protobuf: SummaryResult, stderr: String) -> Self

pub fn tables(&self) -> Vec<String>

Returns all referenced tables in the query

pub fn select_tables(&self) -> Vec<String>

Returns only tables that were selected from

pub fn dml_tables(&self) -> Vec<String>

Returns only tables that were modified by the query

pub fn ddl_tables(&self) -> Vec<String>

Returns only tables that were modified by DDL statements

pub fn functions(&self) -> Vec<String>

Returns all function references

pub fn ddl_functions(&self) -> Vec<String>

Returns DDL functions

pub fn call_functions(&self) -> Vec<String>

Returns functions that were called

pub fn statement_types(&self) -> Vec<&str>

Returns all statement types in the query

Trait Implementations

impl Debug for SummaryResult

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

Formats the value using the given formatter.

impl PartialEq for SummaryResult

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for SummaryResult