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
ColumnBuilder, ColumnBuilder, ColumnBuilder, ColumnBuilder, ColumnBuilder, ColumnBuilder
Type Hierarchy
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. ColumnBuilder
  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

Instance Constructors

  1. new ColumnBuilder(tableBuilder: TableBuilder, meta: MColumn)

Value Members

  1. final val StringPattern: Regex

    Regex matcher to extract string out ouf surrounding

  2. def autoInc: Boolean

    Indicates whether this is an auto increment column

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

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

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

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

  7. def length: Option[Int]

    Column length of string types

  8. def model: Column
  9. def name: String
  10. def nullable: Boolean

    Indicates whether this is a nullable column

  11. def rawDefault: Option[String]
  12. def tpe: String

    Scala type this column is mapped to

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