skinny.orm.feature

JoinsFeature

trait JoinsFeature[Entity] extends SkinnyMapperBase[Entity] with AssociationsFeature[Entity]

Provides #joins APIs.

NOTE: CRUDFeature has copy implementation from this trait.

Self Type
JoinsFeature[Entity] with IdFeature[_]
Linear Supertypes
Known Subclasses
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. JoinsFeature
  2. AssociationsFeature
  3. LoggerProvider
  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 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: 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.

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

    Extracts entity from ResultSet.

    Extracts entity from ResultSet.

    Definition Classes
    SkinnyMapperBase
  8. def as(provider: scalikejdbc.QuerySQLSyntaxProvider[scalikejdbc.SQLSyntaxSupport[Entity], Entity]): scalikejdbc.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: AssociationsWithIdFeature[_, A], merge: (Entity, Option[A]) ⇒ Entity): BelongsToAssociation[Entity]

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

    Definition Classes
    AssociationsFeature
  14. def belongsToWithAliasAndFk[A](right: (AssociationsWithIdFeature[_, 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.SQLSyntax, merge: (Entity, Option[A]) ⇒ Entity): BelongsToAssociation[Entity]

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

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

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

    Definition Classes
    AssociationsFeature
  19. def clearLoadedColumns(): Unit

    Definition Classes
    SQLSyntaxSupport
  20. def clone(): AnyRef

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

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

    Returns column names.

    Returns column names.

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

    Definition Classes
    SQLSyntaxSupport
  24. def connectionPool: ConnectionPool

    Returns connection pool.

    Returns connection pool.

    returns

    pool

    Definition Classes
    ConnectionPoolFeature
  25. def connectionPoolName: Any

    Definition Classes
    SQLSyntaxSupport
  26. 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
  27. 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

    Definition Classes
    AssociationsFeature
  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 defaultScope(alias: Alias[Entity]): Option[scalikejdbc.SQLSyntax]

    Returns default scope for select queries.

    Returns default scope for select queries.

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

    Definition Classes
    SkinnyMapperBase
  34. 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
  35. def delimiterForResultName: String

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

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

    Definition Classes
    AnyRef → Any
  38. def extract(sql: SQL[Entity, NoExtractor])(implicit includesRepository: IncludesQueryRepository[Entity]): SQL[Entity, HasExtractor]

    Definition Classes
    JoinsFeatureAssociationsFeature
  39. 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]

    Definition Classes
    AssociationsFeature
  40. 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]

    Definition Classes
    AssociationsFeature
  41. def extractOneToMany[M1](mapper: AssociationsFeature[M1], fk: String, alias: Alias[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)
    )
    }
    Definition Classes
    AssociationsFeature
  42. 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

    Definition Classes
    AssociationsFeature
  43. 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

    Definition Classes
    AssociationsFeature
  44. def finalize(): Unit

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

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

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

    Definition Classes
    AssociationsFeature
  48. 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]

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

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

    Definition Classes
    AssociationsFeature
  51. def hasManyWithFk[M](many: (AssociationsFeature[M], Alias[M]), fk: String, on: (Alias[Entity], Alias[M]) ⇒ scalikejdbc.SQLSyntax, merge: (Entity, Seq[M]) ⇒ Entity): HasManyAssociation[Entity]

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

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

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

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

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

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

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

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

    Definition Classes
    AssociationsFeature
  60. def hashCode(): Int

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

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

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

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

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

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

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

    Predicates the field name is valid.

    Predicates the field name is valid.

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

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

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

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

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

    Definition Classes
    AssociationsFeature
  73. def joins[Id](associations: Association[_]*): JoinsFeature[Entity] with IdFeature[Id] with FinderFeatureWithId[Id, Entity] with QueryingFeatureWithId[Id, Entity]

    Appends join definition on runtime.

    Appends join definition on runtime.

    associations

    associations

    returns

    self

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

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

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

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

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

    Definition Classes
    AssociationsFeature
  79. def logger: Logger

    Attributes
    protected
    Definition Classes
    LoggerProvider
  80. def loggerName: String

    Attributes
    protected
    Definition Classes
    LoggerProvider
  81. def nameConverters: Map[String, String]

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

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

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

    Definition Classes
    AnyRef
  85. def primaryKeyField: scalikejdbc.SQLSyntax

    Definition Classes
    SkinnyMapperBase
  86. 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
  87. def schemaName: Option[String]

    Definition Classes
    SQLSyntaxSupport
  88. 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

    Definition Classes
    AssociationsFeature
  89. def selectQueryWithAssociations: scalikejdbc.SelectSQLBuilder[Entity]

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

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

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

    Definition Classes
    AssociationsFeature
  93. 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
  94. final def synchronized[T0](arg0: ⇒ T0): T0

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

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

    Definition Classes
    SQLSyntaxSupport
  97. def table: scalikejdbc.TableDefSQLSyntax

    Definition Classes
    SQLSyntaxSupport
  98. def tableName: String

    Returns table name.

    Returns table name.

    Definition Classes
    SkinnyMapperBase → SQLSyntaxSupport
  99. def tableNameWithSchema: String

    Definition Classes
    SQLSyntaxSupport
  100. 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

    entity type

    mapper

    mapper

    returns

    fk name

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

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

    Attributes
    protected
    Definition Classes
    SkinnyMapperBase
  103. def useShortenedResultName: Boolean

    Definition Classes
    SQLSyntaxSupport
  104. def useSnakeCaseColumnName: Boolean

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

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

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

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  108. 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
  109. 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
  110. 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 AssociationsFeature[Entity]

Inherited from LoggerProvider

Inherited from AutoSessionFeature

Inherited from ConnectionPoolFeature

Inherited from SkinnyMapperBase[Entity]

Inherited from scalikejdbc.SQLSyntaxSupport[Entity]

Inherited from AnyRef

Inherited from Any

Ungrouped