# Class: M2MRelation

# Hierarchy

# Properties

# foreignKey

foreignKey: ForeignKey

Overrides void

Defined in pg-structure/relation/m2m-relation.ts:120


# targetForeignKey

targetForeignKey: ForeignKey

Defined in pg-structure/relation/m2m-relation.ts:130

# Accessors

# info

info:

Overrides void

Defined in pg-structure/relation/m2m-relation.ts:74


# joinAdjective

joinAdjective:

Defined in pg-structure/relation/m2m-relation.ts:243


# joinAlias

joinAlias:

Defined in pg-structure/relation/m2m-relation.ts:228


# joinName

joinName:

Defined in pg-structure/relation/m2m-relation.ts:213


# joinTable

joinTable:

Defined in pg-structure/relation/m2m-relation.ts:97


# name

name:

Inherited from Relation.name

Defined in pg-structure/base/relation.ts:100


# sourceAdjective

sourceAdjective:

Overrides Relation.sourceAdjective

Defined in pg-structure/relation/m2m-relation.ts:238


# sourceAlias

sourceAlias:

Defined in pg-structure/relation/m2m-relation.ts:223


# sourceName

sourceName:

Overrides Relation.sourceName

Defined in pg-structure/relation/m2m-relation.ts:208


# sourceTable

sourceTable:

Overrides void

Defined in pg-structure/relation/m2m-relation.ts:85


# targetAdjective

targetAdjective:

Overrides Relation.targetAdjective

Defined in pg-structure/relation/m2m-relation.ts:248


# targetAlias

targetAlias:

Defined in pg-structure/relation/m2m-relation.ts:233


# targetName

targetName:

Overrides Relation.targetName

Defined in pg-structure/relation/m2m-relation.ts:218


# targetTable

targetTable:

Overrides void

Defined in pg-structure/relation/m2m-relation.ts:108

# Methods

# getJoinAliasWithout

getJoinAliasWithout(without: M2MWithout | M2MWithout[]): string

Defined in pg-structure/relation/m2m-relation.ts:193

Parameters:

Name Type Description
without M2MWithout | M2MWithout[] is type or types of tables to exclude names of.

Returns: string

join table alias after given tables' names replaced.


# getJoinNameWithout

getJoinNameWithout(without: M2MWithout | M2MWithout[]): string

Defined in pg-structure/relation/m2m-relation.ts:163

Parameters:

Name Type Description
without M2MWithout | M2MWithout[] is type or types of tables to exclude names of.

Returns: string

join table name after given tables' names replaced.


# getName

getName(relationNameFunction: RelationNameFunction | BuiltinRelationNameFunction): string

Inherited from Relation.getName

Defined in pg-structure/base/relation.ts:112

Parameters:

Name Type Description
relationNameFunction RelationNameFunction | BuiltinRelationNameFunction is custom function or name of the builtin function to generate names with.

Returns: string

name for the relation using naming function.


# getSourceAliasWithout

getSourceAliasWithout(without: M2MWithout | M2MWithout[]): string

Defined in pg-structure/relation/m2m-relation.ts:183

Parameters:

Name Type Description
without M2MWithout | M2MWithout[] is type or types of tables to exclude names of.

Returns: string

source table alias after given tables' names replaced.


# getSourceNameWithout

getSourceNameWithout(without: M2MWithout | M2MWithout[]): string

Overrides Relation.getSourceNameWithout

Defined in pg-structure/relation/m2m-relation.ts:153

Parameters:

Name Type Description
without M2MWithout | M2MWithout[] is type or types of tables to exclude names of.

Returns: string

source table name after given tables' names replaced.


# getTargetAliasWithout

getTargetAliasWithout(without: M2MWithout | M2MWithout[]): string

Defined in pg-structure/relation/m2m-relation.ts:203

Parameters:

Name Type Description
without M2MWithout | M2MWithout[] is type or types of tables to exclude names of.

Returns: string

target table alias after given tables' names replaced.


# getTargetNameWithout

getTargetNameWithout(without: M2MWithout | M2MWithout[]): string

Overrides Relation.getTargetNameWithout

Defined in pg-structure/relation/m2m-relation.ts:173

Parameters:

Name Type Description
without M2MWithout | M2MWithout[] is type or types of tables to exclude names of.

Returns: string

target table name after given tables' names replaced.