trait JdbcProfile extends SqlProfile with JdbcActionComponent with JdbcInvokerComponent with JdbcTypesComponent with JdbcModelComponent with JdbcStatementBuilderComponent with JdbcMappingCompilerComponent
Abstract profile for accessing SQL databases via JDBC.
- Source
- JdbcProfile.scala
- Alphabetic
- By Inheritance
- JdbcProfile
- JdbcMappingCompilerComponent
- JdbcStatementBuilderComponent
- JdbcModelComponent
- JdbcTypesComponent
- JdbcInvokerComponent
- JdbcActionComponent
- 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 BasicQueryActionExtensionMethodsImpl[R, S <: NoStream] extends AnyRef
- Definition Classes
- BasicActionComponent
- trait BasicStreamingQueryActionExtensionMethodsImpl[R, T] extends BasicProfile.BasicQueryActionExtensionMethodsImpl[R, Streaming[T]]
- Definition Classes
- BasicActionComponent
- trait BasicAPI extends Aliases with ExtensionMethodConversions
- Definition Classes
- BasicProfile
- 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 CountingInsertActionComposer[U] extends JdbcProfile.InsertActionComposer[U]
An InsertInvoker that returns the number of affected rows.
An InsertInvoker that returns the number of affected rows.
- Definition Classes
- JdbcActionComponent
- class DeleteActionExtensionMethodsImpl extends AnyRef
- Definition Classes
- JdbcActionComponent
- trait InsertActionComposer[U] extends JdbcProfile.SimpleInsertActionComposer[U]
Extension methods to generate the JDBC-specific insert actions.
Extension methods to generate the JDBC-specific insert actions.
- Definition Classes
- JdbcActionComponent
- trait IntoInsertActionComposer[U, RU] extends JdbcProfile.SimpleInsertActionComposer[U]
An InsertActionComposer that returns a mapping of the inserted and generated data.
An InsertActionComposer that returns a mapping of the inserted and generated data.
- Definition Classes
- JdbcActionComponent
- class JdbcActionExtensionMethods[E <: Effect, R, S <: NoStream] extends AnyRef
- Definition Classes
- JdbcActionComponent
- class JdbcQueryActionExtensionMethodsImpl[R, S <: NoStream] extends JdbcProfile.BasicQueryActionExtensionMethodsImpl[R, S]
- Definition Classes
- JdbcActionComponent
- class JdbcSchemaActionExtensionMethodsImpl extends JdbcProfile.RelationalSchemaActionExtensionMethodsImpl
- Definition Classes
- JdbcActionComponent
- class JdbcStreamingQueryActionExtensionMethodsImpl[R, T] extends JdbcProfile.JdbcQueryActionExtensionMethodsImpl[R, Streaming[T]] with JdbcProfile.BasicStreamingQueryActionExtensionMethodsImpl[R, T]
- Definition Classes
- JdbcActionComponent
- class MutatingResultAction[T] extends SynchronousDatabaseAction[Nothing, Streaming[ResultSetMutator[T]], JdbcActionContext, JdbcStreamingActionContext, Effect] with JdbcProfile.ProfileAction[Nothing, Streaming[ResultSetMutator[T]], Effect]
- Definition Classes
- JdbcActionComponent
- trait ReturningInsertActionComposer[U, RU] extends JdbcProfile.InsertActionComposer[U] with JdbcProfile.IntoInsertActionComposer[U, RU]
An InsertActionComposer that returns generated keys or other columns.
An InsertActionComposer that returns generated keys or other columns.
- Definition Classes
- JdbcActionComponent
- trait SimpleInsertActionComposer[U] extends JdbcProfile.InsertActionExtensionMethodsImpl[U]
Extension methods to generate the JDBC-specific insert actions.
Extension methods to generate the JDBC-specific insert actions.
- Definition Classes
- JdbcActionComponent
- abstract class SimpleJdbcProfileAction[+R] extends SynchronousDatabaseAction[R, NoStream, JdbcActionContext, JdbcStreamingActionContext, Effect] with JdbcProfile.ProfileAction[R, NoStream, Effect]
- Definition Classes
- JdbcActionComponent
- class UpdateActionExtensionMethodsImpl[T] extends AnyRef
- Definition Classes
- JdbcActionComponent
- trait QueryInvoker[R] extends StatementInvoker[R]
An Invoker for queries.
An Invoker for queries.
- Definition Classes
- JdbcInvokerComponent
- class QueryInvokerImpl[R] extends StatementInvoker[R] with JdbcProfile.QueryInvoker[R]
- Definition Classes
- JdbcInvokerComponent
- class JdbcCodeGen extends CodeGen
Code generator phase for queries on JdbcProfile.
Code generator phase for queries on JdbcProfile.
- Definition Classes
- JdbcMappingCompilerComponent
- class JdbcInsertCodeGen extends CodeGen
Code generator phase for inserts on JdbcProfile.
Code generator phase for inserts on JdbcProfile.
- Definition Classes
- JdbcMappingCompilerComponent
- class MappingCompiler extends ResultConverterCompiler[ResultSet, PreparedStatement, ResultSet]
A ResultConverterCompiler that builds JDBC-based converters.
A ResultConverterCompiler that builds JDBC-based converters. Instances of this class use mutable state internally. They are meant to be used for a single conversion only and must not be shared or reused.
- Definition Classes
- JdbcMappingCompilerComponent
- type Backend = JdbcBackend
The back-end type required by this profile
The back-end type required by this profile
- Definition Classes
- JdbcProfile → RelationalProfile → BasicProfile
- type BaseColumnType[T] = JdbcType[T] with BaseTypedType[T]
- Definition Classes
- JdbcProfile → RelationalTypesComponent
- type ColumnType[T] = JdbcType[T]
- Definition Classes
- JdbcProfile → RelationalTypesComponent
- type CompiledInsert = JdbcCompiledInsert
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
- JdbcProfile → BasicProfile
- type DeleteActionExtensionMethods = DeleteActionExtensionMethodsImpl
- Definition Classes
- JdbcActionComponent
- type InsertActionExtensionMethods[T] = CountingInsertActionComposer[T]
- Definition Classes
- JdbcActionComponent → RelationalActionComponent
- trait JdbcAPI extends JdbcLowPriorityAPI with RelationalAPI with JdbcImplicitColumnTypes
- trait JdbcLowPriorityAPI extends AnyRef
- type ProfileAction[+R, +S <: NoStream, -E <: Effect] = FixedSqlAction[R, S, E]
- Definition Classes
- JdbcActionComponent → SqlActionComponent → BasicActionComponent
- type QueryActionExtensionMethods[R, S <: NoStream] = JdbcQueryActionExtensionMethodsImpl[R, S]
- Definition Classes
- JdbcActionComponent → BasicActionComponent
- type ResultConverterReader = ResultSet
- Definition Classes
- JdbcProfile → RelationalProfile
- type ResultConverterUpdater = ResultSet
- Definition Classes
- JdbcProfile → RelationalProfile
- type ResultConverterWriter = PreparedStatement
- Definition Classes
- JdbcProfile → RelationalProfile
- abstract type RowsPerStatement >: One.type <: jdbc.RowsPerStatement
- Definition Classes
- JdbcActionComponent
- type SchemaActionExtensionMethods = JdbcSchemaActionExtensionMethodsImpl
- Definition Classes
- JdbcActionComponent → RelationalActionComponent
- type SchemaDescription = DDL
The type of a schema description (DDL)
The type of a schema description (DDL)
- Definition Classes
- SqlProfile → BasicProfile
- type StreamingProfileAction[+R, +T, -E <: Effect] = FixedSqlStreamingAction[R, T, E]
- Definition Classes
- JdbcActionComponent → SqlActionComponent → BasicActionComponent
- type StreamingQueryActionExtensionMethods[R, T] = JdbcStreamingQueryActionExtensionMethodsImpl[R, T]
- Definition Classes
- JdbcActionComponent → BasicActionComponent
- type UpdateActionExtensionMethods[T] = UpdateActionExtensionMethodsImpl[T]
- Definition Classes
- JdbcActionComponent
- class CheckInsertBuilder extends JdbcProfile.UpsertBuilder
Builder for SELECT statements that can be used to check for the existing of primary keys supplied to an INSERT operation.
Builder for SELECT statements that can be used to check for the existing of primary keys supplied to an INSERT operation. Used by the insertOrUpdate emulation on databases that don't support this in a single server-side statement.
- Definition Classes
- JdbcStatementBuilderComponent
- class ColumnDDLBuilder extends AnyRef
Builder for column specifications in DDL statements.
Builder for column specifications in DDL statements.
- Definition Classes
- JdbcStatementBuilderComponent
- class InsertBuilder extends AnyRef
Builder for INSERT statements.
Builder for INSERT statements.
- Definition Classes
- JdbcStatementBuilderComponent
- class JdbcCompiledInsert extends AnyRef
- Definition Classes
- JdbcStatementBuilderComponent
- class QueryBuilder extends InterpolationContext
Builder for SELECT and UPDATE statements.
Builder for SELECT and UPDATE statements.
- Definition Classes
- JdbcStatementBuilderComponent
- class SequenceDDLBuilder extends AnyRef
Builder for DDL statements for sequences.
Builder for DDL statements for sequences.
- Definition Classes
- JdbcStatementBuilderComponent
- abstract class StatementPart extends AnyRef
- Definition Classes
- JdbcStatementBuilderComponent
- class TableDDLBuilder extends AnyRef
Builder for various DDL statements.
Builder for various DDL statements.
- Definition Classes
- JdbcStatementBuilderComponent
- class UpdateInsertBuilder extends JdbcProfile.UpsertBuilder
Builder for UPDATE statements used as part of an insertOrUpdate operation on databases that don't support this in a single server-side statement.
Builder for UPDATE statements used as part of an insertOrUpdate operation on databases that don't support this in a single server-side statement.
- Definition Classes
- JdbcStatementBuilderComponent
- class UpsertBuilder extends JdbcProfile.InsertBuilder
Builder for upsert statements, builds standard SQL MERGE statements by default.
Builder for upsert statements, builds standard SQL MERGE statements by default.
- Definition Classes
- JdbcStatementBuilderComponent
- abstract class DriverJdbcType[T] extends JdbcType[T]
- Definition Classes
- JdbcTypesComponent
- trait JdbcImplicitColumnTypes extends JdbcProfile.RelationalImplicitColumnTypes
- Definition Classes
- JdbcTypesComponent
- class JdbcTypes extends AnyRef
- Definition Classes
- JdbcTypesComponent
- abstract class MappedJdbcType[T, U] extends JdbcType[T]
- Definition Classes
- JdbcTypesComponent
- trait InsertActionExtensionMethodsImpl[T] extends AnyRef
- Definition Classes
- RelationalActionComponent
- trait RelationalSchemaActionExtensionMethodsImpl extends AnyRef
- Definition Classes
- RelationalActionComponent
- class FastPathExtensionMethods[R, W, U, T] extends AnyRef
- Definition Classes
- RelationalProfile
- trait RelationalAPI extends BasicAPI with RelationalImplicitColumnTypes
- Definition Classes
- RelationalProfile
- class TableQueryExtensionMethods[T <: Table[_], U] extends AnyRef
- Definition Classes
- RelationalProfile
- class Sequence[T] extends AnyRef
- Definition Classes
- RelationalSequenceComponent
- trait RelationalColumnOptions extends AnyRef
- Definition Classes
- RelationalTableComponent
- abstract class Table[T] extends AbstractTable[T]
- Definition Classes
- RelationalTableComponent
- trait MappedColumnTypeFactory extends AnyRef
- Definition Classes
- RelationalTypesComponent
- trait RelationalImplicitColumnTypes extends AnyRef
- Definition Classes
- RelationalTypesComponent
- trait DDL extends SchemaDescriptionDef
- Definition Classes
- SqlProfile
- trait SqlColumnOptions extends SqlProfile.RelationalColumnOptions
- Definition Classes
- SqlTableComponent
- class QuotingSymbolNamer extends SymbolNamer
- Definition Classes
- SqlUtilsComponent
Abstract Value Members
- abstract def defaultRowsPerStatement: RowsPerStatement
- Definition Classes
- JdbcActionComponent
Concrete Value Members
- lazy val MappedColumnType: MappedJdbcType.type
- Definition Classes
- JdbcProfile → RelationalTypesComponent
- val api: JdbcAPI
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
- JdbcProfile → RelationalProfile → BasicProfile
- val backend: Backend
The back-end implementation for this profile
The back-end implementation for this profile
- Definition Classes
- JdbcProfile → BasicProfile
- final def buildSequenceSchemaDescription(seq: Sequence[_]): DDL
- Definition Classes
- JdbcProfile → RelationalSequenceComponent
- final def buildTableSchemaDescription(table: Table[_]): DDL
- Definition Classes
- JdbcProfile → RelationalTableComponent
- 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
- lazy val checkInsertCompiler: QueryCompiler
- val columnOptions: SqlColumnOptions
- Definition Classes
- SqlTableComponent → RelationalTableComponent
- val columnTypes: JdbcTypes
- def compileInsert(tree: Node): JdbcCompiledInsert
(Partially) compile an AST for insert operations
(Partially) compile an AST for insert operations
- Definition Classes
- JdbcProfile → BasicProfile
- final lazy val compiler: QueryCompiler
- Definition Classes
- RelationalProfile
- def createBaseResultConverter[T](ti: JdbcType[T], name: String, idx: Int): ResultConverter[ResultSet, PreparedStatement, ResultSet, T]
Create a (possibly specialized)
ResultConverterfor the givenJdbcType.Create a (possibly specialized)
ResultConverterfor the givenJdbcType.- Definition Classes
- JdbcMappingCompilerComponent
- def createCheckInsertBuilder(node: Insert): InsertBuilder
- Definition Classes
- JdbcStatementBuilderComponent
- def createColumnDDLBuilder(column: FieldSymbol, table: Table[_]): ColumnDDLBuilder
- Definition Classes
- JdbcStatementBuilderComponent
- def createDeleteActionExtensionMethods(tree: Node, param: Any): DeleteActionExtensionMethods
- Definition Classes
- JdbcActionComponent
- def createInsertActionExtensionMethods[T](compiled: CompiledInsert): InsertActionExtensionMethods[T]
- Definition Classes
- JdbcActionComponent → RelationalActionComponent
- def createInsertBuilder(node: Insert): InsertBuilder
- Definition Classes
- JdbcStatementBuilderComponent
- def createModel(tables: Option[DBIO[Seq[MTable]]] = None, ignoreInvalidDefaults: Boolean = true)(implicit ec: ExecutionContext): DBIO[Model]
Gets the Slick data model describing this data source
Gets the Slick data model describing this data source
- tables
used to build the model, uses defaultTables if None given
- ignoreInvalidDefaults
logs unrecognized default values instead of throwing an exception
- Definition Classes
- JdbcModelComponent
- def createModelBuilder(tables: Seq[MTable], ignoreInvalidDefaults: Boolean)(implicit ec: ExecutionContext): JdbcModelBuilder
- Definition Classes
- JdbcModelComponent
- def createOptionResultConverter[T](ti: JdbcType[T], idx: Int): ResultConverter[ResultSet, PreparedStatement, ResultSet, Option[T]]
Create a (possibly specialized)
ResultConverterforOptionvalues of the givenJdbcType.Create a (possibly specialized)
ResultConverterforOptionvalues of the givenJdbcType.- Definition Classes
- JdbcMappingCompilerComponent
- def createQueryActionExtensionMethods[R, S <: NoStream](tree: Node, param: Any): QueryActionExtensionMethods[R, S]
- Definition Classes
- JdbcActionComponent → BasicActionComponent
- def createQueryBuilder(n: Node, state: CompilerState): QueryBuilder
- Definition Classes
- JdbcStatementBuilderComponent
- def createQueryInvoker[R](tree: Node, param: Any, sql: String): QueryInvokerImpl[R]
- Definition Classes
- JdbcInvokerComponent
- def createReturningInsertActionComposer[U, QR, RU](compiled: CompiledInsert, keys: Node, mux: (U, QR) => RU): ReturningInsertActionComposer[U, RU]
- Definition Classes
- JdbcActionComponent
- def createSchemaActionExtensionMethods(schema: SchemaDescription): SchemaActionExtensionMethods
- Definition Classes
- JdbcActionComponent → RelationalActionComponent
- def createSequenceDDLBuilder(seq: Sequence[_]): SequenceDDLBuilder
- Definition Classes
- JdbcStatementBuilderComponent
- def createStreamingQueryActionExtensionMethods[R, T](tree: Node, param: Any): StreamingQueryActionExtensionMethods[R, T]
- Definition Classes
- JdbcActionComponent → BasicActionComponent
- def createTableDDLBuilder(table: Table[_]): TableDDLBuilder
- Definition Classes
- JdbcStatementBuilderComponent
- def createUpdateActionExtensionMethods[T](tree: Node, param: Any): UpdateActionExtensionMethods[T]
- Definition Classes
- JdbcActionComponent
- def createUpdateInsertBuilder(node: Insert): InsertBuilder
- Definition Classes
- JdbcStatementBuilderComponent
- def createUpsertBuilder(node: Insert): InsertBuilder
- Definition Classes
- JdbcStatementBuilderComponent
- def defaultSqlTypeName(tmd: JdbcType[_], sym: Option[FieldSymbol]): String
- Definition Classes
- JdbcTypesComponent
- def defaultTables(implicit ec: ExecutionContext): DBIO[Seq[MTable]]
Jdbc meta data for all tables included in the Slick model by default
Jdbc meta data for all tables included in the Slick model by default
- Definition Classes
- JdbcModelComponent
- lazy val deleteCompiler: QueryCompiler
The compiler used for deleting data
The compiler used for deleting data
- Definition Classes
- JdbcProfile → BasicProfile
- lazy val forceInsertCompiler: QueryCompiler
- lazy val insertCompiler: QueryCompiler
The compiler used for inserting data
The compiler used for inserting data
- Definition Classes
- JdbcProfile → BasicProfile
- def jdbcTypeFor(t: Type): JdbcType[Any]
- Definition Classes
- JdbcTypesComponent
- def likeEncode(s: String): String
- Definition Classes
- SqlUtilsComponent
- val mappingCompiler: MappingCompiler
The
MappingCompilerfor this profile.The
MappingCompilerfor this profile.- Definition Classes
- JdbcMappingCompilerComponent
- lazy val queryCompiler: QueryCompiler
The compiler used for queries
The compiler used for queries
- Definition Classes
- JdbcProfile → 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
- def runSynchronousQuery[R](tree: Node, param: Any)(implicit session: 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
- JdbcProfile → RelationalProfile
- val scalarFrom: Option[String]
The table name for scalar selects (e.g.
The table name for scalar selects (e.g. "select 42 from DUAL;"), or
Nonefor scalar selects without a FROM clause ("select 42;").- Definition Classes
- JdbcStatementBuilderComponent
- def toString(): String
- Definition Classes
- BasicProfile → AnyRef → Any
- lazy val updateCompiler: QueryCompiler
The compiler used for updates
The compiler used for updates
- Definition Classes
- JdbcProfile → BasicProfile
- lazy val updateInsertCompiler: QueryCompiler
- lazy val upsertCompiler: QueryCompiler
- def valueToSQLLiteral(v: Any, tpe: Type): String
Create a SQL representation of a literal value.
Create a SQL representation of a literal value.
- Definition Classes
- JdbcStatementBuilderComponent
- case object FromPart extends JdbcProfile.StatementPart with Product with Serializable
- Definition Classes
- JdbcStatementBuilderComponent
- case object HavingPart extends JdbcProfile.StatementPart with Product with Serializable
- Definition Classes
- JdbcStatementBuilderComponent
- case object OtherPart extends JdbcProfile.StatementPart with Product with Serializable
- Definition Classes
- JdbcStatementBuilderComponent
- case object SelectPart extends JdbcProfile.StatementPart with Product with Serializable
- Definition Classes
- JdbcStatementBuilderComponent
- case object WherePart extends JdbcProfile.StatementPart with Product with Serializable
- Definition Classes
- JdbcStatementBuilderComponent
- object JdbcType
- Definition Classes
- JdbcTypesComponent
- object MappedJdbcType extends JdbcProfile.MappedColumnTypeFactory
- Definition Classes
- JdbcTypesComponent
- object Sequence
- Definition Classes
- RelationalSequenceComponent
- object DDL
- Definition Classes
- SqlProfile
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...