Packages

trait RelationalProfile extends BasicProfile with RelationalTableComponent with RelationalSequenceComponent with RelationalTypesComponent with RelationalActionComponent

A profile for relational databases that does not assume the existence of SQL (or any other text-based language for executing statements). It requires a relational table structure as its basic model of data.

Self Type
RelationalProfile
Source
RelationalProfile.scala
Linear Supertypes
RelationalActionComponent, RelationalTypesComponent, RelationalSequenceComponent, RelationalTableComponent, BasicProfile, BasicActionComponent, AnyRef, Any
Known Subclasses
DB2Profile, DB2Profile, DerbyProfile, DerbyProfile, H2Profile, H2Profile, HsqldbProfile, HsqldbProfile, JdbcProfile, MySQLProfile, MySQLProfile, OracleProfile, OracleProfile, PostgresProfile, PostgresProfile, SQLServerProfile, SQLServerProfile, SQLiteProfile, SQLiteProfile, MemoryProfile, MemoryProfile, SqlProfile
Type Hierarchy
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. RelationalProfile
  2. RelationalActionComponent
  3. RelationalTypesComponent
  4. RelationalSequenceComponent
  5. RelationalTableComponent
  6. BasicProfile
  7. BasicActionComponent
  8. AnyRef
  9. Any
Implicitly
  1. by any2stringadd
  2. by StringFormat
  3. by Ensuring
  4. by ArrowAssoc
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Type Members

  1. trait BasicQueryActionExtensionMethodsImpl[R, S <: NoStream] extends AnyRef
    Definition Classes
    BasicActionComponent
  2. trait BasicStreamingQueryActionExtensionMethodsImpl[R, T] extends BasicProfile.BasicQueryActionExtensionMethodsImpl[R, Streaming[T]]
    Definition Classes
    BasicActionComponent
  3. trait BasicAPI extends Aliases with ExtensionMethodConversions
    Definition Classes
    BasicProfile
  4. trait SchemaDescriptionDef extends AnyRef

    A schema description contains the SQL statements for creating and dropping database entities.

    A schema description contains the SQL statements for creating and dropping database entities. Schema descriptions can be combined for creating or dropping multiple entities together, even if they have circular dependencies.

    Definition Classes
    BasicProfile
  5. trait InsertActionExtensionMethodsImpl[T] extends AnyRef
    Definition Classes
    RelationalActionComponent
  6. trait RelationalSchemaActionExtensionMethodsImpl extends AnyRef
    Definition Classes
    RelationalActionComponent
  7. abstract type Backend <: RelationalBackend

    The back-end type required by this profile

    The back-end type required by this profile

    Definition Classes
    RelationalProfile → BasicProfile
  8. abstract type BaseColumnType[T] <: ColumnType[T] with BaseTypedType[T]
    Definition Classes
    RelationalTypesComponent
  9. abstract type ColumnType[T] <: TypedType[T]
    Definition Classes
    RelationalTypesComponent
  10. abstract type CompiledInsert

    The type of a (partially) compiled AST for Insert operations.

    The type of a (partially) compiled AST for Insert operations. Unlike querying or deleting, inserts may require different compilation results which should be computed lazily.

    Definition Classes
    BasicProfile
  11. class FastPathExtensionMethods[R, W, U, T] extends AnyRef
  12. abstract type InsertActionExtensionMethods[T] <: InsertActionExtensionMethodsImpl[T]
    Definition Classes
    RelationalActionComponent
  13. abstract type ProfileAction[+R, +S <: NoStream, -E <: Effect] <: BasicAction[R, S, E]
    Definition Classes
    BasicActionComponent
  14. abstract type QueryActionExtensionMethods[R, S <: NoStream] <: BasicQueryActionExtensionMethodsImpl[R, S]
    Definition Classes
    BasicActionComponent
  15. trait RelationalAPI extends BasicAPI with RelationalImplicitColumnTypes
  16. abstract type ResultConverterReader
  17. abstract type ResultConverterUpdater
  18. abstract type ResultConverterWriter
  19. abstract type SchemaActionExtensionMethods <: RelationalSchemaActionExtensionMethodsImpl
    Definition Classes
    RelationalActionComponent
  20. abstract type SchemaDescription <: SchemaDescriptionDef

    The type of a schema description (DDL)

    The type of a schema description (DDL)

    Definition Classes
    BasicProfile
  21. abstract type StreamingProfileAction[+R, +T, -E <: Effect] <: BasicStreamingAction[R, T, E] with ProfileAction[R, Streaming[T], E]
    Definition Classes
    BasicActionComponent
  22. abstract type StreamingQueryActionExtensionMethods[R, T] <: BasicStreamingQueryActionExtensionMethodsImpl[R, T]
    Definition Classes
    BasicActionComponent
  23. class TableQueryExtensionMethods[T <: Table[_], U] extends AnyRef
  24. class Sequence[T] extends AnyRef
    Definition Classes
    RelationalSequenceComponent
  25. trait RelationalColumnOptions extends AnyRef
    Definition Classes
    RelationalTableComponent
  26. abstract class Table[T] extends AbstractTable[T]
    Definition Classes
    RelationalTableComponent
  27. trait MappedColumnTypeFactory extends AnyRef
    Definition Classes
    RelationalTypesComponent
  28. trait RelationalImplicitColumnTypes extends AnyRef
    Definition Classes
    RelationalTypesComponent

Abstract Value Members

  1. abstract val api: RelationalAPI

    The API for using the query language with a single import statement.

    The API for using the query language with a single import statement. This provides the profile's implicits, the Database API and commonly used query language types and objects.

    Definition Classes
    RelationalProfile → BasicProfile
  2. abstract val backend: Backend

    The back-end implementation for this profile

    The back-end implementation for this profile

    Definition Classes
    BasicProfile
  3. abstract def buildSequenceSchemaDescription(seq: Sequence[_]): SchemaDescription
    Definition Classes
    RelationalSequenceComponent
  4. abstract def buildTableSchemaDescription(table: Table[_]): SchemaDescription
    Definition Classes
    RelationalTableComponent
  5. abstract def compileInsert(n: Node): CompiledInsert

    (Partially) compile an AST for insert operations

    (Partially) compile an AST for insert operations

    Definition Classes
    BasicProfile
  6. abstract def createInsertActionExtensionMethods[T](compiled: CompiledInsert): InsertActionExtensionMethods[T]
    Definition Classes
    RelationalActionComponent
  7. abstract def createQueryActionExtensionMethods[R, S <: NoStream](tree: Node, param: Any): QueryActionExtensionMethods[R, S]
    Definition Classes
    BasicActionComponent
  8. abstract def createSchemaActionExtensionMethods(schema: SchemaDescription): SchemaActionExtensionMethods
    Definition Classes
    RelationalActionComponent
  9. abstract def createStreamingQueryActionExtensionMethods[R, T](tree: Node, param: Any): StreamingQueryActionExtensionMethods[R, T]
    Definition Classes
    BasicActionComponent
  10. abstract def deleteCompiler: QueryCompiler

    The compiler used for deleting data

    The compiler used for deleting data

    Definition Classes
    BasicProfile
  11. abstract def insertCompiler: QueryCompiler

    The compiler used for inserting data

    The compiler used for inserting data

    Definition Classes
    BasicProfile
  12. abstract def queryCompiler: QueryCompiler

    The compiler used for queries

    The compiler used for queries

    Definition Classes
    BasicProfile
  13. abstract def runSynchronousQuery[R](tree: Node, param: Any)(implicit session: Backend.Session): R

    Run a query synchronously on the provided session.

    Run a query synchronously on the provided session. This is used by DistributedProfile until we can make it fully asynchronous.

  14. abstract def updateCompiler: QueryCompiler

    The compiler used for updates

    The compiler used for updates

    Definition Classes
    BasicProfile

Concrete Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##: Int
    Definition Classes
    AnyRef → Any
  3. def +(other: String): String
    Implicit
    This member is added by an implicit conversion from RelationalProfile toany2stringadd[RelationalProfile] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. def ->[B](y: B): (RelationalProfile, B)
    Implicit
    This member is added by an implicit conversion from RelationalProfile toArrowAssoc[RelationalProfile] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()
  5. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  6. lazy val MappedColumnType: MappedColumnTypeFactory
    Definition Classes
    RelationalTypesComponent
  7. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  8. final val capabilities: Set[Capability]

    The capabilities supported by this profile.

    The capabilities supported by this profile. This can be used to query at runtime whether a specific feature is supported.

    Definition Classes
    BasicProfile
  9. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @HotSpotIntrinsicCandidate() @native()
  10. val columnOptions: RelationalColumnOptions
    Definition Classes
    RelationalTableComponent
  11. final lazy val compiler: QueryCompiler
  12. def computeCapabilities: Set[Capability]

    Compute the capabilities.

    Compute the capabilities. This should be overridden in subclasses as needed.

    Attributes
    protected
    Definition Classes
    RelationalProfile → BasicProfile
  13. def computeQueryCompiler: QueryCompiler
    Attributes
    protected
  14. def ensuring(cond: (RelationalProfile) => Boolean, msg: => Any): RelationalProfile
    Implicit
    This member is added by an implicit conversion from RelationalProfile toEnsuring[RelationalProfile] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  15. def ensuring(cond: (RelationalProfile) => Boolean): RelationalProfile
    Implicit
    This member is added by an implicit conversion from RelationalProfile toEnsuring[RelationalProfile] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  16. def ensuring(cond: Boolean, msg: => Any): RelationalProfile
    Implicit
    This member is added by an implicit conversion from RelationalProfile toEnsuring[RelationalProfile] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  17. def ensuring(cond: Boolean): RelationalProfile
    Implicit
    This member is added by an implicit conversion from RelationalProfile toEnsuring[RelationalProfile] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  18. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  19. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  20. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  21. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  22. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  23. def loadProfileConfig: Config

    Load the configuration for this profile.

    Load the configuration for this profile. This can be overridden in user-defined subclasses to load different configurations.

    The default implementation does a breadth-first search in the supertype hierarchy of the runtime class until it finds a class or trait with a name matching "slick.[...]Profile" and then returns uses this name as a path in the application config. If no configuration exists at this path, an empty Config object is returned.

    Attributes
    protected[this]
    Definition Classes
    BasicProfile
  24. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  25. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  26. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  27. final lazy val profileConfig: Config

    The configuration for this profile, loaded via loadProfileConfig.

    The configuration for this profile, loaded via loadProfileConfig.

    Attributes
    protected[this]
    Definition Classes
    BasicProfile
  28. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  29. def toString(): String
    Definition Classes
    BasicProfile → AnyRef → Any
  30. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  31. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  32. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  33. object Sequence
    Definition Classes
    RelationalSequenceComponent

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 RelationalProfile toStringFormat[RelationalProfile] 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): (RelationalProfile, B)
    Implicit
    This member is added by an implicit conversion from RelationalProfile toArrowAssoc[RelationalProfile] 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 RelationalActionComponent

Inherited from RelationalTypesComponent

Inherited from RelationalSequenceComponent

Inherited from RelationalTableComponent

Inherited from BasicProfile

Inherited from BasicActionComponent

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd fromRelationalProfile to any2stringadd[RelationalProfile]

Inherited by implicit conversion StringFormat fromRelationalProfile to StringFormat[RelationalProfile]

Inherited by implicit conversion Ensuring fromRelationalProfile to Ensuring[RelationalProfile]

Inherited by implicit conversion ArrowAssoc fromRelationalProfile to ArrowAssoc[RelationalProfile]

Ungrouped