Struct QueryBuilder

pub struct QueryBuilder { /* private fields */ }

A builder for constructing SQL queries with bound parameters.

This struct facilitates the creation of Query objects by allowing the gradual binding of parameters before finalizing the query for execution.

Implementations

impl QueryBuilder

pub fn bind(&mut self, value: impl DatabaseType)

Binds a value to the query as a parameter.

This method adds a value to be used as a parameter in the SQL query. The value will be properly escaped and converted to the appropriate PostgreSQL type.

Parameters

• value - Any value that implements the DatabaseType trait

Returns

The query builder for method chaining

pub fn bind_value(&mut self, value: DatabaseValue)

Binds a pre-constructed DatabaseValue to the query as a parameter.

This method is similar to bind() but accepts a DatabaseValue that has already been created, which can be useful when you need more control over how values are bound.

Parameters

• value - A DatabaseValue instance to bind to the query

pub fn finalize(self) -> Query

Finalizes the query construction process.

This method takes the built query string and bound parameters from the QueryBuilder and combines them with a database connection or transaction to create a Query object. The returned Query object is ready for execution.

Parameters

• connection - A database connection (&Connection) or transaction (&Transaction) where the query will be executed. This parameter accepts any type that can be converted into a ConnectionLike enum, typically a reference to a Connection or Transaction.

Returns

A Query instance containing the finalized SQL query, bound parameters, and the connection, ready to be executed or fetched.

pub fn bound_values(&self) -> usize

Returns the number of values currently bound to the query builder.

This can be useful for generating parameter placeholders (e.g., $1, $2) dynamically while building the query string.

Trait Implementations

impl Debug for QueryBuilder

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

Formats the value using the given formatter.

impl Default for QueryBuilder

fn default() -> QueryBuilder

Returns the “default value” for a type.

impl Write for QueryBuilder

fn write_str(&mut self, s: &str) -> Result

Writes a string slice into this writer, returning whether the write succeeded.

fn write_char(&mut self, c: char) -> Result<(), Error>

Writes a char into this writer, returning whether the write succeeded.

fn write_fmt(&mut self, args: Arguments<'_>) -> Result<(), Error>

Glue for usage of the write! macro with implementors of this trait.