# Class: Relation

# Hierarchy

• Relation

  ↳ M2ORelation

  ↳ O2MRelation

  ↳ M2MRelation

# Accessors

# name

• name:

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

---

# sourceAdjective

• sourceAdjective:

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

---

# sourceName

• sourceName:

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

---

# targetAdjective

• targetAdjective:

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

---

# targetName

• targetName:

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

# Methods

# getName

▸ getName(relationNameFunction: RelationNameFunction | BuiltinRelationNameFunction): string

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.

---

# getSourceNameWithout

▸ getSourceNameWithout(without: RelationWithout | RelationWithout[]): string

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

Parameters:

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

Returns: string

source table name after given tables' names replaced.

---

# getTargetNameWithout

▸ getTargetNameWithout(without: RelationWithout | RelationWithout[]): string

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

Parameters:

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

Returns: string

target table name after given tables' names replaced.