Struct SqlQuery 

pub struct SqlQuery<'a, T: SqlEntity> { /* private fields */ }

A query builder. This is the main structure to build the SQL queries using a templating system. It is designed to be a composable structure to build the SQL queries alongside the according parameters. The query is built using the set_variable method to set the variables and the add_parameter method to add the parameters. The query is expanded using the expand method to get the SQL query and the parameters.

Implementations

impl<'a, T: SqlEntity> SqlQuery<'a, T>

pub fn new(query: &str) -> Self

Create a new query using the given string as a SQL template. The template is a string with the variables enclosed in {:variable:} placeholders. The default variable is the projection of the entity.

pub fn set_variable(&mut self, name: &'a str, value: &str) -> &mut Self

Set a variable in the query. This variable will be replaced by its value in the query.

pub fn add_parameter(&mut self, parameter: &'a dyn ToSqlAny) -> &mut Self

Add a parameter to the query. This parameter will be replaced by its value in the query. The parameter will be expanded in the $? placeholder.

pub fn append_parameters( &mut self, parameters: Vec<&'a dyn ToSqlAny>, ) -> &mut Self

Append a vec of parameters to the query.

pub fn set_parameters(&mut self, parameters: Vec<&'a dyn ToSqlAny>) -> &mut Self

Set the parameters of the query.

pub fn get_variables(&self) -> &HashMap<&'a str, String>

Return the variables of the query.

pub fn get_parameters(&self) -> Vec<&'a dyn ToSqlAny>

Return the parameters of the query. This method is mostly intended for testing purposes since the parameters are cloned.

pub fn expand(self) -> (String, Vec<&'a dyn ToSqlAny>)

Return the query and the parameters to be sent to the server. This consumes the query instance.

Trait Implementations

impl<'a, T: SqlEntity> Display for SqlQuery<'a, T>

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

Formats the value using the given formatter.