Packages

trait SqlProfile extends RelationalProfile with SqlTableComponent with SqlActionComponent with SqlUtilsComponent

Abstract profile for SQL-based databases.

Source
SqlProfile.scala
Linear Supertypes
SqlUtilsComponent, SqlActionComponent, SqlTableComponent, RelationalProfile, 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
Type Hierarchy
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. SqlProfile
  2. SqlUtilsComponent
  3. SqlActionComponent
  4. SqlTableComponent
  5. RelationalProfile
  6. RelationalActionComponent
  7. RelationalTypesComponent
  8. RelationalSequenceComponent
  9. RelationalTableComponent
  10. BasicProfile
  11. BasicActionComponent
  12. AnyRef
  13. 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. 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. class FastPathExtensionMethods[M <: ResultConverterDomain, T, P] extends AnyRef
    Definition Classes
    RelationalProfile
  8. trait RelationalAPI extends BasicAPI with RelationalImplicitColumnTypes
    Definition Classes
    RelationalProfile
  9. class TableQueryExtensionMethods[T <: Table[_], U] extends AnyRef
    Definition Classes
    RelationalProfile
  10. class Sequence[T] extends AnyRef
    Definition Classes
    RelationalSequenceComponent
  11. trait RelationalColumnOptions extends AnyRef
    Definition Classes
    RelationalTableComponent
  12. abstract class Table[T] extends AbstractTable[T]
    Definition Classes
    RelationalTableComponent
  13. trait MappedColumnTypeFactory extends AnyRef
    Definition Classes
    RelationalTypesComponent
  14. trait RelationalImplicitColumnTypes extends AnyRef
    Definition Classes
    RelationalTypesComponent
  15. abstract type Backend <: RelationalBackend

    The back-end type required by this profile

    The back-end type required by this profile

    Definition Classes
    RelationalProfile → BasicProfile
  16. abstract type BaseColumnType[T] <: ColumnType[T] with BaseTypedType[T]
    Definition Classes
    RelationalTypesComponent
  17. abstract type ColumnType[T] <: TypedType[T]
    Definition Classes
    RelationalTypesComponent
  18. 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
  19. trait DDL extends SchemaDescriptionDef
  20. abstract type InsertActionExtensionMethods[T] <: InsertActionExtensionMethodsImpl[T]
    Definition Classes
    RelationalActionComponent
  21. abstract type ProfileAction[+R, +S <: NoStream, -E <: Effect] <: SqlAction[R, S, E]
    Definition Classes
    SqlActionComponent → BasicActionComponent
  22. abstract type QueryActionExtensionMethods[R, S <: NoStream] <: BasicQueryActionExtensionMethodsImpl[R, S]
    Definition Classes
    BasicActionComponent
  23. abstract type SchemaActionExtensionMethods <: RelationalSchemaActionExtensionMethodsImpl
    Definition Classes
    RelationalActionComponent
  24. type SchemaDescription = DDL

    The type of a schema description (DDL)

    The type of a schema description (DDL)

    Definition Classes
    SqlProfile → BasicProfile
  25. abstract type StreamingProfileAction[+R, +T, -E <: Effect] <: SqlStreamingAction[R, T, E] with ProfileAction[R, Streaming[T], E]
    Definition Classes
    SqlActionComponent → BasicActionComponent
  26. abstract type StreamingQueryActionExtensionMethods[R, T] <: BasicStreamingQueryActionExtensionMethodsImpl[R, T]
    Definition Classes
    BasicActionComponent
  27. trait SqlColumnOptions extends SqlProfile.RelationalColumnOptions
    Definition Classes
    SqlTableComponent
  28. class QuotingSymbolNamer extends SymbolNamer
    Definition Classes
    SqlUtilsComponent

Deprecated Type Members

  1. final type DriverAction[+R, +S <: NoStream, -E <: Effect] = ProfileAction[R, S, E]
    Definition Classes
    BasicActionComponent
    Annotations
    @deprecated
    Deprecated

    (Since version 3.2) Use ProfileAction instead of DriverAction

  2. final type StreamingDriverAction[+R, +T, -E <: Effect] = StreamingProfileAction[R, T, E]
    Definition Classes
    BasicActionComponent
    Annotations
    @deprecated
    Deprecated

    (Since version 3.2) Use StreamingProfileAction instead of StreamingDriverAction

Abstract Value Members

  1. abstract val MappedColumnType: MappedColumnTypeFactory
    Definition Classes
    RelationalTypesComponent
  2. 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
  3. abstract val backend: Backend

    The back-end implementation for this profile

    The back-end implementation for this profile

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

    (Partially) compile an AST for insert operations

    (Partially) compile an AST for insert operations

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

    The compiler used for deleting data

    The compiler used for deleting data

    Definition Classes
    BasicProfile
  12. abstract def insertCompiler: QueryCompiler

    The compiler used for inserting data

    The compiler used for inserting data

    Definition Classes
    BasicProfile
  13. abstract def queryCompiler: QueryCompiler

    The compiler used for queries

    The compiler used for queries

    Definition Classes
    BasicProfile
  14. abstract def runSynchronousQuery[R](tree: Node, param: Any)(implicit session: relational.RelationalProfile.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.

    Definition Classes
    RelationalProfile
  15. abstract def updateCompiler: QueryCompiler

    The compiler used for updates

    The compiler used for updates

    Definition Classes
    BasicProfile

Concrete Value Members

  1. object Sequence
    Definition Classes
    RelationalSequenceComponent
  2. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  3. final def ##: Int
    Definition Classes
    AnyRef → Any
  4. def ->[B](y: B): (SqlProfile, B)
    Implicit
    This member is added by an implicit conversion from SqlProfile toArrowAssoc[SqlProfile] 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. 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
  8. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native() @HotSpotIntrinsicCandidate()
  9. val columnOptions: SqlColumnOptions
    Definition Classes
    SqlTableComponent → RelationalTableComponent
  10. final lazy val compiler: QueryCompiler
    Definition Classes
    RelationalProfile
  11. def computeCapabilities: Set[Capability]

    Compute the capabilities.

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

    Attributes
    protected
    Definition Classes
    SqlProfile → RelationalProfile → BasicProfile
  12. def computeQueryCompiler: QueryCompiler
    Attributes
    protected
    Definition Classes
    SqlProfile → RelationalProfile
  13. def ensuring(cond: (SqlProfile) => Boolean, msg: => Any): SqlProfile
    Implicit
    This member is added by an implicit conversion from SqlProfile toEnsuring[SqlProfile] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  14. def ensuring(cond: (SqlProfile) => Boolean): SqlProfile
    Implicit
    This member is added by an implicit conversion from SqlProfile toEnsuring[SqlProfile] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  15. def ensuring(cond: Boolean, msg: => Any): SqlProfile
    Implicit
    This member is added by an implicit conversion from SqlProfile toEnsuring[SqlProfile] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  16. def ensuring(cond: Boolean): SqlProfile
    Implicit
    This member is added by an implicit conversion from SqlProfile toEnsuring[SqlProfile] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  17. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  18. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  19. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  20. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  21. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  22. def likeEncode(s: String): String
    Definition Classes
    SqlUtilsComponent
  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
    @native() @HotSpotIntrinsicCandidate()
  26. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  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. def quoteIdentifier(id: String): String

    quotes identifiers to avoid collisions with SQL keywords and other syntax issues

    quotes identifiers to avoid collisions with SQL keywords and other syntax issues

    Definition Classes
    SqlUtilsComponent
  29. def quoteTableName(t: TableNode): String
    Definition Classes
    SqlUtilsComponent
  30. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  31. def toString(): String
    Definition Classes
    BasicProfile → AnyRef → Any
  32. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  33. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  34. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  35. object DDL

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable]) @Deprecated
    Deprecated
  2. def formatted(fmtstr: String): String
    Implicit
    This member is added by an implicit conversion from SqlProfile toStringFormat[SqlProfile] 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. val profile: SqlProfile

    The external interface of this profile which defines the API.

    The external interface of this profile which defines the API.

    Definition Classes
    SqlProfile → RelationalProfile → BasicProfile
    Annotations
    @deprecated
    Deprecated

    (Since version 3.2) Use the Profile object directly instead of calling .profile on it

  4. def →[B](y: B): (SqlProfile, B)
    Implicit
    This member is added by an implicit conversion from SqlProfile toArrowAssoc[SqlProfile] 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 SqlUtilsComponent

Inherited from SqlActionComponent

Inherited from SqlTableComponent

Inherited from RelationalProfile

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 StringFormat fromSqlProfile to StringFormat[SqlProfile]

Inherited by implicit conversion Ensuring fromSqlProfile to Ensuring[SqlProfile]

Inherited by implicit conversion ArrowAssoc fromSqlProfile to ArrowAssoc[SqlProfile]

Ungrouped