Struct diesel::query_builder::SqlQuery

#[must_use = "Queries are only executed when calling `load`, `get_result` or similar."]
pub struct SqlQuery { /* fields omitted */ }

The return value of sql_query.

Unlike most queries in Diesel, SqlQuery loads its data by column name, rather than by index. This means that you cannot deserialize this query into a tuple, and any structs used must implement QueryableByName.

See sql_query for examples.

Methods

impl SqlQuery

pub fn bind<ST, Value>(self, value: Value) -> UncheckedBind<Self, Value, ST>

Bind a value for use with this SQL query.

Safety

This function should be used with care, as Diesel cannot validate that the value is of the right type nor can it validate that you have passed the correct number of parameters.

Example

let users = sql_query("SELECT * FROM users WHERE id > ? AND name <> ?")
    .bind::<Integer, _>(1)
    .bind::<Text, _>("Tess")
    .get_results(&connection);
let expected_users = vec![
    User { id: 3, name: "Jim".into() },
];
assert_eq!(Ok(expected_users), users);

Trait Implementations

impl Debug for SqlQuery

fn fmt(&self, __arg_0: &mut Formatter) -> Result

Formats the value using the given formatter.

impl Clone for SqlQuery

fn clone(&self) -> SqlQuery

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<DB> QueryFragment<DB> for SqlQuery where
    DB: Backend, 

fn walk_ast(&self, out: AstPass<DB>) -> QueryResult<()>

Walk over this QueryFragment for all passes.

fn to_sql(&self, out: &mut DB::QueryBuilder) -> QueryResult<()>

Converts this QueryFragment to its SQL representation.

fn collect_binds(
    &self,
    out: &mut DB::BindCollector,
    metadata_lookup: &DB::MetadataLookup
) -> QueryResult<()>

Serializes all bind parameters in this query.

fn is_safe_to_cache_prepared(&self) -> QueryResult<bool>

Is this query safe to store in the prepared statement cache?

impl QueryId for SqlQuery

type QueryId = ()

A type which uniquely represents Self in a SQL query.

const HAS_STATIC_QUERY_ID: bool

HAS_STATIC_QUERY_ID: bool = false

Can the SQL generated by Self be uniquely identified by its type?

fn query_id() -> Option<TypeId>

Returns the type id of Self::QueryId if Self::HAS_STATIC_QUERY_ID. Returns None otherwise.

impl<Conn, T> LoadQuery<Conn, T> for SqlQuery where
    Conn: Connection,
    T: QueryableByName<Conn::Backend>, 

fn internal_load(self, conn: &Conn) -> QueryResult<Vec<T>>

Load this query

impl<Conn> RunQueryDsl<Conn> for SqlQuery

fn execute(self, conn: &Conn) -> QueryResult<usize> where
    Conn: Connection,
    Self: ExecuteDsl<Conn>, 

Executes the given command, returning the number of rows affected.

fn load<U>(self, conn: &Conn) -> QueryResult<Vec<U>> where
    Self: LoadQuery<Conn, U>, 

Executes the given query, returning a Vec with the returned rows.

fn get_result<U>(self, conn: &Conn) -> QueryResult<U> where
    Self: LoadQuery<Conn, U>, 

Runs the command, and returns the affected row.

fn get_results<U>(self, conn: &Conn) -> QueryResult<Vec<U>> where
    Self: LoadQuery<Conn, U>, 

Runs the command, returning an Vec with the affected rows.

fn first<U>(self, conn: &Conn) -> QueryResult<U> where
    Self: LimitDsl,
    Limit<Self>: LoadQuery<Conn, U>, 

Attempts to load a single record.