t

slick.jdbc.JdbcActionComponent

ReturningInsertActionComposer

trait ReturningInsertActionComposer[U, RU] extends JdbcProfile.InsertActionComposer[U] with JdbcProfile.IntoInsertActionComposer[U, RU]

An InsertActionComposer that returns generated keys or other columns.

Self Type
JdbcProfile.ReturningInsertActionComposer[U, RU]
Source
JdbcActionComponent.scala
Linear Supertypes
JdbcProfile.IntoInsertActionComposer[U, RU], JdbcProfile.InsertActionComposer[U], JdbcProfile.SimpleInsertActionComposer[U], JdbcProfile.InsertActionExtensionMethodsImpl[U], AnyRef, Any
Known Subclasses
ReturningInsertActionComposerImpl
Type Hierarchy
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. ReturningInsertActionComposer
  2. IntoInsertActionComposer
  3. InsertActionComposer
  4. SimpleInsertActionComposer
  5. InsertActionExtensionMethodsImpl
  6. AnyRef
  7. Any
Implicitly
  1. by StringFormat
  2. by Ensuring
  3. by ArrowAssoc
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Type Members

  1. type MultiInsertResult = Seq[RU]

    The result type when inserting a collection of values.

    The result type when inserting a collection of values.

    Definition Classes
    IntoInsertActionComposer → InsertActionExtensionMethodsImpl
  2. type QueryInsertResult = Seq[RU]
    Definition Classes
    IntoInsertActionComposer
  3. type SingleInsertOrUpdateResult = Option[RU]

    The return type for insertOrUpdate operations.

    The return type for insertOrUpdate operations. Note that the Option return value will be None if it was an update and Some if it was an insert

    Definition Classes
    IntoInsertActionComposer → SimpleInsertActionComposer
  4. type SingleInsertResult = RU

    The result type when inserting a single value.

    The result type when inserting a single value.

    Definition Classes
    IntoInsertActionComposer → InsertActionExtensionMethodsImpl

Abstract Value Members

  1. abstract def +=(value: U): JdbcProfile.ProfileAction[SingleInsertResult, NoStream, Write]

    Insert a single row, skipping AutoInc columns.

    Insert a single row, skipping AutoInc columns.

    Definition Classes
    SimpleInsertActionComposer → InsertActionExtensionMethodsImpl
  2. abstract def forceInsert(value: U): JdbcProfile.ProfileAction[SingleInsertResult, NoStream, Write]

    Insert a single row, including AutoInc columns.

    Insert a single row, including AutoInc columns. This is not supported by all database engines (see slick.jdbc.JdbcCapabilities.forceInsert).

    Definition Classes
    SimpleInsertActionComposer
  3. abstract def forceInsertAll(values: Iterable[U]): JdbcProfile.ProfileAction[MultiInsertResult, NoStream, Write]

    Insert multiple rows, including AutoInc columns.

    Insert multiple rows, including AutoInc columns. This is not supported by all database engines (see slick.jdbc.JdbcCapabilities.forceInsert). Uses JDBC's batch update feature if supported by the JDBC driver. Returns Some(rowsAffected), or None if the database returned no row count for some part of the batch. If any part of the batch fails, an exception is thrown.

    Definition Classes
    SimpleInsertActionComposer
  4. abstract def forceInsertExpr[TT](c: TT)(implicit shape: Shape[_ <: FlatShapeLevel, TT, U, _]): JdbcProfile.ProfileAction[QueryInsertResult, NoStream, Write]

    Insert a single row from a scalar expression

    Insert a single row from a scalar expression

    Definition Classes
    InsertActionComposer
  5. abstract def forceInsertQuery[TT, C[_]](compiledQuery: CompiledStreamingExecutable[Query[TT, U, C], _, _]): JdbcProfile.ProfileAction[QueryInsertResult, NoStream, Write]

    Insert data produced by another query

    Insert data produced by another query

    Definition Classes
    InsertActionComposer
  6. abstract def forceInsertQuery[TT, C[_]](query: Query[TT, U, C]): JdbcProfile.ProfileAction[QueryInsertResult, NoStream, Write]

    Insert data produced by another query

    Insert data produced by another query

    Definition Classes
    InsertActionComposer
  7. abstract def forceInsertStatement: String

    Get the SQL statement for a forced insert

    Get the SQL statement for a forced insert

    Definition Classes
    SimpleInsertActionComposer
  8. abstract def forceInsertStatementFor[TT, C[_]](compiledQuery: CompiledStreamingExecutable[Query[TT, U, C], _, _]): String

    Get the SQL statement for inserting data produced by another query

    Get the SQL statement for inserting data produced by another query

    Definition Classes
    InsertActionComposer
  9. abstract def forceInsertStatementFor[TT, C[_]](query: Query[TT, U, C]): String

    Get the SQL statement for inserting data produced by another query

    Get the SQL statement for inserting data produced by another query

    Definition Classes
    InsertActionComposer
  10. abstract def forceInsertStatementFor[TT](c: TT)(implicit shape: Shape[_ <: FlatShapeLevel, TT, U, _]): String

    Get the SQL statement for inserting a single row from a scalar expression

    Get the SQL statement for inserting a single row from a scalar expression

    Definition Classes
    InsertActionComposer
  11. abstract def insertAll(values: Iterable[U], rowsPerStatement: JdbcProfile.RowsPerStatement = defaultRowsPerStatement): JdbcProfile.ProfileAction[MultiInsertResult, NoStream, Write]

    Insert multiple rows, skipping AutoInc columns.

    Insert multiple rows, skipping AutoInc columns.

    values

    the rows to insert

    rowsPerStatement

    RowsPerStatement.All to use a single statement to insert all rows at once, or RowsPerStatement.One to use a separate SQL statement for each row. Even so, if supported this will use JDBC's batching functionality.

    returns

    Some(rowsAffected), or None if the database returned no row count for some part of the batch. If any part of the batch fails, an exception is thrown.

    Definition Classes
    SimpleInsertActionComposer
  12. abstract def insertOrUpdate(value: U): JdbcProfile.ProfileAction[SingleInsertOrUpdateResult, NoStream, Write]

    Insert a single row if its primary key does not exist in the table, otherwise update the existing record.

    Insert a single row if its primary key does not exist in the table, otherwise update the existing record. Note that the return value will be None if an update was performed and Some if the operation was insert

    Definition Classes
    SimpleInsertActionComposer
  13. abstract def insertOrUpdateAll(values: Iterable[U], option: JdbcProfile.RowsPerStatement = defaultRowsPerStatement): JdbcProfile.ProfileAction[MultiInsertResult, NoStream, Write]

    Insert multiple rows if its primary key does not exist in the table, otherwise update the existing record.

    Insert multiple rows if its primary key does not exist in the table, otherwise update the existing record. Returns Some(rowsAffected), or None if the database returned no row count for some part of the batch. If any part of the batch fails, an exception is thrown. The option parameter specifies how the operation is to be performed.(default is RowsPerStatement.All) Note unlike insertOrUpdate, client-side emulation is not supported.

    Definition Classes
    SimpleInsertActionComposer
  14. abstract def insertStatement: String

    Get the SQL statement for a standard (soft) insert

    Get the SQL statement for a standard (soft) insert

    Definition Classes
    SimpleInsertActionComposer
  15. abstract def into[R](f: (U, RU) => R): JdbcProfile.IntoInsertActionComposer[U, R]

    Specifies a mapping from inserted values and generated keys to a desired value.

    Specifies a mapping from inserted values and generated keys to a desired value.

    R

    target type of the mapping

    f

    Function that maps inserted values and generated keys to a desired value.

Concrete Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##: Int
    Definition Classes
    AnyRef → Any
  3. final def ++=(values: Iterable[U]): JdbcProfile.ProfileAction[MultiInsertResult, NoStream, Write]

    Insert multiple rows, skipping AutoInc columns.

    Insert multiple rows, skipping AutoInc columns. Uses JDBC's batch update feature if supported by the JDBC driver. Returns Some(rowsAffected), or None if the database returned no row count for some part of the batch. If any part of the batch fails, an exception is thrown.

    This method is a shorthand for insertAll with RowsPerStatement.One.

    Definition Classes
    SimpleInsertActionComposer → InsertActionExtensionMethodsImpl
  4. def ->[B](y: B): (JdbcProfile.ReturningInsertActionComposer[U, RU], B)
    Implicit
    This member is added by an implicit conversion from JdbcProfile.ReturningInsertActionComposer[U, RU] toArrowAssoc[JdbcProfile.ReturningInsertActionComposer[U, RU]] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()
  5. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  6. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  7. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @HotSpotIntrinsicCandidate() @native()
  8. def ensuring(cond: (JdbcProfile.ReturningInsertActionComposer[U, RU]) => Boolean, msg: => Any): JdbcProfile.ReturningInsertActionComposer[U, RU]
    Implicit
    This member is added by an implicit conversion from JdbcProfile.ReturningInsertActionComposer[U, RU] toEnsuring[JdbcProfile.ReturningInsertActionComposer[U, RU]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  9. def ensuring(cond: (JdbcProfile.ReturningInsertActionComposer[U, RU]) => Boolean): JdbcProfile.ReturningInsertActionComposer[U, RU]
    Implicit
    This member is added by an implicit conversion from JdbcProfile.ReturningInsertActionComposer[U, RU] toEnsuring[JdbcProfile.ReturningInsertActionComposer[U, RU]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  10. def ensuring(cond: Boolean, msg: => Any): JdbcProfile.ReturningInsertActionComposer[U, RU]
    Implicit
    This member is added by an implicit conversion from JdbcProfile.ReturningInsertActionComposer[U, RU] toEnsuring[JdbcProfile.ReturningInsertActionComposer[U, RU]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  11. def ensuring(cond: Boolean): JdbcProfile.ReturningInsertActionComposer[U, RU]
    Implicit
    This member is added by an implicit conversion from JdbcProfile.ReturningInsertActionComposer[U, RU] toEnsuring[JdbcProfile.ReturningInsertActionComposer[U, RU]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  12. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  13. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  14. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  15. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  16. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  17. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  18. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  19. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  20. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  21. def toString(): String
    Definition Classes
    AnyRef → Any
  22. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  23. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  24. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable]) @Deprecated
    Deprecated

    (Since version 9)

  2. def formatted(fmtstr: String): String
    Implicit
    This member is added by an implicit conversion from JdbcProfile.ReturningInsertActionComposer[U, RU] toStringFormat[JdbcProfile.ReturningInsertActionComposer[U, RU]] performed by method StringFormat in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @deprecated @inline()
    Deprecated

    (Since version 2.12.16) Use formatString.format(value) instead of value.formatted(formatString), or use the f"" string interpolator. In Java 15 and later, formatted resolves to the new method in String which has reversed parameters.

  3. def →[B](y: B): (JdbcProfile.ReturningInsertActionComposer[U, RU], B)
    Implicit
    This member is added by an implicit conversion from JdbcProfile.ReturningInsertActionComposer[U, RU] toArrowAssoc[JdbcProfile.ReturningInsertActionComposer[U, RU]] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @deprecated
    Deprecated

    (Since version 2.13.0) Use -> instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.

Inherited from JdbcProfile.IntoInsertActionComposer[U, RU]

Inherited from JdbcProfile.InsertActionComposer[U]

Inherited from JdbcProfile.SimpleInsertActionComposer[U]

Inherited from JdbcProfile.InsertActionExtensionMethodsImpl[U]

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion StringFormat fromJdbcProfile.ReturningInsertActionComposer[U, RU] to StringFormat[JdbcProfile.ReturningInsertActionComposer[U, RU]]

Inherited by implicit conversion Ensuring fromJdbcProfile.ReturningInsertActionComposer[U, RU] to Ensuring[JdbcProfile.ReturningInsertActionComposer[U, RU]]

Inherited by implicit conversion ArrowAssoc fromJdbcProfile.ReturningInsertActionComposer[U, RU] to ArrowAssoc[JdbcProfile.ReturningInsertActionComposer[U, RU]]

Ungrouped