Packages

  • package root

    edit this text on github Slick logo

    edit this text on github Slick logo

    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...

    Definition Classes
    root
  • package slick
    Definition Classes
    root
  • package jdbc

    Contains the abstract JdbcProfile and related code.

    Contains the abstract JdbcProfile and related code. This includes all JDBC-related code, facilities for Plain SQL queries, and JDBC-specific profile components.

    Definition Classes
    slick
  • class JdbcModelBuilder extends Logging

    Build a Slick model from introspecting the JDBC metadata.

    Build a Slick model from introspecting the JDBC metadata.

    In most cases you are better off transforming the generated model instead of overriding functionality here. It is only useful if you need easy access to the JDBC metadata in order to influence how the model is generated. A good use case would be interpreting column types or default values that Slick doesn't understand out of the box. If you just want to remove or hard code some default values, transform the resulting model instead.

    The tight coupling can easily lead to source code incompatibilities in future versions. Avoid hooking in here if you don't have to.

    Definition Classes
    jdbc
  • Builders
  • ColumnBuilder
  • ForeignKeyBuilder
  • IndexBuilder
  • PrimaryKeyBuilder
  • TableBuilder
  • TableNamer

class TableBuilder extends AnyRef

Table model builder

Self Type
TableBuilder
Source
JdbcModelBuilder.scala
Linear Supertypes
AnyRef, Any
Type Hierarchy
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. TableBuilder
  2. AnyRef
  3. Any
Implicitly
  1. by StringFormat
  2. by Ensuring
  3. by ArrowAssoc
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new TableBuilder(meta: MTable, namer: TableNamer, mColumns: Seq[MColumn], mPrimaryKeys: Seq[MPrimaryKey], mForeignKeys: Seq[Seq[MForeignKey]], mIndices: Seq[Seq[MIndexInfo]])

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##: Int
    Definition Classes
    AnyRef → Any
  3. def ->[B](y: B): (TableBuilder, B)
    Implicit
    This member is added by an implicit conversion from TableBuilder toArrowAssoc[TableBuilder] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()
  4. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  5. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  6. final def buildForeignKeys(builders: Builders): Seq[ForeignKey]

    Foreign key models by key sequence order

  7. def buildModel(builders: Builders): Table
  8. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native() @HotSpotIntrinsicCandidate()
  9. final lazy val columns: Seq[Column]

    Column models in ordinal position order

  10. final lazy val columnsByName: Map[String, Column]

    Column models by name

  11. def ensuring(cond: (TableBuilder) => Boolean, msg: => Any): TableBuilder
    Implicit
    This member is added by an implicit conversion from TableBuilder toEnsuring[TableBuilder] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  12. def ensuring(cond: (TableBuilder) => Boolean): TableBuilder
    Implicit
    This member is added by an implicit conversion from TableBuilder toEnsuring[TableBuilder] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  13. def ensuring(cond: Boolean, msg: => Any): TableBuilder
    Implicit
    This member is added by an implicit conversion from TableBuilder toEnsuring[TableBuilder] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  14. def ensuring(cond: Boolean): TableBuilder
    Implicit
    This member is added by an implicit conversion from TableBuilder toEnsuring[TableBuilder] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  15. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  16. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  17. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  18. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  19. final lazy val indices: Seq[Index]

    Index models by ordinal position order

  20. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  21. val mColumns: Seq[MColumn]
  22. val mForeignKeys: Seq[Seq[MForeignKey]]
  23. val mIndices: Seq[Seq[MIndexInfo]]
  24. val mPrimaryKeys: Seq[MPrimaryKey]
  25. val meta: MTable
  26. val namer: TableNamer
  27. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  28. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  29. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  30. final lazy val primaryKey: Option[PrimaryKey]

    Primary key models in key sequence order

  31. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  32. def toString(): String
    Definition Classes
    AnyRef → Any
  33. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  34. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  35. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])

Deprecated Value Members

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

Inherited by implicit conversion Ensuring fromTableBuilder to Ensuring[TableBuilder]

Inherited by implicit conversion ArrowAssoc fromTableBuilder to ArrowAssoc[TableBuilder]

Ungrouped