Struct SqlFragment 

pub struct SqlFragment { /* private fields */ }

A SQL fragment with its associated parameters.

This is the core type for building SQL queries safely. It maintains a SQL string with parameter placeholders ($1, $2, etc.) and a vector of parameter values.

Implementations

impl SqlFragment

pub fn new() -> Self

Create a new empty SQL fragment.

pub fn raw(sql: impl Into<String>) -> Self

Create a SQL fragment from raw SQL (no parameters).

Warning

Only use this for known-safe SQL strings (e.g., keywords, operators). Never use this with user input.

pub fn param(value: impl Into<SqlParam>) -> Self

Create a SQL fragment with a single parameter.

pub fn sql(&self) -> &str

Get the SQL string.

pub fn params(&self) -> &[SqlParam]

Get the parameters.

pub fn param_count(&self) -> usize

Get the current parameter count.

pub fn is_empty(&self) -> bool

Check if the fragment is empty.

pub fn push(&mut self, sql: &str) -> &mut Self

Push raw SQL (no parameters).

pub fn push_char(&mut self, c: char) -> &mut Self

Push a character.

pub fn push_param(&mut self, value: impl Into<SqlParam>) -> &mut Self

Push a parameter and its placeholder.

pub fn push_typed_param( &mut self, value: impl Into<SqlParam>, pg_type: &str, ) -> &mut Self

Push a typed parameter with explicit cast.

pub fn append(&mut self, other: SqlFragment) -> &mut Self

Append another SQL fragment.

This renumbers the parameters in the appended fragment to continue from the current count.

pub fn append_sep(&mut self, sep: &str, other: SqlFragment) -> &mut Self

Append with a separator if not empty.

pub fn join(sep: &str, fragments: impl IntoIterator<Item = SqlFragment>) -> Self

Join multiple fragments with a separator.

pub fn parens(self) -> Self

Wrap in parentheses.

pub fn build(self) -> (String, Vec<SqlParam>)

Build the final SQL and parameters.

Trait Implementations

impl Clone for SqlFragment

fn clone(&self) -> SqlFragment

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SqlFragment

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

Formats the value using the given formatter.

impl Default for SqlFragment

fn default() -> SqlFragment

Returns the “default value” for a type.

impl SqlBuilder for SqlFragment

fn build_sql(&self) -> SqlFragment

Build the SQL fragment for this type.