Struct toql::query::Query

pub struct Query<M> {
    pub distinct: bool,
    pub aux_params: HashMap<String, SqlArg, RandomState>,
    pub where_predicates: Vec<String, Global>,
    pub where_predicate_params: Vec<SqlArg, Global>,
    pub select_columns: Vec<String, Global>,
    pub join_stmts: Vec<String, Global>,
    pub join_stmt_params: Vec<SqlArg, Global>,
    pub type_marker: PhantomData<M>,
    // some fields omitted
}

Fields

distinct: bool

Select DISTINCT

aux_params: HashMap<String, SqlArg, RandomState>

Aux params used with query

where_predicates: Vec<String, Global>

Additional where clause

where_predicate_params: Vec<SqlArg, Global>

Query params for additional sql restriction

select_columns: Vec<String, Global>

Additional select columns

join_stmts: Vec<String, Global>

Additional joins statements

join_stmt_params: Vec<SqlArg, Global>

type_marker: PhantomData<M>

Type marker

Implementations

impl<M> Query<M>

pub fn new() -> Query<M>

Create a new empty query.

pub fn from<T>(query: T) -> Query<M> where
    T: Into<Query<M>>, 

Create a new query from another query.

pub fn clone_for_type<T>(&self) -> Query<T>

Create a new query from another query.

pub fn traverse<T>(&self, path: &str) -> Query<T>

Create a new query from the path of another query.

pub fn wildcard() -> Query<M>

Create a new query that select all top fields.

pub fn selection(name: impl Into<String>) -> Query<M>

pub fn parenthesize(self) -> Query<M>

Wrap query with parentheses.

pub fn and<T>(self, query: T) -> Query<M> where
    T: Into<Query<M>>, 

Concatenate field or query with AND.

pub fn and_parentized<T>(self, query: T) -> Query<M> where
    T: Into<Query<M>>, 

Concatenate field or query with AND.

pub fn or<T>(self, query: T) -> Query<M> where
    T: Into<Query<M>>, 

Concatenate field or query with OR.

pub fn or_parentized<T>(self, query: T) -> Query<M> where
    T: Into<Query<M>>, 

Concatenate field or query with AND.

pub fn with(self, query_with: impl QueryWith<M>) -> Query<M>

Modifiy the query with an additional stuct.

pub fn aux_param<S, A>(self, name: S, value: A) -> Query<M> where
    A: Into<SqlArg>,
    S: Into<String>, 

Convenence method to add aux params

pub fn contains_path(&self, path: &str) -> bool

Check if query contains path Example: Path is ‘user_address’ Valid query paths are ‘user_’, ‘user_address_’, ’user_address_country_*,‘user_address_id’

pub fn contains_path_starts_with(&self, path: &str) -> bool

Check if query contains path starting with a subpath Example: Path is ‘user_address’ Valid query paths are ‘user_address_*’, ‘user_address_id’

Trait Implementations

impl<M> Debug for Query<M> where
    M: Debug, 

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

Formats the value using the given formatter.

impl<M> Default for Query<M>

pub fn default() -> Query<M>

Returns the “default value” for a type.

impl<M> Display for Query<M>

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

Formats the value using the given formatter.

impl<'_, M> From<&'_ str> for Query<M>

pub fn from(string: &str) -> Query<M>

Performs the conversion.

impl<M> From<Field> for Query<M>

pub fn from(field: Field) -> Query<M>

Performs the conversion.

impl<M> From<Predicate> for Query<M>

pub fn from(predicate: Predicate) -> Query<M>

Performs the conversion.

impl<M> From<Selection> for Query<M>

pub fn from(selection: Selection) -> Query<M>

Performs the conversion.

impl<T> From<T> for Query<<T as KeyFields>::Entity> where
    T: KeyFields, 

pub fn from(fields: T) -> Query<<T as KeyFields>::Entity>

Performs the conversion.

impl<M> From<Wildcard> for Query<M>

pub fn from(wildcard: Wildcard) -> Query<M>

Performs the conversion.

impl<T, K> FromIterator<K> for Query<T> where
    K: Key<Entity = T> + Into<Query<T>>, 

Allows to collect different keys in a query (concatenation is or)

pub fn from_iter<I>(iter: I) -> Query<T> where
    I: IntoIterator<Item = K>, 

Creates a value from an iterator.

impl<'a, T> FromIterator<Query<T>> for Query<T>

Allows to collect different queries in a query (concatenation is and)

pub fn from_iter<I>(iter: I) -> Query<T> where
    I: IntoIterator<Item = Query<T>>, 

Creates a value from an iterator.