Struct QueryMetadata 

pub struct QueryMetadata {
    pub aggregation: Aggregation,
    pub table: TabIdent,
    pub filter: Option<Filter>,
    pub data_extraction_query: String,
    pub data_aggregation_query: Option<String>,
}

QueryMetadata extracted from the query.

Fields

aggregation: Aggregation

Aggregation performed.

table: TabIdent

Table subject to query.

filter: Option<Filter>

Filter applied.

data_extraction_query: String

Data Extraction Query in SQL

data_aggregation_query: Option<String>

Data Aggregation Query in SQL

Implementations

impl QueryMetadata

pub fn parse( sql_query: &str, quote_style: Option<char>, ) -> Result<Self, ParseError>

Generates QueryMetadata from a SQL query using [crate::config::Config].

pub fn create_data_extraction_query( aggregation: &Aggregation, table: &TabIdent, filter: &Option<Filter>, quote_style: Option<char>, ) -> String

Trait Implementations

impl Clone for QueryMetadata

fn clone(&self) -> QueryMetadata

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl ComposeSchema for QueryMetadata

fn compose(generics: Vec<RefOr<Schema>>) -> RefOr<Schema>

impl Debug for QueryMetadata

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

Formats the value using the given formatter.

impl Default for QueryMetadata

fn default() -> QueryMetadata

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for QueryMetadata

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl IntoParams for QueryMetadata

fn into_params( parameter_in_provider: impl Fn() -> Option<ParameterIn>, ) -> Vec<Parameter>

Provide Vec of openapi::path::Parameters to caller. The result is used in utoipa-gen library to provide OpenAPI parameter information for the endpoint using the parameters.

impl PartialEq for QueryMetadata

fn eq(&self, other: &QueryMetadata) -> 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 Serialize for QueryMetadata

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl ToSchema for QueryMetadata

fn name() -> Cow<'static, str>

Return name of the schema.

fn schemas(schemas: &mut Vec<(String, RefOr<Schema>)>)

Implement reference utoipa::openapi::schema::Schemas for this type.

impl Eq for QueryMetadata

impl StructuralPartialEq for QueryMetadata