Packages

  • package root
    Definition Classes
    root
  • package slick
    Definition Classes
    root
  • package codegen

    Code generator / type providers

    Code generator / type providers

    Definition Classes
    slick
  • class SourceCodeGenerator extends AbstractSourceCodeGenerator with OutputHelpers

    A customizable code generator for working with Slick.

    A customizable code generator for working with Slick.

    For usage information please see the corresponding part of the Slick documentation.

    The implementation is structured into a small hierarchy of sub-generators responsible for different fragments of the complete output. The implementation of each sub-generator can be swapped out for a customized one by overriding the corresponding factory method. SourceCodeGenerator contains a factory method Table, which it uses to generate a sub-generator for each table. The sub-generator Table in turn contains sub-generators for Table classes, entity case classes, columns, key, indices, etc. Custom sub-generators can easily be added as well.

    Within the sub-generators the relevant part of the Slick data model can be accessed to drive the code generation.

    Of coures it makes sense to integrate this into your build process.

    Definition Classes
    codegen
  • StringExtensions
  • TableDef

class TableDef extends SourceCodeGenerator.TableDef

Source
SourceCodeGenerator.scala
Linear Supertypes
SourceCodeGenerator.TableDef, SourceCodeGenerator.TableDef, Serializable, Product, Equals, AnyRef, Any
Type Hierarchy
Ordering
  1. Grouped
  2. Alphabetic
  3. By Inheritance
Inherited
  1. TableDef
  2. TableDef
  3. TableDef
  4. Serializable
  5. Product
  6. Equals
  7. AnyRef
  8. 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

Instance Constructors

  1. new TableDef(model: model.Table)

Type Members

  1. trait Def extends AnyRef

    Common interface for any kind of definition within the generated code

    Common interface for any kind of definition within the generated code

    Definition Classes
    TableDef
  2. trait TermDef extends Def

    Common interface for definitions that define a term (val, def, ...) within the generated code

    Common interface for definitions that define a term (val, def, ...) within the generated code

    Definition Classes
    TableDef
  3. trait TypeDef extends Def

    Common interface for definitions that define a type (class, case class, ...) within the generated code

    Common interface for definitions that define a type (class, case class, ...) within the generated code

    Definition Classes
    TableDef
  4. class ColumnDef extends TableDef.ColumnDef
    Definition Classes
    TableDef
  5. trait EntityTypeDef extends TableDef.EntityTypeDef
    Definition Classes
    TableDef
  6. class ForeignKeyDef extends TableDef.ForeignKeyDef
    Definition Classes
    TableDef
  7. class IndexDef extends TableDef.IndexDef
    Definition Classes
    TableDef
  8. trait PlainSqlMapperDef extends TableDef.PlainSqlMapperDef
    Definition Classes
    TableDef
  9. class PrimaryKeyDef extends TableDef.PrimaryKeyDef
    Definition Classes
    TableDef
  10. trait TableClassDef extends TableDef.TableClassDef
    Definition Classes
    TableDef
  11. trait TableValueDef extends TableDef.TableValueDef
    Definition Classes
    TableDef
  12. type Column = ColumnDef

    Column generator virtual class

    Column generator virtual class

    Definition Classes
    TableDefTableDef
  13. type EntityType = EntityTypeDef

    Entity case class or type alias generator virtual class

    Entity case class or type alias generator virtual class

    Definition Classes
    TableDefTableDef
  14. type ForeignKey = ForeignKeyDef

    Foreign key generator virtual class

    Foreign key generator virtual class

    Definition Classes
    TableDefTableDef
  15. type Index = IndexDef

    Index generator virtual class

    Index generator virtual class

    Definition Classes
    TableDefTableDef
  16. type PlainSqlMapper = PlainSqlMapperDef

    Plain SQL GetResult mapper generator virtual class

    Plain SQL GetResult mapper generator virtual class

    Definition Classes
    TableDefTableDef
  17. type PrimaryKey = PrimaryKeyDef

    Primary key generator virtual class

    Primary key generator virtual class

    Definition Classes
    TableDefTableDef
  18. type TableClass = TableClassDef

    Table class generator virtual class

    Table class generator virtual class

    Definition Classes
    TableDefTableDef
  19. type TableValue = TableValueDef

    Table value generator virtual class

    Table value generator virtual class

    Definition Classes
    TableDefTableDef

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 TableDef toany2stringadd[TableDef] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. def ->[B](y: B): (TableDef, B)
    Implicit
    This member is added by an implicit conversion from TableDef toArrowAssoc[TableDef] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()
  5. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  6. def Column: (model.Column) => ColumnDef

    Column generator factory.

    Column generator factory. Override for customization.

    Definition Classes
    TableDefTableDef
  7. def EntityType: EntityType

    Entity case class or type alias generator factory.

    Entity case class or type alias generator factory. Override for customization.

    Definition Classes
    TableDefTableDef
  8. def ForeignKey: (model.ForeignKey) => ForeignKeyDef

    ForeignKey generator factory.

    ForeignKey generator factory. Override for customization.

    Definition Classes
    TableDefTableDef
  9. def Index: (model.Index) => IndexDef

    Index generator factory.

    Index generator factory. Override for customization.

    Definition Classes
    TableDefTableDef
  10. def PlainSqlMapper: PlainSqlMapper

    Plain SQL GetResult mapper generator factory.

    Plain SQL GetResult mapper generator factory. Override for customization.

    Definition Classes
    TableDefTableDef
  11. def PrimaryKey: (model.PrimaryKey) => PrimaryKeyDef

    PrimaryKey generator factory.

    PrimaryKey generator factory. Override for customization.

    Definition Classes
    TableDefTableDef
  12. def TableClass: TableClass

    Table class generator factory.

    Table class generator factory. Override for customization.

    Definition Classes
    TableDefTableDef
  13. def TableValue: TableValue

    Table value generator factory.

    Table value generator factory. Override for customization.

    Definition Classes
    TableDefTableDef
  14. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  15. def autoIncLast: Boolean

    Indicates whether auto increment columns should be put last.

    Indicates whether auto increment columns should be put last. Please set to !hlistEnabled for switching this on.

    Definition Classes
    TableDef
  16. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native() @HotSpotIntrinsicCandidate()
  17. def code: Seq[String]

    Generates the complete code for this table and its subordinate generators.

    Generates the complete code for this table and its subordinate generators.

    Definition Classes
    TableDef
  18. final lazy val columns: Seq[Column]

    Column code generators in the desired user-facing order.

    Column code generators in the desired user-facing order.

    Definition Classes
    TableDef
  19. final lazy val columnsByName: Map[String, Column]

    Column code generators indexed by db column name

    Column code generators indexed by db column name

    Definition Classes
    TableDef
  20. final lazy val columnsPositional: IndexedSeq[Column]

    Column code generators in the order they appear in the model.

    Column code generators in the order they appear in the model.

    Definition Classes
    TableDef
  21. def compoundType(types: Seq[String]): String

    Creates a compound type from a given sequence of types.

    Creates a compound type from a given sequence of types. Uses HList if hlistEnabled else tuple.

    Definition Classes
    TableDefTableDef
  22. def compoundValue(values: Seq[String]): String

    Creates a compound value from a given sequence of values.

    Creates a compound value from a given sequence of values. Uses HList if hlistEnabled else tuple.

    Definition Classes
    TableDefTableDef
  23. def definitions: Seq[Def]

    Definitions to be generated for this table

    Definitions to be generated for this table

    Definition Classes
    TableDef
  24. lazy val desiredColumnOrder: Seq[Int]

    Database column positions in the desired user-facing order.

    Database column positions in the desired user-facing order. Currently just moves the positions of AutoInc columns to the end if autoIncLastAsOption is enabled.

    Definition Classes
    TableDef
  25. def ensuring(cond: (TableDef) => Boolean, msg: => Any): TableDef
    Implicit
    This member is added by an implicit conversion from TableDef toEnsuring[TableDef] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  26. def ensuring(cond: (TableDef) => Boolean): TableDef
    Implicit
    This member is added by an implicit conversion from TableDef toEnsuring[TableDef] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  27. def ensuring(cond: Boolean, msg: => Any): TableDef
    Implicit
    This member is added by an implicit conversion from TableDef toEnsuring[TableDef] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  28. def ensuring(cond: Boolean): TableDef
    Implicit
    This member is added by an implicit conversion from TableDef toEnsuring[TableDef] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  29. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  30. def extractor: String

    Function that extracts the unmapped values from an entity object

    Function that extracts the unmapped values from an entity object

    Definition Classes
    TableDefTableDef
  31. def factory: String

    Function that constructs an entity object from the unmapped values

    Function that constructs an entity object from the unmapped values

    Definition Classes
    TableDefTableDef
  32. final lazy val foreignKeys: Seq[ForeignKey]

    Foreign key code generators

    Foreign key code generators

    Definition Classes
    TableDef
  33. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  34. def hlistEnabled: Boolean

    If HList should be used as a compound type instead of tuples.

    If HList should be used as a compound type instead of tuples. Only if hugeClassEnabled is false.

    Definition Classes
    TableDef
  35. def hugeClassEnabled: Boolean

    Default is true, i.e.

    Default is true, i.e. a case class will be generated even if column.size > 22. Override to false to get the code as before Slick 3.3, i.e. a HList based type will be generated instead.

    Definition Classes
    TableDef
  36. final lazy val indices: Seq[Index]

    Index code generators

    Index code generators

    Definition Classes
    TableDef
  37. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  38. final def isMappedToHugeClass: Boolean

    Indicates if table has more than 22 columns but still has to be mapped to a case class.

    Indicates if table has more than 22 columns but still has to be mapped to a case class.

    Definition Classes
    TableDef
  39. def mappingEnabled: Boolean

    Indicates if this table should be mapped using factory and extractor or not, in which case tuples are used.

    Indicates if this table should be mapped using factory and extractor or not, in which case tuples are used. (Consider overriding EntityType.enabled instead, which affects this, too.) Disabled by default when using hlists.

    Definition Classes
    TableDef
  40. val model: model.Table
    Definition Classes
    TableDef
  41. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  42. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  43. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  44. final lazy val primaryKey: Option[PrimaryKey]

    Primary key code generator, if this table has one

    Primary key code generator, if this table has one

    Definition Classes
    TableDef
  45. def productElementNames: Iterator[String]
    Definition Classes
    Product
  46. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  47. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  48. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  49. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])

Deprecated Value Members

  1. def autoIncLastAsOption: Boolean

    Indicates whether auto increment columns should be put last and made an Option with a None default.

    Indicates whether auto increment columns should be put last and made an Option with a None default. Please set to !hlistEnabled for switching this on.

    Definition Classes
    TableDef
    Annotations
    @deprecated
    Deprecated

    (Since version 3.2.0) Use autoIncLast = true and ColumnDef.asOption = autoInc instead.

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

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

Inherited from SourceCodeGenerator.TableDef

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd fromTableDef to any2stringadd[TableDef]

Inherited by implicit conversion StringFormat fromTableDef to StringFormat[TableDef]

Inherited by implicit conversion Ensuring fromTableDef to Ensuring[TableDef]

Inherited by implicit conversion ArrowAssoc fromTableDef to ArrowAssoc[TableDef]

Basic customization now overrides

Basic customization overrides

Ungrouped