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 ColumnBuilder extends AnyRef

Column model builder.

Source
JdbcModelBuilder.scala
Linear Supertypes
AnyRef, Any
Known Subclasses
H2ColumnBuilder, MySQLColumnBuilder, OracleColumnBuilder, PostgresColumnBuilder, SQLServerColumnBuilder, SQLiteColumnBuilder
Type Hierarchy
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. ColumnBuilder
  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 ColumnBuilder(tableBuilder: TableBuilder, meta: MColumn)

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

    Regex matcher to extract string out ouf surrounding

  6. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  7. def autoInc: Boolean

    Indicates whether this is an auto increment column

  8. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native() @HotSpotIntrinsicCandidate()
  9. def createPrimaryKeyColumnOption: Boolean

    Indicates whether a ColumnOption Primary key should be put into the model.

    Indicates whether a ColumnOption Primary key should be put into the model. Only valid for single column primary keys.

  10. def dbType: Option[String]

    A (potentially non-portable) database column type.

    A (potentially non-portable) database column type. For string types, this should not include a length ascription.

  11. def default: Option[Option[Any]]

    The default value for the column.

    The default value for the column. The outer option is used to indicate if a default value is given. The inner Option is used to allow giving None for a nullable column. This method must not return Some(None) for a non-nullable column.

    Default values for autoInc column are automatically ignored (as if returning None).

    If ignoreInvalidDefaults = true, Slick catches scala.MatchError and java.lang.NumberFormatException thrown by this method, logs the message and treats it as no default value for convenience.

  12. def defaultColumnOption: Option[Default[_]]

    The default value for the column as a ColumnOption Default or None if no default.

    The default value for the column as a ColumnOption Default or None if no default. The value wrapped by ColumnOption Default needs to be an Option in case of a nullable column but can't be an Option in case of a non-nullable Column.

    Default values for autoInc columns are automatically ignored.

    If ignoreInvalidDefaults = true, Slick catches scala.MatchError and java.lang.NumberFormatException thrown by this method, logs the message and treats it as no default value for convenience.

  13. def ensuring(cond: (ColumnBuilder) => Boolean, msg: => Any): ColumnBuilder
    Implicit
    This member is added by an implicit conversion from ColumnBuilder toEnsuring[ColumnBuilder] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  14. def ensuring(cond: (ColumnBuilder) => Boolean): ColumnBuilder
    Implicit
    This member is added by an implicit conversion from ColumnBuilder toEnsuring[ColumnBuilder] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  15. def ensuring(cond: Boolean, msg: => Any): ColumnBuilder
    Implicit
    This member is added by an implicit conversion from ColumnBuilder toEnsuring[ColumnBuilder] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  16. def ensuring(cond: Boolean): ColumnBuilder
    Implicit
    This member is added by an implicit conversion from ColumnBuilder toEnsuring[ColumnBuilder] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  17. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  18. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  19. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  20. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  21. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  22. def length: Option[Int]

    Column length of string types

  23. def model: Column
  24. def name: String
  25. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  26. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  27. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  28. def nullable: Boolean

    Indicates whether this is a nullable column

  29. def rawDefault: Option[String]
  30. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  31. def toString(): String
    Definition Classes
    AnyRef → Any
  32. def tpe: String

    Scala type this column is mapped to

  33. def varying: Boolean

    Indicates whether this should be a varchar in case of a string column.

    Indicates whether this should be a varchar in case of a string column. Should be based on the value of dbType in the future.

  34. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  35. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  36. 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 ColumnBuilder toStringFormat[ColumnBuilder] 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): (ColumnBuilder, B)
    Implicit
    This member is added by an implicit conversion from ColumnBuilder toArrowAssoc[ColumnBuilder] 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 fromColumnBuilder to StringFormat[ColumnBuilder]

Inherited by implicit conversion Ensuring fromColumnBuilder to Ensuring[ColumnBuilder]

Inherited by implicit conversion ArrowAssoc fromColumnBuilder to ArrowAssoc[ColumnBuilder]

Ungrouped