Options
All
  • Public
  • Public/Protected
  • All
Menu

Class JoinAttribute

Stores all join attributes which will be used to build a JOIN query.

Hierarchy

  • JoinAttribute

Index

Constructors

constructor

Properties

alias

alias: Alias

Alias of the joined (destination) table.

Optional condition

condition: string

Extra condition applied to "ON" section of join.

Private connection

connection: Connection

direction

direction: "LEFT" | "INNER"

Join direction.

entityOrProperty

entityOrProperty: Function | string

Joined table, entity target, or relation in "post.category" format.

Optional isMappingMany

isMappingMany: boolean

Indicates if user maps one or many objects from the join.

isSelectedCache

isSelectedCache: boolean

isSelectedEvalueated

isSelectedEvalueated: boolean = false

Optional mapToProperty

mapToProperty: string

Property + alias of the object where to joined data should be mapped.

Private queryExpressionMap

queryExpressionMap: QueryExpressionMap

relationCache

relationCache: RelationMetadata | undefined

relationEvalueated

relationEvalueated: boolean = false

Accessors

isMany

  • get isMany(): boolean

isSelected

  • get isSelected(): boolean

junctionAlias

  • get junctionAlias(): string

mapToPropertyParentAlias

  • get mapToPropertyParentAlias(): string | undefined

mapToPropertyPropertyName

  • get mapToPropertyPropertyName(): string | undefined

metadata

parentAlias

  • get parentAlias(): string | undefined
  • Alias of the parent of this join. For example, if we join ("post.category", "categoryAlias") then "post" is a parent alias. This value is extracted from entityOrProperty value. This is available when join was made using "post.category" syntax.

    Returns string | undefined

relation

  • Relation of the parent. This is used to understand what is joined. This is available when join was made using "post.category" syntax. Relation can be undefined if entityOrProperty is regular entity or custom table.

    Returns RelationMetadata | undefined

relationPropertyPath

  • get relationPropertyPath(): string | undefined
  • Relation property name of the parent. This is used to understand what is joined. For example, if we join ("post.category", "categoryAlias") then "category" is a relation property. This value is extracted from entityOrProperty value. This is available when join was made using "post.category" syntax.

    Returns string | undefined

tablePath

  • get tablePath(): string

Generated using TypeDoc