scala.slick.codegen

SourceCodeGenerator

class SourceCodeGenerator extends AbstractSourceCodeGenerator with OutputHelpers

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.

Source
SourceCodeGenerator.scala
Linear Supertypes
Type Hierarchy Learn more about scaladoc diagrams
Ordering
  1. Grouped
  2. Alphabetic
  3. By inheritance
Inherited
  1. SourceCodeGenerator
  2. OutputHelpers
  3. AbstractSourceCodeGenerator
  4. StringGeneratorHelpers
  5. AbstractGenerator
  6. GeneratorHelpers
  7. AnyRef
  8. Any
Implicitly
  1. by any2stringadd
  2. by StringFormat
  3. by Ensuring
  4. by ArrowAssoc
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Instance Constructors

  1. new SourceCodeGenerator(model: Model)

    model

    Slick data model for which code should be generated.

Type Members

  1. implicit class StringExtensions extends AnyRef

    Slick code generator string extension methods.

    Slick code generator string extension methods. (Warning: Not unicode-safe, uses String#apply)

    Definition Classes
    GeneratorHelpers
  2. type Table = TableDef

    Table generator virtual class

    Table generator virtual class

    Definition Classes
    SourceCodeGeneratorAbstractGenerator
  3. class TableDef extends SourceCodeGenerator.TableDef

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 information
    This member is added by an implicit conversion from SourceCodeGenerator to any2stringadd[SourceCodeGenerator] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. def ->[B](y: B): (SourceCodeGenerator, B)

    Implicit information
    This member is added by an implicit conversion from SourceCodeGenerator to ArrowAssoc[SourceCodeGenerator] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()
  5. final def ==(arg0: Any): Boolean

    Definition Classes
    AnyRef → Any
  6. def Table: (model.Table) ⇒ TableDef

    Table generator factory.

    Table generator factory. Override for customization.

    Definition Classes
    SourceCodeGeneratorAbstractGenerator
  7. final def asInstanceOf[T0]: T0

    Definition Classes
    Any
  8. def clone(): AnyRef

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  9. def code: String

    Generates code for the complete model (not wrapped in a package yet)

    Generates code for the complete model (not wrapped in a package yet)

    Definition Classes
    AbstractSourceCodeGenerator
  10. def docWithCode(doc: String, code: String): String

    Assemble doc comment with scala code

    Assemble doc comment with scala code

    Definition Classes
    StringGeneratorHelpersGeneratorHelpers
  11. def ensuring(cond: (SourceCodeGenerator) ⇒ Boolean, msg: ⇒ Any): SourceCodeGenerator

    Implicit information
    This member is added by an implicit conversion from SourceCodeGenerator to Ensuring[SourceCodeGenerator] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  12. def ensuring(cond: (SourceCodeGenerator) ⇒ Boolean): SourceCodeGenerator

    Implicit information
    This member is added by an implicit conversion from SourceCodeGenerator to Ensuring[SourceCodeGenerator] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  13. def ensuring(cond: Boolean, msg: ⇒ Any): SourceCodeGenerator

    Implicit information
    This member is added by an implicit conversion from SourceCodeGenerator to Ensuring[SourceCodeGenerator] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  14. def ensuring(cond: Boolean): SourceCodeGenerator

    Implicit information
    This member is added by an implicit conversion from SourceCodeGenerator to Ensuring[SourceCodeGenerator] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  15. def entityName: (String) ⇒ String

    Maps database table name to entity case class name

    Maps database table name to entity case class name

    Definition Classes
    AbstractGenerator
  16. final def eq(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  17. def equals(arg0: Any): Boolean

    Definition Classes
    AnyRef → Any
  18. def finalize(): Unit

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  19. def formatted(fmtstr: String): String

    Implicit information
    This member is added by an implicit conversion from SourceCodeGenerator to StringFormat[SourceCodeGenerator] performed by method StringFormat in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @inline()
  20. final def getClass(): Class[_]

    Definition Classes
    AnyRef → Any
  21. def hashCode(): Int

    Definition Classes
    AnyRef → Any
  22. def indent(code: String): String

    Definition Classes
    GeneratorHelpers
  23. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any
  24. final def ne(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  25. final def notify(): Unit

    Definition Classes
    AnyRef
  26. final def notifyAll(): Unit

    Definition Classes
    AnyRef
  27. final def optionType(t: String): String

    Wrap the given type into an Option type

    Wrap the given type into an Option type

    Definition Classes
    StringGeneratorHelpersGeneratorHelpers
  28. def packageCode(profile: String, pkg: String, container: String = "Tables"): String

    Generates code providing the data model as trait and object in a Scala package

    Generates code providing the data model as trait and object in a Scala package

    profile

    Slick profile that is imported in the generated package (e.g. scala.slick.driver.H2Driver)

    pkg

    Scala package the generated code is placed in

    container

    The name of a trait and an object the generated code will be placed in within the specified package.

    Definition Classes
    OutputHelpers
  29. def parseType(tpe: String): String

    Generates code for a qualified Scala type

    Generates code for a qualified Scala type

    Definition Classes
    StringGeneratorHelpersGeneratorHelpers
  30. val scalaKeywords: collection.Seq[String]

    Words that are reserved keywords in Scala

    Words that are reserved keywords in Scala

    Definition Classes
    GeneratorHelpers
  31. val slickTableTermMembersNoArgs: collection.Seq[String]

    Existing term member names in Table[_] that do not take parameters

    Existing term member names in Table[_] that do not take parameters

    Definition Classes
    GeneratorHelpers
  32. final def synchronized[T0](arg0: ⇒ T0): T0

    Definition Classes
    AnyRef
  33. def tableName: (String) ⇒ String

    Maps database table name to Table class and value name

    Maps database table name to Table class and value name

    Definition Classes
    AbstractGenerator
  34. final lazy val tables: Seq[Table]

    Table code generators.

    Table code generators.

    Definition Classes
    AbstractGenerator
  35. final lazy val tablesByName: Map[QualifiedName, Table]

    Table code generators indexed by db table name.

    Table code generators indexed by db table name.

    Definition Classes
    AbstractGenerator
  36. def termName(name: String): String

    Marks a String as a TermName (e.g.

    Marks a String as a TermName (e.g. for escaping scala keywords)

    Definition Classes
    StringGeneratorHelpersGeneratorHelpers
  37. def toString(): String

    Definition Classes
    AnyRef → Any
  38. def tuple(i: Int): String

    Attributes
    protected
    Definition Classes
    AbstractSourceCodeGenerator
  39. def typeName(name: String): String

    Marks a String as a TypeName (e.g.

    Marks a String as a TypeName (e.g. for escaping scala keywords)

    Definition Classes
    StringGeneratorHelpersGeneratorHelpers
  40. final def wait(): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  41. final def wait(arg0: Long, arg1: Int): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  42. final def wait(arg0: Long): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  43. def writeStringToFile(content: String, folder: String, pkg: String, fileName: String): Unit

    Writes given content to a file.

    Writes given content to a file. Ensures the file ends with a newline character.

    Definition Classes
    OutputHelpers
  44. def writeToFile(profile: String, folder: String, pkg: String, container: String = "Tables", fileName: String = "Tables.scala"): Unit

    Generates code and writes it to a file.

    Generates code and writes it to a file. Creates a folder structure for the given package inside the given srcFolder and places the new file inside or overrides the existing one.

    profile

    Slick profile that is imported in the generated package (e.g. scala.slick.driver.H2Driver)

    folder

    target folder, in which the package structure folders are placed

    pkg

    Scala package the generated code is placed in (a subfolder structure will be created within srcFolder)

    container

    The name of a trait and an object the generated code will be placed in within the specified package.

    fileName

    Name of the output file, to which the code will be written

    Definition Classes
    OutputHelpers
  45. def [B](y: B): (SourceCodeGenerator, B)

    Implicit information
    This member is added by an implicit conversion from SourceCodeGenerator to ArrowAssoc[SourceCodeGenerator] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc

Inherited from OutputHelpers

Inherited from StringGeneratorHelpers

Inherited from AbstractGenerator[String, String, String]

Inherited from GeneratorHelpers[String, String, String]

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd from SourceCodeGenerator to any2stringadd[SourceCodeGenerator]

Inherited by implicit conversion StringFormat from SourceCodeGenerator to StringFormat[SourceCodeGenerator]

Inherited by implicit conversion Ensuring from SourceCodeGenerator to Ensuring[SourceCodeGenerator]

Inherited by implicit conversion ArrowAssoc from SourceCodeGenerator to ArrowAssoc[SourceCodeGenerator]

Basic customization overrides

Output

Ungrouped