Struct SqlBuilder 

pub struct SqlBuilder { /* private fields */ }

Accumulates SQL text and bind parameters into a parameterized query.

Constructed via SqlBuilder::new(), populated with push* methods, and finalised with build() which returns (String, Vec<SqlParam>).

Invariants

• push_param always appends $N where N = params.len() after the push.
• Identifiers are always double-quote escaped via push_ident / push_qi.
• Literals are single-quote escaped via push_literal.

Implementations

impl SqlBuilder

pub fn new() -> Self

Create an empty builder.

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

Create a builder pre-loaded with the given SQL text.

pub fn push(&mut self, s: &str)

Append raw SQL text (no escaping).

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

Append a single character.

pub fn push_ident(&mut self, ident: &str)

Append a double-quoted SQL identifier.

Internal double-quotes are doubled per the SQL standard.

SQL Example

-- push_ident("user\"name") produces:
"user""name"

pub fn push_qi(&mut self, qi: &QualifiedIdentifier)

Append a schema-qualified identifier ("schema"."name").

If the schema is empty, only the name is emitted.

SQL Example

-- push_qi(QI { schema: "public", name: "users" }) produces:
"public"."users"

pub fn push_literal(&mut self, s: &str)

Append a single-quoted SQL literal.

Single-quotes are doubled. If the value contains a backslash, the PostgreSQL E-string syntax (E'...') is used so that \\ is treated as a literal backslash regardless of standard_conforming_strings.

SQL Example

-- push_literal("it's") produces:
'it''s'
-- push_literal("back\\slash") produces:
E'back\\slash'

pub fn push_param(&mut self, param: SqlParam)

Append a bind-parameter placeholder ($N) and store the value.

The placeholder index is self.params.len() + 1 (1-based).

pub fn param_count(&self) -> usize

Current number of bind parameters.

pub fn is_empty(&self) -> bool

Whether the builder is empty (no SQL text).

pub fn sql_len(&self) -> usize

Current length of the SQL text buffer.

pub fn push_separated<T, F>(&mut self, sep: &str, items: &[T], f: F)

where F: Fn(&mut SqlBuilder, &T),

Append items separated by sep, where each item is written by the callback f.

Behaviour

Does nothing if items is empty. Does not emit a trailing separator.

pub fn push_builder(&mut self, other: &SqlBuilder)

Merge another builder’s SQL and params into this one.

The merged builder’s $N placeholders are rewritten to continue from this builder’s current param count.

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

Consume the builder and return the SQL string and parameters.

pub fn sql(&self) -> &str

Borrow the current SQL text (for debugging / assertions).

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

Borrow the current parameters (for debugging / assertions).

Trait Implementations

impl Clone for SqlBuilder

fn clone(&self) -> SqlBuilder

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SqlBuilder

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

Formats the value using the given formatter.

impl Default for SqlBuilder

fn default() -> Self

Returns the “default value” for a type.