Skip to content

Commit

Permalink
feat: QueryBuilder improvements
Browse files Browse the repository at this point in the history
* get raw SQL
* build `QueryAs` instead of `Query`
  • Loading branch information
abonander committed Jul 29, 2022
1 parent a2eceec commit a76939f
Showing 1 changed file with 33 additions and 1 deletion.
34 changes: 33 additions & 1 deletion sqlx-core/src/query_builder.rs
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,9 @@ use std::marker::PhantomData;
use crate::arguments::Arguments;
use crate::database::{Database, HasArguments};
use crate::encode::Encode;
use crate::from_row::FromRow;
use crate::query::Query;
use crate::query_as::QueryAs;
use crate::types::Type;
use crate::Either;

Expand Down Expand Up @@ -392,7 +394,6 @@ where
for tuple in tuples {
separated.push("(");

// use a `Separated` with a separate (hah) internal state
push_tuple(separated.query_builder.separated(", "), tuple);

separated.push_unseparated(")");
Expand Down Expand Up @@ -425,6 +426,27 @@ where
}
}

/// Produce an executable query from this builder.
///
/// ### Note: Query is not Checked
/// It is your responsibility to ensure that you produce a syntactically correct query here,
/// this API has no way to check it for you.
///
/// ### Note: Reuse
/// You can reuse this builder afterwards to amortize the allocation overhead of the query
/// string, however you must call [`.reset()`][Self::reset] first, which returns `Self`
/// to the state it was in immediately after [`new()`][Self::new].
///
/// Calling any other method but `.reset()` after `.build()` will panic for sanity reasons.
pub fn build_query_as<'q, T: FromRow<'q, DB::Row>>(
&'q mut self,
) -> QueryAs<'q, DB, T, <DB as HasArguments<'args>>::Arguments> {
QueryAs {
inner: self.build(),
output: PhantomData,
}
}

/// Reset this `QueryBuilder` back to its initial state.
///
/// The query is truncated to the initial fragment provided to [`new()`][Self::new] and
Expand All @@ -435,6 +457,16 @@ where

self
}

/// Get the current build SQL; **note**: may not be syntactically correct.
pub fn sql(&self) -> &str {
&self.query
}

/// Deconstruct this `QueryBuilder`, returning the built SQL. May not be syntactically correct.
pub fn into_sql(self) -> String {
self.query
}
}

/// A wrapper around `QueryBuilder` for creating comma(or other token)-separated lists.
Expand Down

0 comments on commit a76939f

Please sign in to comment.