skinny.orm.feature

AssociationsFeature

trait AssociationsFeature[Entity] extends SkinnyMapperBase[Entity] with ConnectionPoolFeature with AutoSessionFeature with Logging

Associations support feature.

Entity

entity

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

Abstract Value Members

  1. abstract def defaultAlias: Alias[Entity]

    Returns default table alias.

    Returns default table alias. This method is abstract and should be implemented with unique name. override def defaultAlias = createAlias("sm")

    Definition Classes
    SkinnyMapperBase
  2. abstract def extract(rs: WrappedResultSet, n: scalikejdbc.ResultName[Entity]): Entity

    Extracts entity from ResultSet.

    Extracts entity from ResultSet.

    Definition Classes
    SkinnyMapperBase

Concrete Value Members

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

    Definition Classes
    AnyRef → Any
  2. final def ##(): Int

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

    Definition Classes
    AnyRef → Any
  4. def apply(rs: WrappedResultSet): Entity

    Extracts entity from ResultSet.

    Extracts entity from ResultSet.

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

    Extracts entity from ResultSet.

    Extracts entity from ResultSet.

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

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

    Definition Classes
    Any
  8. def associations: LinkedHashSet[Association[_]]

    Associations

  9. def autoSession: DBSession

    AutoSession definition.

    AutoSession definition.

    Definition Classes
    AutoSessionFeature
  10. def belongsTo[A](right: AssociationsWithIdFeature[_, A], merge: (Entity, Option[A]) ⇒ Entity): BelongsToAssociation[Entity]

  11. def belongsToWithAlias[A](right: (AssociationsWithIdFeature[_, A], Alias[A]), merge: (Entity, Option[A]) ⇒ Entity): BelongsToAssociation[Entity]

  12. def belongsToWithAliasAndFk[A](right: (AssociationsWithIdFeature[_, A], Alias[A]), fk: String, merge: (Entity, Option[A]) ⇒ Entity): BelongsToAssociation[Entity]

  13. def belongsToWithAliasAndFkAndJoinCondition[A](right: (AssociationsWithIdFeature[_, A], Alias[A]), fk: String, on: scalikejdbc.SQLSyntax, merge: (Entity, Option[A]) ⇒ Entity): BelongsToAssociation[Entity]

  14. def belongsToWithFk[A](right: AssociationsWithIdFeature[_, A], fk: String, merge: (Entity, Option[A]) ⇒ Entity): BelongsToAssociation[Entity]

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

  16. def belongsToWithJoinCondition[A](right: AssociationsWithIdFeature[_, A], on: scalikejdbc.SQLSyntax, merge: (Entity, Option[A]) ⇒ Entity): BelongsToAssociation[Entity]

  17. def clone(): AnyRef

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

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

    Returns column names.

    Returns column names.

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

    Definition Classes
    SQLSyntaxSupport
  21. def connectionPool: ConnectionPool

    Returns connection pool.

    Returns connection pool.

    returns

    pool

    Definition Classes
    ConnectionPoolFeature
  22. def connectionPoolName: Any

    Definition Classes
    SQLSyntaxSupport
  23. def createAlias(name: String): Alias[Entity]

    Creates a new table alias for this mapper.

    Creates a new table alias for this mapper.

    Definition Classes
    SkinnyMapperBase
  24. def createJoinDefinition(joinType: JoinType, left: (AssociationsFeature[_], Alias[_]), right: (AssociationsFeature[_], Alias[_]), on: scalikejdbc.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

  25. def debug(msg: ⇒ Any, t: ⇒ Throwable): Unit

    Attributes
    protected
    Definition Classes
    Logging
  26. def debug(msg: ⇒ Any): Unit

    Attributes
    protected
    Definition Classes
    Logging
  27. val defaultBelongsToExtractors: LinkedHashSet[BelongsToExtractor[Entity]]

  28. val defaultHasOneExtractors: LinkedHashSet[HasOneExtractor[Entity]]

  29. val defaultJoinDefinitions: LinkedHashSet[JoinDefinition[_]]

    Join definitions that are enabled by default.

  30. val defaultOneToManyExtractors: LinkedHashSet[HasManyExtractor[Entity]]

  31. def defaultScope(alias: Alias[Entity]): Option[scalikejdbc.SQLSyntax]

    Returns default scope for select queries.

    Returns default scope for select queries.

    Definition Classes
    SkinnyMapperBase
  32. def defaultScopeWithDefaultAlias: Option[scalikejdbc.SQLSyntax]

    Definition Classes
    SkinnyMapperBase
  33. def defaultSelectQuery: scalikejdbc.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
    AssociationsFeatureSkinnyMapperBase
  34. def delimiterForResultName: String

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

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

    Definition Classes
    AnyRef → Any
  37. def error(msg: ⇒ Any, t: ⇒ Throwable): Unit

    Attributes
    protected
    Definition Classes
    Logging
  38. def error(msg: ⇒ Any): Unit

    Attributes
    protected
    Definition Classes
    Logging
  39. def extract(sql: SQL[Entity, NoExtractor])(implicit includesRepository: IncludesQueryRepository[Entity] = IncludesQueryRepository[Entity]()): SQL[Entity, HasExtractor]

  40. def extractBelongsTo[That](mapper: AssociationsFeature[That], fk: String, alias: Alias[That], merge: (Entity, Option[That]) ⇒ Entity, includesMerge: (Seq[Entity], Seq[That]) ⇒ Seq[Entity] = defaultIncludesMerge[Entity, That]): BelongsToExtractor[Entity]

  41. def extractHasOne[That](mapper: AssociationsFeature[That], fk: String, alias: Alias[That], merge: (Entity, Option[That]) ⇒ Entity, includesMerge: (Seq[Entity], Seq[That]) ⇒ Seq[Entity] = defaultIncludesMerge[Entity, That]): HasOneExtractor[Entity]

  42. def extractOneToMany[M1](mapper: AssociationsFeature[M1], alias: Alias[M1], merge: (Entity, Seq[M1]) ⇒ Entity, includesMerge: (Seq[Entity], Seq[M1]) ⇒ Seq[Entity] = defaultIncludesMerge[Entity, M1]): HasManyExtractor[Entity]

  43. def extractOneToManyWithDefaults[M1](mapper: AssociationsFeature[M1], merge: (Entity, Seq[M1]) ⇒ Entity, includesMerge: (Seq[Entity], Seq[M1]) ⇒ Seq[Entity] = defaultIncludesMerge[Entity, M1]): 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)
    )
    }
  44. def extractWithAssociations(sql: SQL[Entity, NoExtractor], belongsToAssociations: Seq[BelongsToAssociation[Entity]], hasOneAssociations: Seq[HasOneAssociation[Entity]], oneToManyAssociations: Seq[HasManyAssociation[Entity]])(implicit includesRepository: IncludesQueryRepository[Entity] = IncludesQueryRepository[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

  45. def extractWithOneToOneTables(rs: WrappedResultSet, belongsToExtractors: Set[BelongsToExtractor[Entity]], hasOneExtractors: Set[HasOneExtractor[Entity]])(implicit includesRepository: IncludesQueryRepository[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

  46. def finalize(): Unit

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

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

    Definition Classes
    AnyRef → Any
  49. def hasMany[M](many: (AssociationsWithIdFeature[_, M], Alias[M]), on: (Alias[Entity], Alias[M]) ⇒ scalikejdbc.SQLSyntax, merge: (Entity, Seq[M]) ⇒ Entity): HasManyAssociation[Entity]

  50. def hasManyThrough[M1, M2](through: (AssociationsFeature[M1], Alias[M1]), throughOn: (Alias[Entity], Alias[M1]) ⇒ scalikejdbc.SQLSyntax, many: (AssociationsWithIdFeature[_, M2], Alias[M2]), on: (Alias[M1], Alias[M2]) ⇒ scalikejdbc.SQLSyntax, merge: (Entity, Seq[M2]) ⇒ Entity): HasManyAssociation[Entity]

  51. def hasManyThrough[M2](through: AssociationsFeature[_], many: AssociationsWithIdFeature[_, M2], merge: (Entity, Seq[M2]) ⇒ Entity): HasManyAssociation[Entity]

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

  53. def hasOne[A](right: AssociationsWithIdFeature[_, A], merge: (Entity, Option[A]) ⇒ Entity): HasOneAssociation[Entity]

  54. def hasOneWithAlias[A](right: (AssociationsWithIdFeature[_, A], Alias[A]), merge: (Entity, Option[A]) ⇒ Entity): HasOneAssociation[Entity]

  55. def hasOneWithAliasAndFk[A](right: (AssociationsWithIdFeature[_, A], Alias[A]), fk: String, merge: (Entity, Option[A]) ⇒ Entity): HasOneAssociation[Entity]

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

  57. def hasOneWithAliasAndJoinCondition[A](right: (AssociationsWithIdFeature[_, A], Alias[A]), on: scalikejdbc.SQLSyntax, merge: (Entity, Option[A]) ⇒ Entity): HasOneAssociation[Entity]

  58. def hasOneWithFk[A](right: AssociationsWithIdFeature[_, A], fk: String, merge: (Entity, Option[A]) ⇒ Entity): HasOneAssociation[Entity]

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

  60. def hasOneWithJoinCondition[A](right: AssociationsWithIdFeature[_, A], on: scalikejdbc.SQLSyntax, merge: (Entity, Option[A]) ⇒ Entity): HasOneAssociation[Entity]

  61. def hashCode(): Int

    Definition Classes
    AnyRef → Any
  62. def info(msg: ⇒ Any, t: ⇒ Throwable): Unit

    Attributes
    protected
    Definition Classes
    Logging
  63. def info(msg: ⇒ Any): Unit

    Attributes
    protected
    Definition Classes
    Logging
  64. def innerJoin[Left](left: (AssociationsFeature[Left], Alias[Left]), right: (AssociationsFeature[_], Alias[_]), on: (Alias[Left], Alias[_]) ⇒ scalikejdbc.SQLSyntax): JoinDefinition[Entity]

  65. def innerJoin(right: (AssociationsFeature[_], Alias[_]), on: (Alias[Entity], Alias[_]) ⇒ scalikejdbc.SQLSyntax): JoinDefinition[Entity]

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

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

  68. def innerJoinWithDefaults(right: AssociationsFeature[_], on: scalikejdbc.SQLSyntax): JoinDefinition[Entity]

  69. def isDebugEnabled: Boolean

    Attributes
    protected
    Definition Classes
    Logging
  70. def isErrorEnabled: Boolean

    Attributes
    protected
    Definition Classes
    Logging
  71. def isInfoEnabled: Boolean

    Attributes
    protected
    Definition Classes
    Logging
  72. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any
  73. def isTraceEnabled: Boolean

    Attributes
    protected
    Definition Classes
    Logging
  74. def isValidFieldName(name: String): Boolean

    Predicates the field name is valid.

    Predicates the field name is valid.

    Definition Classes
    SkinnyMapperBase
  75. def isWarnEnabled: Boolean

    Attributes
    protected
    Definition Classes
    Logging
  76. def join[Left](left: (AssociationsFeature[Left], Alias[Left]), right: (AssociationsFeature[_], Alias[_]), on: (Alias[Left], Alias[_]) ⇒ scalikejdbc.SQLSyntax): JoinDefinition[Entity]

  77. def join(right: (AssociationsFeature[_], Alias[_]), on: (Alias[Entity], Alias[_]) ⇒ scalikejdbc.SQLSyntax): JoinDefinition[Entity]

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

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

  80. def joinWithDefaults(right: AssociationsFeature[_], on: scalikejdbc.SQLSyntax): JoinDefinition[Entity]

  81. def leftJoin(left: (AssociationsFeature[_], Alias[_]), right: (AssociationsFeature[_], Alias[_]), on: (Alias[_], Alias[_]) ⇒ scalikejdbc.SQLSyntax): JoinDefinition[_]

  82. def leftJoin(right: (AssociationsFeature[_], Alias[_]), on: (Alias[Entity], Alias[_]) ⇒ scalikejdbc.SQLSyntax): JoinDefinition[_]

  83. def leftJoinWithDefaults(left: AssociationsFeature[_], right: AssociationsFeature[_], on: (Alias[_], Alias[_]) ⇒ scalikejdbc.SQLSyntax): JoinDefinition[_]

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

  85. def leftJoinWithDefaults(right: AssociationsFeature[_], on: scalikejdbc.SQLSyntax): JoinDefinition[_]

  86. def logger: Logger

    Attributes
    protected
    Definition Classes
    Logging
  87. def loggerName: String

    Attributes
    protected
    Definition Classes
    Logging
  88. def nameConverters: Map[String, String]

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

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

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

    Definition Classes
    AnyRef
  92. def primaryKeyField: scalikejdbc.SQLSyntax

    Definition Classes
    SkinnyMapperBase
  93. def primaryKeyFieldName: 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"

    Definition Classes
    SkinnyMapperBase
  94. def schemaName: Option[String]

    Definition Classes
    SQLSyntaxSupport
  95. def selectQueryWithAdditionalAssociations(sql: scalikejdbc.SelectSQLBuilder[Entity], belongsToAssociations: Seq[BelongsToAssociation[Entity]], hasOneAssociations: Seq[HasOneAssociation[Entity]], hasManyAssociations: Seq[HasManyAssociation[Entity]]): scalikejdbc.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

  96. def selectQueryWithAssociations: scalikejdbc.SelectSQLBuilder[Entity]

  97. def setAsByDefault(extractor: HasManyExtractor[Entity]): Unit

  98. def setAsByDefault(extractor: HasOneExtractor[Entity]): Unit

  99. def setAsByDefault(extractor: BelongsToExtractor[Entity]): Unit

  100. def singleSelectQuery: scalikejdbc.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.

    Definition Classes
    SkinnyMapperBase
  101. final def synchronized[T0](arg0: ⇒ T0): T0

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

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

    Definition Classes
    SQLSyntaxSupport
  104. def table: scalikejdbc.TableDefSQLSyntax

    Definition Classes
    SQLSyntaxSupport
  105. def tableName: String

    Returns table name.

    Returns table name.

    Definition Classes
    SkinnyMapperBase → SQLSyntaxSupport
  106. def tableNameWithSchema: String

    Definition Classes
    SQLSyntaxSupport
  107. def toDefaultForeignKeyName[A](mapper: AssociationsFeature[A]): String

    Expects mapper's name + primary key name by default.

    Expects mapper's name + primary key name by default.

    A

    enitty type

    mapper

    mapper

    returns

    fk name

    Attributes
    protected
  108. def toString(): String

    Definition Classes
    AnyRef → Any
  109. def trace(msg: ⇒ Any, t: ⇒ Throwable): Unit

    Attributes
    protected
    Definition Classes
    Logging
  110. def trace(msg: ⇒ Any): Unit

    Attributes
    protected
    Definition Classes
    Logging
  111. def underlying: SkinnyMapperBase[Entity]

    Attributes
    protected
    Definition Classes
    SkinnyMapperBase
  112. def useShortenedResultName: Boolean

    Definition Classes
    SQLSyntaxSupport
  113. def useSnakeCaseColumnName: Boolean

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

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

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

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  117. def warn(msg: ⇒ Any, t: ⇒ Throwable): Unit

    Attributes
    protected
    Definition Classes
    Logging
  118. def warn(msg: ⇒ Any): Unit

    Attributes
    protected
    Definition Classes
    Logging
  119. 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.

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

    Provides a code block with a table alias.

    Provides a code block with a table alias.

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

    Provides a code block with the column name provider.

    Provides a code block with the column name provider.

    Definition Classes
    SkinnyMapperBase

Inherited from Logging

Inherited from AutoSessionFeature

Inherited from ConnectionPoolFeature

Inherited from SkinnyMapperBase[Entity]

Inherited from scalikejdbc.SQLSyntaxSupport[Entity]

Inherited from AnyRef

Inherited from Any

Ungrouped