Struct Sql 

pub struct Sql(/* private fields */);

A composable SQL query string.

Use crate::sql! for static SQL fragments and Sql::ident/Sql::literal for dynamic values. This mirrors psycopg’s split between trusted SQL text and escaped values.

Implementations

impl Sql

pub fn new(sql: &'static str) -> Self

Creates a SQL fragment from a static SQL string.

pub fn raw_unchecked(sql: String) -> Self

Creates a SQL fragment from an arbitrary owned string, trusting the caller that it is safe SQL. Prefer Sql::ident or Sql::literal when handling untrusted input.

pub fn trusted_external_request(sql: String) -> Self

Wraps the body of an entire SQL request received over an external API endpoint that explicitly accepts arbitrary caller-supplied SQL — the HTTP/WebSocket SQL API (/api/sql, via the serde::Deserialize impl on Sql) and the MCP query tools.

Do not use this constructor anywhere else. It marks the trust boundary where a caller hands us a complete SQL request as opaque text. Internal code that assembles SQL must build it via Sql::new, Sql::ident, Sql::literal, the crate::sql! macro, or — when the SQL is already trusted by other means — Sql::raw_unchecked.

pub fn ident(ident: &str) -> Self

Creates a SQL fragment by escaping a SQL identifier.

pub fn literal(literal: &str) -> Self

Creates a SQL fragment by escaping a SQL literal.

pub fn param(index: usize) -> Self

Creates a SQL fragment for a PostgreSQL positional parameter (e.g. $1).

pub fn join( parts: impl IntoIterator<Item = Sql>, separator: &'static str, ) -> Self

Joins SQL fragments with a static separator.

pub fn format( self, args: impl IntoIterator<Item = Sql>, ) -> Result<Self, SqlFormatError>

Formats this SQL fragment by replacing each {} with the next SQL argument.

Use {{ and }} to escape literal braces.

pub fn as_str(&self) -> &str

Returns the underlying SQL string.

pub fn into_string(self) -> String

Consumes this value and returns the SQL string.

Trait Implementations

impl Clone for Sql

fn clone(&self) -> Sql

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Sql

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Sql

fn deserialize<D: Deserializer<'de>>(deserializer: D) -> Result<Self, D::Error>

Deserialize this value from the given Serde deserializer.

impl Display for Sql

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

Formats the value using the given formatter.

impl From<i16> for Sql

fn from(value: i16) -> Self

Converts to this type from the input type.

impl From<i32> for Sql

fn from(value: i32) -> Self

Converts to this type from the input type.

impl From<i64> for Sql

fn from(value: i64) -> Self

Converts to this type from the input type.

impl From<isize> for Sql

fn from(value: isize) -> Self

Converts to this type from the input type.

impl From<u16> for Sql

fn from(value: u16) -> Self

Converts to this type from the input type.

impl From<u32> for Sql

fn from(value: u32) -> Self

Converts to this type from the input type.

impl From<u64> for Sql

fn from(value: u64) -> Self

Converts to this type from the input type.

impl From<usize> for Sql

fn from(value: usize) -> Self

Converts to this type from the input type.

impl PartialEq for Sql

fn eq(&self, other: &Sql) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for Sql

fn serialize<S: Serializer>(&self, serializer: S) -> Result<S::Ok, S::Error>

Serialize this value into the given Serde serializer.

impl Eq for Sql

impl StructuralPartialEq for Sql