skinny.orm

SkinnyMapper

trait SkinnyMapper[Entity] extends SkinnyMapperBase[Entity] with ConnectionPoolFeature with AutoSessionFeature with AssociationsFeature[Entity] with StrongParametersFeature

Basic SkinnyMapper implementation.

Entity

entity

Linear Supertypes
StrongParametersFeature, AssociationsFeature[Entity], AutoSessionFeature, ConnectionPoolFeature, SkinnyMapperBase[Entity], scalikejdbc.SQLInterpolation.SQLSyntaxSupport[Entity], AnyRef, Any
Known Subclasses
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. SkinnyMapper
  2. StrongParametersFeature
  3. AssociationsFeature
  4. AutoSessionFeature
  5. ConnectionPoolFeature
  6. SkinnyMapperBase
  7. SQLSyntaxSupport
  8. AnyRef
  9. Any
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Abstract Value Members

  1. abstract def extract(rs: WrappedResultSet, n: scalikejdbc.SQLInterpolation.ResultName[Entity]): Entity

    Extracts entity from ResultSet.

    Extracts entity from ResultSet.

    rs

    result set

    n

    result name

    returns

    entity

    Definition Classes
    SkinnyMapperBase

Concrete Value Members

  1. final def !=(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  2. final def !=(arg0: Any): Boolean

    Definition Classes
    Any
  3. final def ##(): Int

    Definition Classes
    AnyRef → Any
  4. final def ==(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  5. final def ==(arg0: Any): Boolean

    Definition Classes
    Any
  6. def apply(rs: WrappedResultSet): Entity

    Extracts entity from ResultSet.

    Extracts entity from ResultSet.

    rs

    result set

    returns

    entity

    Definition Classes
    SkinnyMapperBase
  7. def apply(a: Alias[Entity])(rs: WrappedResultSet): Entity

    Extracts entity from ResultSet.

    Extracts entity from ResultSet.

    a

    table alias

    rs

    result set

    returns

    entity

    Definition Classes
    SkinnyMapperBase
  8. def as(provider: scalikejdbc.SQLInterpolation.QuerySQLSyntaxProvider[scalikejdbc.SQLInterpolation.SQLSyntaxSupport[Entity], Entity]): scalikejdbc.SQLInterpolation.TableAsAliasSQLSyntax

    Definition Classes
    SQLSyntaxSupport
  9. final def asInstanceOf[T0]: T0

    Definition Classes
    Any
  10. val associations: LinkedHashSet[Association[_]]

    Associations

    Associations

    Definition Classes
    AssociationsFeature
  11. def autoSession: DBSession

    AutoSession definition.

    AutoSession definition.

    Definition Classes
    AutoSessionFeature
  12. def belongsTo[A](right: AssociationsFeature[A], merge: (Entity, Option[A]) ⇒ Entity): BelongsToAssociation[Entity]

    Definition Classes
    AssociationsFeature
  13. def belongsToWithAlias[A](right: (AssociationsFeature[A], Alias[A]), merge: (Entity, Option[A]) ⇒ Entity): BelongsToAssociation[Entity]

    Definition Classes
    AssociationsFeature
  14. def belongsToWithAliasAndFk[A](right: (AssociationsFeature[A], Alias[A]), fk: String, merge: (Entity, Option[A]) ⇒ Entity): BelongsToAssociation[Entity]

    Definition Classes
    AssociationsFeature
  15. def belongsToWithAliasAndFkAndJoinCondition[A](right: (AssociationsFeature[A], Alias[A]), fk: String, on: scalikejdbc.SQLInterpolation.SQLSyntax, merge: (Entity, Option[A]) ⇒ Entity): BelongsToAssociation[Entity]

    Definition Classes
    AssociationsFeature
  16. def belongsToWithFk[A](right: AssociationsFeature[A], fk: String, merge: (Entity, Option[A]) ⇒ Entity): BelongsToAssociation[Entity]

    Definition Classes
    AssociationsFeature
  17. def belongsToWithFkAndJoinCondition[A](right: AssociationsFeature[A], fk: String, on: scalikejdbc.SQLInterpolation.SQLSyntax, merge: (Entity, Option[A]) ⇒ Entity): BelongsToAssociation[Entity]

    Definition Classes
    AssociationsFeature
  18. def belongsToWithJoinCondition[A](right: AssociationsFeature[A], on: scalikejdbc.SQLInterpolation.SQLSyntax, merge: (Entity, Option[A]) ⇒ Entity): BelongsToAssociation[Entity]

    Definition Classes
    AssociationsFeature
  19. def clone(): AnyRef

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws()
  20. def column: scalikejdbc.SQLInterpolation.ColumnName[Entity]

    Definition Classes
    SQLSyntaxSupport
  21. def columnNames: Seq[String]

    Returns column names.

    Returns column names.

    returns

    column names

    Definition Classes
    SkinnyMapperBase → SQLSyntaxSupport
  22. def columns: Seq[String]

    Definition Classes
    SQLSyntaxSupport
  23. def connectionPool: ConnectionPool

    Returns connection pool.

    Returns connection pool.

    returns

    pool

    Definition Classes
    ConnectionPoolFeature
  24. def connectionPoolName: Any

    Returns connection pool name.

    Returns connection pool name.

    returns

    name

    Definition Classes
    ConnectionPoolFeature
  25. def createAlias(name: String): Alias[Entity]

    Creates a new table alias for this mapper.

    Creates a new table alias for this mapper.

    name

    alias name

    returns

    alias

    Definition Classes
    SkinnyMapperBase
  26. def createJoinDefinition(joinType: JoinType, left: (AssociationsFeature[_], Alias[_]), right: (AssociationsFeature[_], Alias[_]), on: scalikejdbc.SQLInterpolation.SQLSyntax): JoinDefinition[Entity]

    Creates a new join definition.

    Creates a new join definition.

    joinType

    join type

    left

    left mapper and table alias

    right

    right mapper and table alias

    on

    join condition

    returns

    join definition

    Definition Classes
    AssociationsFeature
  27. def defaultAlias: Alias[Entity]

    Returns default table alias.

    Returns default table alias.

    returns

    default table alias

    Definition Classes
    SkinnyMapperBase
  28. val defaultBelongsToExtractors: LinkedHashSet[BelongsToExtractor[Entity]]

    Definition Classes
    AssociationsFeature
  29. val defaultHasOneExtractors: LinkedHashSet[HasOneExtractor[Entity]]

    Definition Classes
    AssociationsFeature
  30. val defaultJoinDefinitions: LinkedHashSet[JoinDefinition[_]]

    Join definitions that are enabled by default.

    Join definitions that are enabled by default.

    Definition Classes
    AssociationsFeature
  31. val defaultOneToManyExtractors: LinkedHashSet[HasManyExtractor[Entity]]

    Definition Classes
    AssociationsFeature
  32. def defaultSelectQuery: scalikejdbc.SQLInterpolation.SelectSQLBuilder[Entity]

    Returns th default select query builder for this mapper.

    Returns th default select query builder for this mapper.

    returns

    select query builder

    Definition Classes
    AssociationsFeature
  33. def delimiterForResultName: String

    Definition Classes
    SQLSyntaxSupport
  34. final def eq(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  35. def equals(arg0: Any): Boolean

    Definition Classes
    AnyRef → Any
  36. def extractBelongsTo[That](mapper: AssociationsFeature[That], fk: String, alias: Alias[That], merge: (Entity, Option[That]) ⇒ Entity): BelongsToExtractor[Entity]

    Definition Classes
    AssociationsFeature
  37. def extractHasOne[That](mapper: AssociationsFeature[That], fk: String, alias: Alias[That], merge: (Entity, Option[That]) ⇒ Entity): HasOneExtractor[Entity]

    Definition Classes
    AssociationsFeature
  38. def extractOneToMany[M1](mapper: AssociationsFeature[M1], alias: Alias[M1], merge: (Entity, Seq[M1]) ⇒ Entity): HasManyExtractor[Entity]

    Definition Classes
    AssociationsFeature
  39. def extractOneToManyWithDefaults[M1](mapper: AssociationsFeature[M1], merge: (Entity, Seq[M1]) ⇒ Entity): HasManyExtractor[Entity]

    One-to-Many relationship definition.

    One-to-Many relationship definition.

    object Member extends RelationshipFeature[Member] {
    oneToMany[Group](
      mapper = Group,
      merge = (m, c) => m.copy(company = c)
    )
    }
    Definition Classes
    AssociationsFeature
  40. def extractWithOneToOneTables(rs: WrappedResultSet, belongsToExtractors: Set[BelongsToExtractor[Entity]], hasOneExtractors: Set[HasOneExtractor[Entity]]): Entity

    Extracts entity with one-to-one tables.

    Extracts entity with one-to-one tables.

    rs

    result set

    belongsToExtractors

    belongsTo extractors

    hasOneExtractors

    hasOne extractors

    returns

    entity

    Definition Classes
    AssociationsFeature
  41. def finalize(): Unit

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws()
  42. def forceUpperCase: Boolean

    Definition Classes
    SQLSyntaxSupport
  43. final def getClass(): Class[_]

    Definition Classes
    AnyRef → Any
  44. def getTypedValueFromStrongParameter(fieldName: String, value: Any, paramType: ParamType): Option[Any]

    Returns typed value from a strong parameter.

    Returns typed value from a strong parameter.

    fieldName

    field name

    value

    actual value

    paramType

    param type definition

    returns

    typed value if exists

    Attributes
    protected
    Definition Classes
    StrongParametersFeature
  45. def hasMany[M](many: (AssociationsFeature[M], Alias[M]), on: (Alias[Entity], Alias[M]) ⇒ scalikejdbc.SQLInterpolation.SQLSyntax, merge: (Entity, Seq[M]) ⇒ Entity): HasManyAssociation[Entity]

    Definition Classes
    AssociationsFeature
  46. def hasManyThrough[M1, M2](through: (AssociationsFeature[M1], Alias[M1]), throughOn: (Alias[Entity], Alias[M1]) ⇒ scalikejdbc.SQLInterpolation.SQLSyntax, many: (AssociationsFeature[M2], Alias[M2]), on: (Alias[M1], Alias[M2]) ⇒ scalikejdbc.SQLInterpolation.SQLSyntax, merge: (Entity, Seq[M2]) ⇒ Entity): HasManyAssociation[Entity]

    Definition Classes
    AssociationsFeature
  47. def hasManyThrough[M2](through: AssociationsFeature[_], many: AssociationsFeature[M2], merge: (Entity, Seq[M2]) ⇒ Entity): HasManyAssociation[Entity]

    Definition Classes
    AssociationsFeature
  48. def hasManyThroughWithFk[M2](through: AssociationsFeature[_], many: AssociationsFeature[M2], throughFk: String, manyFk: String, merge: (Entity, Seq[M2]) ⇒ Entity): HasManyAssociation[Entity]

    Definition Classes
    AssociationsFeature
  49. def hasOne[A](right: AssociationsFeature[A], merge: (Entity, Option[A]) ⇒ Entity): HasOneAssociation[Entity]

    Definition Classes
    AssociationsFeature
  50. def hasOneWithAlias[A](right: (AssociationsFeature[A], Alias[A]), merge: (Entity, Option[A]) ⇒ Entity): HasOneAssociation[Entity]

    Definition Classes
    AssociationsFeature
  51. def hasOneWithAliasAndFk[A](right: (AssociationsFeature[A], Alias[A]), fk: String, merge: (Entity, Option[A]) ⇒ Entity): HasOneAssociation[Entity]

    Definition Classes
    AssociationsFeature
  52. def hasOneWithAliasAndFkAndJoinCondition[A](right: (AssociationsFeature[A], Alias[A]), fk: String, on: scalikejdbc.SQLInterpolation.SQLSyntax, merge: (Entity, Option[A]) ⇒ Entity): HasOneAssociation[Entity]

    Definition Classes
    AssociationsFeature
  53. def hasOneWithAliasAndJoinCondition[A](right: (AssociationsFeature[A], Alias[A]), on: scalikejdbc.SQLInterpolation.SQLSyntax, merge: (Entity, Option[A]) ⇒ Entity): HasOneAssociation[Entity]

    Definition Classes
    AssociationsFeature
  54. def hasOneWithFk[A](right: AssociationsFeature[A], fk: String, merge: (Entity, Option[A]) ⇒ Entity): HasOneAssociation[Entity]

    Definition Classes
    AssociationsFeature
  55. def hasOneWithFkAndJoinCondition[A](right: AssociationsFeature[A], fk: String, on: scalikejdbc.SQLInterpolation.SQLSyntax, merge: (Entity, Option[A]) ⇒ Entity): HasOneAssociation[Entity]

    Definition Classes
    AssociationsFeature
  56. def hasOneWithJoinCondition[A](right: AssociationsFeature[A], on: scalikejdbc.SQLInterpolation.SQLSyntax, merge: (Entity, Option[A]) ⇒ Entity): HasOneAssociation[Entity]

    Definition Classes
    AssociationsFeature
  57. def hashCode(): Int

    Definition Classes
    AnyRef → Any
  58. def innerJoin[Left](left: (AssociationsFeature[Left], Alias[Left]), right: (AssociationsFeature[_], Alias[_]), on: (Alias[Left], Alias[_]) ⇒ scalikejdbc.SQLInterpolation.SQLSyntax): JoinDefinition[Entity]

    Definition Classes
    AssociationsFeature
  59. def innerJoin(right: (AssociationsFeature[_], Alias[_]), on: (Alias[Entity], Alias[_]) ⇒ scalikejdbc.SQLInterpolation.SQLSyntax): JoinDefinition[Entity]

    Definition Classes
    AssociationsFeature
  60. def innerJoinWithDefaults[Left](left: AssociationsFeature[Left], right: AssociationsFeature[_], on: (Alias[Left], Alias[_]) ⇒ scalikejdbc.SQLInterpolation.SQLSyntax): JoinDefinition[Entity]

    Definition Classes
    AssociationsFeature
  61. def innerJoinWithDefaults(right: AssociationsFeature[_], on: (Alias[Entity], Alias[Any]) ⇒ scalikejdbc.SQLInterpolation.SQLSyntax): JoinDefinition[Entity]

    Definition Classes
    AssociationsFeature
  62. def innerJoinWithDefaults(right: AssociationsFeature[_], on: scalikejdbc.SQLInterpolation.SQLSyntax): JoinDefinition[Entity]

    Definition Classes
    AssociationsFeature
  63. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any
  64. def isValidFieldName(name: String): Boolean

    Predicates the field name is valid.

    Predicates the field name is valid.

    name

    field name

    returns

    valid if true

    Definition Classes
    SkinnyMapperBase
  65. def join[Left](left: (AssociationsFeature[Left], Alias[Left]), right: (AssociationsFeature[_], Alias[_]), on: (Alias[Left], Alias[_]) ⇒ scalikejdbc.SQLInterpolation.SQLSyntax): JoinDefinition[Entity]

    Definition Classes
    AssociationsFeature
  66. def join(right: (AssociationsFeature[_], Alias[_]), on: (Alias[Entity], Alias[_]) ⇒ scalikejdbc.SQLInterpolation.SQLSyntax): JoinDefinition[Entity]

    Definition Classes
    AssociationsFeature
  67. def joinWithDefaults[Left](left: AssociationsFeature[Left], right: AssociationsFeature[_], on: (Alias[Left], Alias[_]) ⇒ scalikejdbc.SQLInterpolation.SQLSyntax): JoinDefinition[Entity]

    Definition Classes
    AssociationsFeature
  68. def joinWithDefaults(right: AssociationsFeature[_], on: (Alias[Entity], Alias[Any]) ⇒ scalikejdbc.SQLInterpolation.SQLSyntax): JoinDefinition[Entity]

    Definition Classes
    AssociationsFeature
  69. def joinWithDefaults(right: AssociationsFeature[_], on: scalikejdbc.SQLInterpolation.SQLSyntax): JoinDefinition[Entity]

    Definition Classes
    AssociationsFeature
  70. def leftJoin(left: (AssociationsFeature[_], Alias[_]), right: (AssociationsFeature[_], Alias[_]), on: (Alias[_], Alias[_]) ⇒ scalikejdbc.SQLInterpolation.SQLSyntax): JoinDefinition[_]

    Definition Classes
    AssociationsFeature
  71. def leftJoin(right: (AssociationsFeature[_], Alias[_]), on: (Alias[Entity], Alias[_]) ⇒ scalikejdbc.SQLInterpolation.SQLSyntax): JoinDefinition[_]

    Definition Classes
    AssociationsFeature
  72. def leftJoinWithDefaults(left: AssociationsFeature[_], right: AssociationsFeature[_], on: (Alias[_], Alias[_]) ⇒ scalikejdbc.SQLInterpolation.SQLSyntax): JoinDefinition[_]

    Definition Classes
    AssociationsFeature
  73. def leftJoinWithDefaults(right: AssociationsFeature[_], on: (Alias[Entity], Alias[Any]) ⇒ scalikejdbc.SQLInterpolation.SQLSyntax): JoinDefinition[_]

    Definition Classes
    AssociationsFeature
  74. def leftJoinWithDefaults(right: AssociationsFeature[_], on: scalikejdbc.SQLInterpolation.SQLSyntax): JoinDefinition[_]

    Definition Classes
    AssociationsFeature
  75. def nameConverters: Map[String, String]

    Definition Classes
    SQLSyntaxSupport
  76. final def ne(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  77. final def notify(): Unit

    Definition Classes
    AnyRef
  78. final def notifyAll(): Unit

    Definition Classes
    AnyRef
  79. def primaryKeyName: String

    Returns primary key name.

    Returns primary key name. (default: "id")

    Notice: Not a column name but field name. For example, not "first_name" but "firstName"

    returns

    primary key name

    Definition Classes
    SkinnyMapperBase
  80. def selectQueryWithAssociations(sql: scalikejdbc.SQLInterpolation.SelectSQLBuilder[Entity], belongsToAssociations: Set[BelongsToAssociation[Entity]], hasOneAssociations: Set[HasOneAssociation[Entity]], hasManyAssociations: Set[HasManyAssociation[Entity]]): scalikejdbc.SQLInterpolation.SelectSQLBuilder[Entity]

    Returns a select query builder that all associations are joined.

    Returns a select query builder that all associations are joined.

    sql

    sql object

    belongsToAssociations

    belongsTo associations

    hasOneAssociations

    hasOne associations

    hasManyAssociations

    hasMany associations

    returns

    select query builder

    Definition Classes
    AssociationsFeature
  81. def setAsByDefault(extractor: HasManyExtractor[Entity]): Unit

    Definition Classes
    AssociationsFeature
  82. def setAsByDefault(extractor: HasOneExtractor[Entity]): Unit

    Definition Classes
    AssociationsFeature
  83. def setAsByDefault(extractor: BelongsToExtractor[Entity]): Unit

    Definition Classes
    AssociationsFeature
  84. def singleSelectQuery: scalikejdbc.SQLInterpolation.SelectSQLBuilder[Entity]

    Returns select query builder object to simply fetch rows without other joined tables.

    Returns select query builder object to simply fetch rows without other joined tables.

    returns

    SQL builder object

    Attributes
    protected
    Definition Classes
    SkinnyMapperBase
  85. final def synchronized[T0](arg0: ⇒ T0): T0

    Definition Classes
    AnyRef
  86. def syntax(name: String): scalikejdbc.SQLInterpolation.QuerySQLSyntaxProvider[scalikejdbc.SQLInterpolation.SQLSyntaxSupport[Entity], Entity]

    Definition Classes
    SQLSyntaxSupport
  87. def syntax: scalikejdbc.SQLInterpolation.QuerySQLSyntaxProvider[scalikejdbc.SQLInterpolation.SQLSyntaxSupport[Entity], Entity]

    Definition Classes
    SQLSyntaxSupport
  88. def table: scalikejdbc.SQLInterpolation.TableDefSQLSyntax

    Definition Classes
    SQLSyntaxSupport
  89. def tableName: String

    Returns table name.

    Returns table name.

    returns

    table name

    Definition Classes
    SkinnyMapperBase → SQLSyntaxSupport
  90. def toDefaultForeignKeyName[A](mapper: AssociationsFeature[A]): String

    Expects mapper's name + "Id" by default.

    Expects mapper's name + "Id" by default.

    A

    enitty type

    mapper

    mapper

    returns

    fk name

    Attributes
    protected
    Definition Classes
    AssociationsFeature
  91. def toString(): String

    Definition Classes
    AnyRef → Any
  92. def underlying: SkinnyMapperBase[Entity]

    Attributes
    protected
    Definition Classes
    SkinnyMapperBase
  93. def useShortenedResultName: Boolean

    Definition Classes
    SQLSyntaxSupport
  94. def useSnakeCaseColumnName: Boolean

    Definition Classes
    SQLSyntaxSupport
  95. final def wait(): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws()
  96. final def wait(arg0: Long, arg1: Int): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws()
  97. final def wait(arg0: Long): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws()
  98. def withAlias[A](name: String)(op: (Alias[Entity]) ⇒ A): A

    Provides a code block with a table alias.

    Provides a code block with a table alias.

    A

    return type

    name

    table alias name

    op

    operation

    returns

    result

    Definition Classes
    SkinnyMapperBase
  99. def withAlias[A](op: (Alias[Entity]) ⇒ A): A

    Provides a code block with a table alias.

    Provides a code block with a table alias.

    A

    return type

    op

    operation

    returns

    result

    Definition Classes
    SkinnyMapperBase
  100. def withColumns[A](op: (scalikejdbc.SQLInterpolation.ColumnName[Entity]) ⇒ A): A

    Provides a code block with the column name provider.

    Provides a code block with the column name provider.

    A

    return type

    op

    operation

    returns

    result

    Definition Classes
    SkinnyMapperBase
  101. def withExtractor(sql: SQL[Entity, NoExtractor], belongsToAssociations: Set[BelongsToAssociation[Entity]], hasOneAssociations: Set[HasOneAssociation[Entity]], oneToManyAssociations: Set[HasManyAssociation[Entity]]): SQL[Entity, HasExtractor]

    Creates an extractor for this query.

    Creates an extractor for this query.

    sql

    sql object

    belongsToAssociations

    belongsTo associations

    hasOneAssociations

    hasOne associations

    oneToManyAssociations

    hasMany associations

    returns

    sql object

    Definition Classes
    AssociationsFeature
  102. def withExtractor(sql: SQL[Entity, NoExtractor]): SQL[Entity, HasExtractor]

    Definition Classes
    AssociationsFeature

Inherited from StrongParametersFeature

Inherited from AssociationsFeature[Entity]

Inherited from AutoSessionFeature

Inherited from ConnectionPoolFeature

Inherited from SkinnyMapperBase[Entity]

Inherited from scalikejdbc.SQLInterpolation.SQLSyntaxSupport[Entity]

Inherited from AnyRef

Inherited from Any

Ungrouped