trait SqlProfile extends RelationalProfile with SqlTableComponent with SqlActionComponent with SqlUtilsComponent
Abstract profile for SQL-based databases.
- Source
- SqlProfile.scala
- Alphabetic
- By Inheritance
- SqlProfile
- SqlUtilsComponent
- SqlActionComponent
- SqlTableComponent
- RelationalProfile
- RelationalActionComponent
- RelationalTypesComponent
- RelationalSequenceComponent
- RelationalTableComponent
- BasicProfile
- BasicActionComponent
- AnyRef
- Any
- by any2stringadd
- by StringFormat
- by Ensuring
- by ArrowAssoc
- Hide All
- Show All
- Public
- Protected
Type Members
- trait QueryActionExtensionMethodsImpl[R, S <: NoStream] extends AnyRef
- Definition Classes
- BasicActionComponent
- trait StreamingQueryActionExtensionMethodsImpl[R, T] extends BasicProfile.QueryActionExtensionMethodsImpl[R, Streaming[T]]
- Definition Classes
- BasicActionComponent
- 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
- trait InsertActionExtensionMethodsImpl[T] extends AnyRef
- Definition Classes
- RelationalActionComponent
- trait SchemaActionExtensionMethodsImpl extends AnyRef
- Definition Classes
- RelationalActionComponent
- trait API extends RelationalProfile.API with ImplicitColumnTypes
- Definition Classes
- RelationalProfile
- class FastPathExtensionMethods[M <: ResultConverterDomain, T, P] extends AnyRef
- Definition Classes
- RelationalProfile
- class TableQueryExtensionMethods[T <: Table[_], U] extends AnyRef
- Definition Classes
- RelationalProfile
- class Sequence[T] extends AnyRef
- Definition Classes
- RelationalSequenceComponent
- abstract class Table[T] extends AbstractTable[T]
- Definition Classes
- RelationalTableComponent
- trait ImplicitColumnTypes extends AnyRef
- Definition Classes
- RelationalTypesComponent
- trait MappedColumnTypeFactory extends AnyRef
- Definition Classes
- RelationalTypesComponent
- abstract type Backend <: RelationalBackend
The back-end type required by this profile
The back-end type required by this profile
- Definition Classes
- RelationalProfile → BasicProfile
- abstract type BaseColumnType[T] <: ColumnType[T] with BaseTypedType[T]
- Definition Classes
- RelationalTypesComponent
- abstract type ColumnType[T] <: TypedType[T]
- Definition Classes
- RelationalTypesComponent
- 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
- trait DDL extends SchemaDescriptionDef
- abstract type InsertActionExtensionMethods[T] <: InsertActionExtensionMethodsImpl[T]
- Definition Classes
- RelationalActionComponent
- abstract type ProfileAction[+R, +S <: NoStream, -E <: Effect] <: SqlAction[R, S, E]
- Definition Classes
- SqlActionComponent → BasicActionComponent
- abstract type QueryActionExtensionMethods[R, S <: NoStream] <: QueryActionExtensionMethodsImpl[R, S]
- Definition Classes
- BasicActionComponent
- abstract type SchemaActionExtensionMethods <: SchemaActionExtensionMethodsImpl
- Definition Classes
- RelationalActionComponent
- type SchemaDescription = DDL
The type of a schema description (DDL)
The type of a schema description (DDL)
- Definition Classes
- SqlProfile → BasicProfile
- abstract type StreamingProfileAction[+R, +T, -E <: Effect] <: SqlStreamingAction[R, T, E] with ProfileAction[R, Streaming[T], E]
- Definition Classes
- SqlActionComponent → BasicActionComponent
- abstract type StreamingQueryActionExtensionMethods[R, T] <: StreamingQueryActionExtensionMethodsImpl[R, T]
- Definition Classes
- BasicActionComponent
- trait ColumnOptions extends SqlProfile.ColumnOptions
- Definition Classes
- SqlTableComponent
- class QuotingSymbolNamer extends SymbolNamer
- Definition Classes
- SqlUtilsComponent
Deprecated Type Members
- final type DriverAction[+R, +S <: NoStream, -E <: Effect] = ProfileAction[R, S, E]
- Definition Classes
- BasicActionComponent
- Annotations
- @deprecated
- Deprecated
(Since version 3.2) Use
ProfileActioninstead ofDriverAction
- final type StreamingDriverAction[+R, +T, -E <: Effect] = StreamingProfileAction[R, T, E]
- Definition Classes
- BasicActionComponent
- Annotations
- @deprecated
- Deprecated
(Since version 3.2) Use
StreamingProfileActioninstead ofStreamingDriverAction
Abstract Value Members
- abstract val MappedColumnType: MappedColumnTypeFactory
- Definition Classes
- RelationalTypesComponent
- abstract val api: API
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
- abstract val backend: Backend
The back-end implementation for this profile
The back-end implementation for this profile
- Definition Classes
- BasicProfile
- abstract def buildSequenceSchemaDescription(seq: Sequence[_]): SchemaDescription
- Definition Classes
- RelationalSequenceComponent
- abstract def buildTableSchemaDescription(table: Table[_]): SchemaDescription
- Definition Classes
- RelationalTableComponent
- abstract def compileInsert(n: Node): CompiledInsert
(Partially) compile an AST for insert operations
(Partially) compile an AST for insert operations
- Definition Classes
- BasicProfile
- abstract def createInsertActionExtensionMethods[T](compiled: CompiledInsert): InsertActionExtensionMethods[T]
- Definition Classes
- RelationalActionComponent
- abstract def createQueryActionExtensionMethods[R, S <: NoStream](tree: Node, param: Any): QueryActionExtensionMethods[R, S]
- Definition Classes
- BasicActionComponent
- abstract def createSchemaActionExtensionMethods(schema: SchemaDescription): SchemaActionExtensionMethods
- Definition Classes
- RelationalActionComponent
- abstract def createStreamingQueryActionExtensionMethods[R, T](tree: Node, param: Any): StreamingQueryActionExtensionMethods[R, T]
- Definition Classes
- BasicActionComponent
- abstract def deleteCompiler: QueryCompiler
The compiler used for deleting data
The compiler used for deleting data
- Definition Classes
- BasicProfile
- abstract def insertCompiler: QueryCompiler
The compiler used for inserting data
The compiler used for inserting data
- Definition Classes
- BasicProfile
- abstract def queryCompiler: QueryCompiler
The compiler used for queries
The compiler used for queries
- Definition Classes
- BasicProfile
- 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
- abstract def updateCompiler: QueryCompiler
The compiler used for updates
The compiler used for updates
- Definition Classes
- BasicProfile
Concrete Value Members
- object Sequence
- Definition Classes
- RelationalSequenceComponent
- final def !=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def ##: Int
- Definition Classes
- AnyRef → Any
- def +(other: String): String
- Implicit
- This member is added by an implicit conversion from SqlProfile toany2stringadd[SqlProfile] performed by method any2stringadd in scala.Predef.
- Definition Classes
- any2stringadd
- 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()
- final def ==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- 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
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @native() @HotSpotIntrinsicCandidate()
- val columnOptions: ColumnOptions
- Definition Classes
- SqlTableComponent → RelationalTableComponent
- final lazy val compiler: QueryCompiler
- Definition Classes
- RelationalProfile
- 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
- def computeQueryCompiler: QueryCompiler
- Attributes
- protected
- Definition Classes
- SqlProfile → RelationalProfile
- 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
- 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
- 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
- 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
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def equals(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef → Any
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- def hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- def likeEncode(s: String): String
- Definition Classes
- SqlUtilsComponent
- 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
- final def ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- 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
- 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
- def quoteTableName(t: TableNode): String
- Definition Classes
- SqlUtilsComponent
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- def toString(): String
- Definition Classes
- BasicProfile → AnyRef → Any
- final def wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException]) @native()
- final def wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- object DDL
Deprecated Value Members
- def finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.Throwable]) @Deprecated
- Deprecated
- 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 ofvalue.formatted(formatString), or use thef""string interpolator. In Java 15 and later,formattedresolves to the new method in String which has reversed parameters.
- 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
.profileon it
- 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.
edit this text on github
Scala Language-Integrated Connection Kit
This is the API documentation for the Slick database library. It should be used as an additional resource to the user manual.
Further documentation for Slick can be found on the documentation pages.
To the slick package list...