Packages

class ColumnDef extends TableDef.ColumnDef

Source
AbstractSourceCodeGenerator.scala
Linear Supertypes
TableDef.ColumnDef, Serializable, Product, Equals, TableDef.TermDef, TableDef.Def, AnyRef, Any
Type Hierarchy
Ordering
  1. Grouped
  2. Alphabetic
  3. By Inheritance
Inherited
  1. ColumnDef
  2. ColumnDef
  3. Serializable
  4. Product
  5. Equals
  6. TermDef
  7. Def
  8. AnyRef
  9. 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

Basic customization overrides

  1. def asOption: Boolean

    Indicates whether the exposed type of this column should be wrapped in an Option.

    Indicates whether the exposed type of this column should be wrapped in an Option. Useful for autoInc and automatically created columns. Set to autoInc to expose autoInc columns as Option.

    Definition Classes
    ColumnDef
  2. def code: String

    Scala code

    Scala code

    Definition Classes
    ColumnDefDef
  3. def doc: String

    Scala doc comment

    Scala doc comment

    Definition Classes
    ColumnDefDef
  4. def enabled: Boolean

    Indicates whether this will be included in the generated code

    Indicates whether this will be included in the generated code

    Definition Classes
    Def
  5. def rawName: String

    Name as desired in Scala Code.

    Name as desired in Scala Code. (Allowed to collide with Scala keywords. Will be automatically escaped.)

    Definition Classes
    ColumnDefDef
  6. def rawType: String

    Underlying Scala type of this column.

    Underlying Scala type of this column. Override this to just affect the data type but preserve potential Option-wrapping.

    Definition Classes
    ColumnDef

Ungrouped

  1. final def actualType: String

    Possibly Option-wrapped Scala type of this column.

    Possibly Option-wrapped Scala type of this column. @see rawType and @see exposedType

    Definition Classes
    ColumnDef
  2. final def autoInc: Boolean

    Indicates whether this is an auto increment column

    Indicates whether this is an auto increment column

    Definition Classes
    ColumnDef
  3. def columnOptionCode: (ColumnOption[_]) => Option[String]

    Generates code for a columnOption

    Generates code for a columnOption

    Definition Classes
    ColumnDefColumnDef
  4. def dbType: Boolean

    Indicates if a (non-portable) DBType ColumnOption should be generated

    Indicates if a (non-portable) DBType ColumnOption should be generated

    Definition Classes
    ColumnDef
  5. def default: Option[String]

    Generates a literal represenation of the default value or None in case of an Option-typed autoinc column

    Generates a literal represenation of the default value or None in case of an Option-typed autoinc column

    Definition Classes
    ColumnDef
  6. def defaultCode: (Any) => String

    Returns a function, that maps a value to its literal representation as code

    Returns a function, that maps a value to its literal representation as code

    Definition Classes
    ColumnDefColumnDef
  7. def disambiguateTerm(name: String, postfix: String = "X"): String

    Adds one or more X to the end of the given string to avoid collisions with column names.

    Adds one or more X to the end of the given string to avoid collisions with column names.

    Definition Classes
    TermDef
  8. def docWithCode: String

    Scala doc comment with code

    Scala doc comment with code

    Definition Classes
    TermDefDef
  9. final def exposedType: String

    Option of actualType if fakeNullable else actualType.

    Option of actualType if fakeNullable else actualType.

    Definition Classes
    ColumnDef
  10. final def getEnabled: Option[TableDef.Def]

    Returns Some(this) if enabled else None

    Returns Some(this) if enabled else None

    Definition Classes
    Def
  11. val model: model.Column
    Definition Classes
    ColumnDef
  12. final def name: String

    Name (escaped if colliding with Scala keyword).

    Name (escaped if colliding with Scala keyword).

    Definition Classes
    TermDef
  13. def options: Iterable[String]

    Generates code for the ColumnOptions (DBType, AutoInc, etc.)

    Generates code for the ColumnOptions (DBType, AutoInc, etc.)

    Definition Classes
    ColumnDef
  14. def productElementNames: Iterator[String]
    Definition Classes
    Product
  15. final def fakeNullable: Boolean

    Indicates whether this column should be user facing as a nullable column with default None even though it is not.

    Indicates whether this column should be user facing as a nullable column with default None even though it is not. Useful for autoInc columns.

    Definition Classes
    ColumnDef
    Annotations
    @deprecated
    Deprecated

    (Since version 3.2.0) Use asOption instead.