Packages

t

slick.codegen

OutputHelpers

trait OutputHelpers extends AnyRef

Output-related code-generation utilities.

Source
OutputHelpers.scala
Linear Supertypes
AnyRef, Any
Known Subclasses
SourceCodeGenerator
Type Hierarchy
Ordering
  1. Grouped
  2. Alphabetic
  3. By Inheritance
Inherited
  1. OutputHelpers
  2. AnyRef
  3. 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

Abstract Value Members

  1. abstract def code: String
  2. abstract def codeForContainer: String

    The generated code used to generate the container class.

  3. abstract def codePerTable: Map[String, String]

    The generated code stored in a map that associates the scala filename with the generated code (this map contains one entry per table).

  4. abstract def foreignKeysPerTable: Map[String, List[String]]

    Foreign keys used for mapping a minimal set of dependencies between tables.

  5. abstract def indent(code: String): String

    Indents all but the first line of the given string No indent is added to empty lines.

Concrete 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 OutputHelpers toany2stringadd[OutputHelpers] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. def ->[B](y: B): (OutputHelpers, B)
    Implicit
    This member is added by an implicit conversion from OutputHelpers toArrowAssoc[OutputHelpers] 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. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @HotSpotIntrinsicCandidate() @native()
  8. def ensuring(cond: (OutputHelpers) => Boolean, msg: => Any): OutputHelpers
    Implicit
    This member is added by an implicit conversion from OutputHelpers toEnsuring[OutputHelpers] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  9. def ensuring(cond: (OutputHelpers) => Boolean): OutputHelpers
    Implicit
    This member is added by an implicit conversion from OutputHelpers toEnsuring[OutputHelpers] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  10. def ensuring(cond: Boolean, msg: => Any): OutputHelpers
    Implicit
    This member is added by an implicit conversion from OutputHelpers toEnsuring[OutputHelpers] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  11. def ensuring(cond: Boolean): OutputHelpers
    Implicit
    This member is added by an implicit conversion from OutputHelpers toEnsuring[OutputHelpers] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  12. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  13. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  14. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  15. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  16. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  17. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  18. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  19. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  20. def packageCode(profile: String, pkg: String, container: String, parentType: Option[String]): 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. slick.jdbc.H2Profile)

    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.

  21. def packageContainerCode(profile: String, pkg: String, container: String = "Tables"): String

    Generates code providing the stand-alone slick data model for immediate use.

    Generates code providing the stand-alone slick data model for immediate use.

    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.

  22. def packageTableCode(tableName: String, tableCode: String, pkg: String, container: String): String

    Generates code for the given table.

    Generates code for the given table. The tableName and tableCode parameters should come from the #codePerTable map.

    tableName

    : the name of the table

    tableCode

    : the generated code for the table.

    pkg

    Scala package the generated code is placed in

    container

    The name of the container

  23. def parentType: Option[String]

    The parent type of the generated main trait.

    The parent type of the generated main trait. This can be overridden in subclasses.

  24. def rootTraitCode(profile: String, pkg: String, container: String = "Tables"): String
  25. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  26. def toString(): String
    Definition Classes
    AnyRef → Any
  27. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  28. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  29. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  30. 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.

  31. 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. slick.jdbc.H2Profile)

    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

  32. def writeToMultipleFiles(profile: String, folder: String, pkg: String, container: String = "Tables"): Unit

    Generates code and writes it to multiple files.

    Generates code and writes it to multiple files. Creates a folder structure for the given package inside the given srcFolder and places the new files 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 output files 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.

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable]) @Deprecated
    Deprecated

    (Since version 9)

  2. def formatted(fmtstr: String): String
    Implicit
    This member is added by an implicit conversion from OutputHelpers toStringFormat[OutputHelpers] 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. def →[B](y: B): (OutputHelpers, B)
    Implicit
    This member is added by an implicit conversion from OutputHelpers toArrowAssoc[OutputHelpers] 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 AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd fromOutputHelpers to any2stringadd[OutputHelpers]

Inherited by implicit conversion StringFormat fromOutputHelpers to StringFormat[OutputHelpers]

Inherited by implicit conversion Ensuring fromOutputHelpers to Ensuring[OutputHelpers]

Inherited by implicit conversion ArrowAssoc fromOutputHelpers to ArrowAssoc[OutputHelpers]

Basic customization overrides

Output

Ungrouped