[][src]Struct diesel::query_builder::InsertStatement

#[must_use =
  "Queries are only executed when calling `load`, `get_result` or similar."]pub struct InsertStatement<T, U, Op = Insert, Ret = NoReturningClause> { /* fields omitted */ }

A fully constructed insert statement.

The parameters of this struct represent:

Implementations

impl<T, U, C, Op, Ret> InsertStatement<T, InsertFromSelect<U, C>, Op, Ret>[src]

pub fn into_columns<C2>(
    self,
    columns: C2
) -> InsertStatement<T, InsertFromSelect<U, C2>, Op, Ret> where
    C2: ColumnList<Table = T> + Expression,
    U: Query<SqlType = C2::SqlType>, 
[src]

Set the column list when inserting from a select statement

See the documentation for insert_into for usage examples.

impl<T, U, Op> InsertStatement<T, U, Op>[src]

pub fn returning<E>(
    self,
    returns: E
) -> InsertStatement<T, U, Op, ReturningClause<E>> where
    InsertStatement<T, U, Op, ReturningClause<E>>: Query
[src]

Specify what expression is returned after execution of the insert.

Examples

Inserting records:

let inserted_names = diesel::insert_into(users)
    .values(&vec![name.eq("Timmy"), name.eq("Jimmy")])
    .returning(name)
    .get_results(&connection);
assert_eq!(Ok(vec!["Timmy".to_string(), "Jimmy".to_string()]), inserted_names);

impl<T, U, Op, Ret> InsertStatement<T, U, Op, Ret> where
    U: UndecoratedInsertRecord<T> + IntoConflictValueClause, 
[src]

pub fn on_conflict_do_nothing(
    self
) -> InsertStatement<T, OnConflictValues<U::ValueClause, NoConflictTarget, DoNothing>, Op, Ret>
[src]

Adds ON CONFLICT DO NOTHING to the insert statement, without specifying any columns or constraints to restrict the conflict to.

Examples

Single Record

let user = User { id: 1, name: "Sean", };

let inserted_row_count = diesel::insert_into(users)
    .values(&user)
    .on_conflict_do_nothing()
    .execute(&conn);
assert_eq!(Ok(1), inserted_row_count);

let inserted_row_count = diesel::insert_into(users)
    .values(&user)
    .on_conflict_do_nothing()
    .execute(&conn);
assert_eq!(Ok(0), inserted_row_count);

Vec of Records

let user = User { id: 1, name: "Sean", };

let inserted_row_count = diesel::insert_into(users)
    .values(&vec![user, user])
    .on_conflict_do_nothing()
    .execute(&conn);
assert_eq!(Ok(1), inserted_row_count);

pub fn on_conflict<Target>(
    self,
    target: Target
) -> IncompleteOnConflict<InsertStatement<T, U::ValueClause, Op, Ret>, ConflictTarget<Target>> where
    ConflictTarget<Target>: OnConflictTarget<T>, 
[src]

Adds an ON CONFLICT to the insert statement, if a conflict occurs for the given unique constraint.

Target can be one of:

Examples

Specifying a column as the target

conn.execute("CREATE UNIQUE INDEX users_name ON users (name)").unwrap();
let user = User { id: 1, name: "Sean", };
let same_name_different_id = User { id: 2, name: "Sean" };
let same_id_different_name = User { id: 1, name: "Pascal" };

assert_eq!(Ok(1), diesel::insert_into(users).values(&user).execute(&conn));

let inserted_row_count = diesel::insert_into(users)
    .values(&same_name_different_id)
    .on_conflict(name)
    .do_nothing()
    .execute(&conn);
assert_eq!(Ok(0), inserted_row_count);

let pk_conflict_result = diesel::insert_into(users)
    .values(&same_id_different_name)
    .on_conflict(name)
    .do_nothing()
    .execute(&conn);
assert!(pk_conflict_result.is_err());

Specifying multiple columns as the target

use diesel::upsert::*;

conn.execute("CREATE UNIQUE INDEX users_name_hair_color ON users (name, hair_color)").unwrap();
let user = User { id: 1, name: "Sean", hair_color: "black" };
let same_name_different_hair_color = User { id: 2, name: "Sean", hair_color: "brown" };
let same_name_same_hair_color = User { id: 3, name: "Sean", hair_color: "black" };

assert_eq!(Ok(1), diesel::insert_into(users).values(&user).execute(&conn));

let inserted_row_count = diesel::insert_into(users)
    .values(&same_name_different_hair_color)
    .on_conflict((name, hair_color))
    .do_nothing()
    .execute(&conn);
assert_eq!(Ok(1), inserted_row_count);

let inserted_row_count = diesel::insert_into(users)
    .values(&same_name_same_hair_color)
    .on_conflict((name, hair_color))
    .do_nothing()
    .execute(&conn);
assert_eq!(Ok(0), inserted_row_count);

See the documentation for on_constraint and do_update for more examples.

Trait Implementations

impl<T, U, Op> AsQuery for InsertStatement<T, U, Op, NoReturningClause> where
    T: Table,
    InsertStatement<T, U, Op, ReturningClause<T::AllColumns>>: Query
[src]

type SqlType = <Self::Query as Query>::SqlType

The SQL type of Self::Query

type Query = InsertStatement<T, U, Op, ReturningClause<T::AllColumns>>

What kind of query does this type represent?

impl<T: Clone, U: Clone, Op: Clone, Ret: Clone> Clone for InsertStatement<T, U, Op, Ret>[src]

impl<T: Copy, U: Copy, Op: Copy, Ret: Copy> Copy for InsertStatement<T, U, Op, Ret>[src]

impl<T: Debug, U: Debug, Op: Debug, Ret: Debug> Debug for InsertStatement<T, U, Op, Ret>[src]

impl<'a, T, U, Op, C> ExecuteDsl<C, Sqlite> for InsertStatement<T, BatchInsert<'a, U, T>, Op> where
    C: Connection<Backend = Sqlite>,
    &'a U: Insertable<T>,
    InsertStatement<T, <&'a U as Insertable<T>>::Values, Op>: QueryFragment<Sqlite>,
    T: Copy,
    Op: Copy
[src]

impl<T, U, Op, C> ExecuteDsl<C, Sqlite> for InsertStatement<T, OwnedBatchInsert<ValuesClause<U, T>, T>, Op> where
    C: Connection<Backend = Sqlite>,
    InsertStatement<T, ValuesClause<U, T>, Op>: QueryFragment<Sqlite>,
    T: Copy,
    Op: Copy
[src]

impl<T, U, Op, Ret> Query for InsertStatement<T, U, Op, ReturningClause<Ret>> where
    Ret: Expression + SelectableExpression<T> + NonAggregate
[src]

type SqlType = Ret::SqlType

The SQL type that this query represents. Read more

impl<T, U, Op, Ret, DB> QueryFragment<DB> for InsertStatement<T, U, Op, Ret> where
    DB: Backend,
    T: Table,
    T::FromClause: QueryFragment<DB>,
    U: QueryFragment<DB> + CanInsertInSingleQuery<DB>,
    Op: QueryFragment<DB>,
    Ret: QueryFragment<DB>, 
[src]

impl<T, U, Op, Ret> QueryId for InsertStatement<T, U, Op, Ret>[src]

type QueryId = ()

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

impl<T, U, Op, Ret, Conn> RunQueryDsl<Conn> for InsertStatement<T, U, Op, Ret>[src]

Auto Trait Implementations

impl<T, U, Op, Ret> RefUnwindSafe for InsertStatement<T, U, Op, Ret> where
    Op: RefUnwindSafe,
    Ret: RefUnwindSafe,
    T: RefUnwindSafe,
    U: RefUnwindSafe

impl<T, U, Op, Ret> Send for InsertStatement<T, U, Op, Ret> where
    Op: Send,
    Ret: Send,
    T: Send,
    U: Send

impl<T, U, Op, Ret> Sync for InsertStatement<T, U, Op, Ret> where
    Op: Sync,
    Ret: Sync,
    T: Sync,
    U: Sync

impl<T, U, Op, Ret> Unpin for InsertStatement<T, U, Op, Ret> where
    Op: Unpin,
    Ret: Unpin,
    T: Unpin,
    U: Unpin

impl<T, U, Op, Ret> UnwindSafe for InsertStatement<T, U, Op, Ret> where
    Op: UnwindSafe,
    Ret: UnwindSafe,
    T: UnwindSafe,
    U: UnwindSafe

Blanket Implementations

impl<T> Any for T where
    T: 'static + ?Sized
[src]

impl<T> AsQuery for T where
    T: Query
[src]

type SqlType = <T as Query>::SqlType

The SQL type of Self::Query

type Query = T

What kind of query does this type represent?

impl<T> Borrow<T> for T where
    T: ?Sized
[src]

impl<T> BorrowMut<T> for T where
    T: ?Sized
[src]

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

impl<T> From<T> for T[src]

impl<T, U> Into<U> for T where
    U: From<T>, 
[src]

impl<T> IntoSql for T[src]

impl<Conn, T, U> LoadQuery<Conn, U> for T where
    Conn: Connection,
    T: AsQuery + RunQueryDsl<Conn>,
    U: FromSqlRow<<T as AsQuery>::SqlType, <Conn as Connection>::Backend>,
    <T as AsQuery>::Query: QueryFragment<<Conn as Connection>::Backend>,
    <T as AsQuery>::Query: QueryId,
    <Conn as Connection>::Backend: QueryMetadata<<T as AsQuery>::SqlType>, 
[src]

impl<T, Conn> RunQueryDsl<Conn> for T where
    T: Table
[src]

impl<T> ToOwned for T where
    T: Clone
[src]

type Owned = T

The resulting type after obtaining ownership.

impl<T, U> TryFrom<U> for T where
    U: Into<T>, 
[src]

type Error = Infallible

The type returned in the event of a conversion error.

impl<T, U> TryInto<U> for T where
    U: TryFrom<T>, 
[src]

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

The type returned in the event of a conversion error.

impl<V, T> VZip<V> for T where
    V: MultiLane<T>, 
[src]