Class Relation

Class which represent a relationship. Provides attributes and methods for details of the relationship.

abstract
hideconstructor

Hierarchy

Relation

Index

Accessors

Methods

Accessors

sourceAdjective

get sourceAdjective(): undefined | string

- Defined in src/pg-structure/base/relation.ts:86
Source table's adjective extracted from foreign key name.

Returns undefined | string

sourceName

get sourceName(): string

- Defined in src/pg-structure/base/relation.ts:76
Source table name.

Returns string

targetAdjective

get targetAdjective(): undefined | string

- Defined in src/pg-structure/base/relation.ts:91
Source table's adjective extracted from foreign key name.

Returns undefined | string

targetName

get targetName(): string

- Defined in src/pg-structure/base/relation.ts:81
Target table name

Returns string

Methods

getSourceNameWithout

getSourceNameWithout(without: "any" | "source" | "target" | RelationWithout[]): string

- Defined in src/pg-structure/base/relation.ts:61
Returns source table name after replacing given tables' names from it.

Parameters
- without: "any" | "source" | "target" | RelationWithout[]
  
  is type or types of tables to exclude names of.
Returns string

source table name after given tables' names replaced.

getTargetNameWithout

getTargetNameWithout(without: "any" | "source" | "target" | RelationWithout[]): string

- Defined in src/pg-structure/base/relation.ts:71
Returns target table name after replacing given tables' names from it.

Parameters
- without: "any" | "source" | "target" | RelationWithout[]
  
  is type or types of tables to exclude names of.
Returns string

target table name after given tables' names replaced.

Generated using TypeDoc