pub struct SqlLiteral<ST, T = Empty> { /* private fields */ }
Expand description

Returned by the sql() function.

Implementations§

source§

impl<ST, T> SqlLiteral<ST, T>

source

pub fn bind<BindST, U>( self, bind_value: U ) -> UncheckedBind<Self, U::Expression>
where BindST: SqlType + TypedExpressionType, U: AsExpression<BindST>,

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.

§Examples
let seans_id = users
    .select(id)
    .filter(sql::<Bool>("name = ").bind::<Text, _>("Sean"))
    .get_result(connection);
assert_eq!(Ok(1), seans_id);

let tess_id = sql::<Integer>("SELECT id FROM users WHERE name = ")
    .bind::<Text, _>("Tess")
    .get_result(connection);
assert_eq!(Ok(2), tess_id);
§Multiple Bind Params
let query = users
    .select(name)
    .filter(
        sql::<Bool>("id > ")
        .bind::<Integer,_>(1)
        .sql(" AND name <> ")
        .bind::<Text, _>("Ryan")
    )
    .get_results(connection);
let expected = vec!["Tess".to_string()];
assert_eq!(Ok(expected), query);
source

pub fn sql(self, sql: &str) -> SqlLiteral<ST, Self>

Use literal SQL in the query builder

This function is intended for use when you need a small bit of raw SQL in your query. If you want to write the entire query using raw SQL, use sql_query instead.

§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.

§Examples
let query = users
    .select(name)
    .filter(
        sql::<Bool>("id > 1")
        .sql(" AND name <> 'Ryan'")
    )
    .get_results(connection);
let expected = vec!["Tess".to_string()];
assert_eq!(Ok(expected), query);

Trait Implementations§

source§

impl<ST, T, __Rhs> Add<__Rhs> for SqlLiteral<ST, T>
where Self: Expression, <Self as Expression>::SqlType: Add, <<Self as Expression>::SqlType as Add>::Rhs: SqlType + SingleValue, __Rhs: AsExpression<<<Self as Expression>::SqlType as Add>::Rhs>,

§

type Output = Add<SqlLiteral<ST, T>, <__Rhs as AsExpression<<<SqlLiteral<ST, T> as Expression>::SqlType as Add>::Rhs>>::Expression>

The resulting type after applying the + operator.
source§

fn add(self, rhs: __Rhs) -> Self::Output

Performs the + operation. Read more
source§

impl<ST: Clone, T: Clone> Clone for SqlLiteral<ST, T>

source§

fn clone(&self) -> SqlLiteral<ST, T>

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from source. Read more
source§

impl<ST: Debug, T: Debug> Debug for SqlLiteral<ST, T>

source§

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

Formats the value using the given formatter. Read more
source§

impl<ST, T, __Rhs> Div<__Rhs> for SqlLiteral<ST, T>
where Self: Expression, <Self as Expression>::SqlType: Div, <<Self as Expression>::SqlType as Div>::Rhs: SqlType + SingleValue, __Rhs: AsExpression<<<Self as Expression>::SqlType as Div>::Rhs>,

§

type Output = Div<SqlLiteral<ST, T>, <__Rhs as AsExpression<<<SqlLiteral<ST, T> as Expression>::SqlType as Div>::Rhs>>::Expression>

The resulting type after applying the / operator.
source§

fn div(self, rhs: __Rhs) -> Self::Output

Performs the / operation. Read more
source§

impl<ST, T> Expression for SqlLiteral<ST, T>

§

type SqlType = ST

The type that this expression represents in SQL
source§

impl<ST, T, __Rhs> Mul<__Rhs> for SqlLiteral<ST, T>
where Self: Expression, <Self as Expression>::SqlType: Mul, <<Self as Expression>::SqlType as Mul>::Rhs: SqlType + SingleValue, __Rhs: AsExpression<<<Self as Expression>::SqlType as Mul>::Rhs>,

§

type Output = Mul<SqlLiteral<ST, T>, <__Rhs as AsExpression<<<SqlLiteral<ST, T> as Expression>::SqlType as Mul>::Rhs>>::Expression>

The resulting type after applying the * operator.
source§

fn mul(self, rhs: __Rhs) -> Self::Output

Performs the * operation. Read more
source§

impl<ST, T> Query for SqlLiteral<ST, T>
where Self: Expression,

§

type SqlType = ST

The SQL type that this query represents. Read more
source§

impl<ST, T, DB> QueryFragment<DB> for SqlLiteral<ST, T>
where DB: Backend, T: QueryFragment<DB>,

source§

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

Walk over this QueryFragment for all passes. Read more
source§

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

Available on crate feature i-implement-a-third-party-backend-and-opt-into-breaking-changes only.
Converts this QueryFragment to its SQL representation. Read more
source§

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

Available on crate feature i-implement-a-third-party-backend-and-opt-into-breaking-changes only.
Serializes all bind parameters in this query. Read more
source§

fn is_safe_to_cache_prepared(&self, backend: &DB) -> QueryResult<bool>

Available on crate feature i-implement-a-third-party-backend-and-opt-into-breaking-changes only.
Is this query safe to store in the prepared statement cache? Read more
source§

fn is_noop(&self, backend: &DB) -> QueryResult<bool>

Available on crate feature i-implement-a-third-party-backend-and-opt-into-breaking-changes only.
Does walking this AST have any effect?
source§

impl<ST, T> QueryId for SqlLiteral<ST, T>

§

type QueryId = ()

A type which uniquely represents Self in a SQL query. Read more
source§

const HAS_STATIC_QUERY_ID: bool = false

Can the SQL generated by Self be uniquely identified by its type? Read more
source§

fn query_id() -> Option<TypeId>

Returns the type id of Self::QueryId if Self::HAS_STATIC_QUERY_ID. Returns None otherwise. Read more
source§

impl<ST, T, Conn> RunQueryDsl<Conn> for SqlLiteral<ST, T>

source§

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

Executes the given query, returning a Vec with the returned rows. Read more
source§

fn load_iter<'conn, 'query: 'conn, U, B>( self, conn: &'conn mut Conn ) -> QueryResult<Self::RowIter<'conn>>
where U: 'conn, Self: LoadQuery<'query, Conn, U, B> + 'conn,

Executes the given query, returning an Iterator with the returned rows. Read more
source§

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

Runs the command, and returns the affected row. Read more
source§

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

Runs the command, returning an Vec with the affected rows. Read more
source§

impl<ST, T, __Rhs> Sub<__Rhs> for SqlLiteral<ST, T>
where Self: Expression, <Self as Expression>::SqlType: Sub, <<Self as Expression>::SqlType as Sub>::Rhs: SqlType + SingleValue, __Rhs: AsExpression<<<Self as Expression>::SqlType as Sub>::Rhs>,

§

type Output = Sub<SqlLiteral<ST, T>, <__Rhs as AsExpression<<<SqlLiteral<ST, T> as Expression>::SqlType as Sub>::Rhs>>::Expression>

The resulting type after applying the - operator.
source§

fn sub(self, rhs: __Rhs) -> Self::Output

Performs the - operation. Read more
source§

impl<ST, T, GB> ValidGrouping<GB> for SqlLiteral<ST, T>

§

type IsAggregate = Never

Is this expression aggregate? Read more
source§

impl<QS, ST, T> AppearsOnTable<QS> for SqlLiteral<ST, T>
where Self: Expression,

source§

impl<QS, ST, T> SelectableExpression<QS> for SqlLiteral<ST, T>
where Self: Expression,

Auto Trait Implementations§

§

impl<ST, T> RefUnwindSafe for SqlLiteral<ST, T>

§

impl<ST, T> Send for SqlLiteral<ST, T>
where ST: Send, T: Send,

§

impl<ST, T> Sync for SqlLiteral<ST, T>
where ST: Sync, T: Sync,

§

impl<ST, T> Unpin for SqlLiteral<ST, T>
where ST: Unpin, T: Unpin,

§

impl<ST, T> UnwindSafe for SqlLiteral<ST, T>
where ST: UnwindSafe, T: UnwindSafe,

Blanket Implementations§

source§

impl<T> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T, ST> AsExpression<ST> for T
where T: Expression<SqlType = ST>, ST: SqlType + TypedExpressionType,

§

type Expression = T

The expression being returned
source§

fn as_expression(self) -> T

Perform the conversion
source§

impl<T> AsQuery for T
where T: Query,

§

type SqlType = <T as Query>::SqlType

The SQL type of Self::Query
§

type Query = T

What kind of query does this type represent?
source§

fn as_query(self) -> <T as AsQuery>::Query

Converts a type which semantically represents a SQL query into the actual query being executed. See the trait level docs for more.
source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<Conn, DB, T> ExecuteDsl<Conn, DB> for T
where Conn: Connection<Backend = DB>, DB: Backend, T: QueryFragment<DB> + QueryId,

source§

fn execute(query: T, conn: &mut Conn) -> Result<usize, Error>

Execute this command
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T, U> Into<U> for T
where U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T> IntoSql for T

source§

fn into_sql<T>(self) -> AsExprOf<Self, T>

Convert self to an expression for Diesel’s query builder. Read more
source§

fn as_sql<'a, T>(&'a self) -> AsExprOf<&'a Self, T>

Convert &self to an expression for Diesel’s query builder. Read more
source§

impl<T> NullableExpressionMethods for T
where T: Expression,

source§

fn nullable(self) -> Nullable<Self>

Converts this potentially non-null expression into one which is treated as nullable. This method has no impact on the generated SQL, and is only used to allow certain comparisons that would otherwise fail to compile. Read more
source§

fn assume_not_null(self) -> AssumeNotNull<Self>

Converts this potentially nullable expression into one which will be assumed to be not-null. This method has no impact on the generated SQL, however it will enable you to attempt deserialization of the returned value in a non-Option. Read more
source§

impl<T> PgExpressionMethods for T
where T: Expression,

source§

fn is_not_distinct_from<T>(self, other: T) -> IsNotDistinctFrom<Self, T>
where Self::SqlType: SqlType, T: AsExpression<Self::SqlType>,

Available on crate feature postgres_backend only.
Creates a PostgreSQL IS NOT DISTINCT FROM expression. Read more
source§

fn is_distinct_from<T>(self, other: T) -> IsDistinctFrom<Self, T>
where Self::SqlType: SqlType, T: AsExpression<Self::SqlType>,

Available on crate feature postgres_backend only.
Creates a PostgreSQL IS DISTINCT FROM expression. Read more
source§

impl<T, DB> QueryFragmentForCachedStatement<DB> for T
where DB: Backend, <DB as Backend>::QueryBuilder: Default, T: QueryFragment<DB>,

source§

fn construct_sql(&self, backend: &DB) -> Result<String, Error>

Available on crate feature i-implement-a-third-party-backend-and-opt-into-breaking-changes only.
Convert the query fragment into a SQL string for the given backend
source§

fn is_safe_to_cache_prepared(&self, backend: &DB) -> Result<bool, Error>

Available on crate feature i-implement-a-third-party-backend-and-opt-into-breaking-changes only.
Check whether it’s safe to cache the query
source§

impl<T> SqliteExpressionMethods for T
where T: Expression,

source§

fn is<T>(self, other: T) -> Is<Self, T>
where Self::SqlType: SqlType, T: AsExpression<Self::SqlType>,

Available on crate feature sqlite only.
Creates a Sqlite IS expression. Read more
source§

fn is_not<T>(self, other: T) -> IsNot<Self, T>
where Self::SqlType: SqlType, T: AsExpression<Self::SqlType>,

Available on crate feature sqlite only.
Creates a Sqlite IS NOT expression. Read more
source§

impl<T> ToOwned for T
where T: Clone,

§

type Owned = T

The resulting type after obtaining ownership.
source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

source§

fn vzip(self) -> V