Class JoinTable<T, K>`Abstract`

Abstract class representing a join table for HasAndBelongsToMany relationships. This class should be extended for specific join table implementations. It is virtual and not persisted to the database but manages the BelongsToLinks in each related entity's partition.

Example:

class ExampleJoinTable extends JoinTable {
  public exampleId1: ForeignKey;
  public exampleId2: ForeignKey;
}

Type Parameters

T extends default
K extends default

Index

Constructors

constructor

new JoinTable<T, K>(type1, type2): JoinTable<T, K>
Type Parameters
- T extends default
- K extends default
Parameters
- type1: EntityClass<T>
- type2: EntityClass<K>
Returns JoinTable<T, K>
- Defined in src/relationships/JoinTable.ts:52

Properties

`Private` `Readonly` type1

type1: EntityClass<T>

`Private` `Readonly` type2

type2: EntityClass<K>

Methods

`Static` create

create<ThisClass, T, K>(this, keys): Promise<void>
Create a JoinTable entry Adds BelongsToLink to each associated Entity's partition
Type Parameters
- ThisClass extends JoinTable<T, K>
- T extends default
- K extends default
Parameters
- this: (new (type1, type2) => ThisClass)
  - - new (type1, type2): ThisClass
    - Parameters
      type1: EntityClass<T>
      type2: EntityClass<K>
      Returns ThisClass
- keys: ForeignKeyProperties<ThisClass>
Returns Promise<void>
- Defined in src/relationships/JoinTable.ts:63

`Static` `Private` createBelongsToLink

createBelongsToLink(transactionBuilder, keys, parentEntityMeta, linkedEntityMeta): void
Creates transactions:
1. Create a BelongsToLink in parents partition if its not already linked
2. Ensures that the parent EntityExists
Parameters
- transactionBuilder: TransactionBuilder
- keys: ForeignKeyProperties<JoinTable<default, default>>
- parentEntityMeta: JoinTableMetadata
- linkedEntityMeta: JoinTableMetadata
Returns void
- Defined in src/relationships/JoinTable.ts:114

`Static` delete

delete<ThisClass, T, K>(this, keys): Promise<void>
Delete a JoinTable entry Deletes BelongsToLink from each associated Entity's partition
Type Parameters
- ThisClass extends JoinTable<T, K>
- T extends default
- K extends default
Parameters
- this: (new (type1, type2) => ThisClass)
  - - new (type1, type2): ThisClass
    - Parameters
      type1: EntityClass<T>
      type2: EntityClass<K>
      Returns ThisClass
- keys: ForeignKeyProperties<ThisClass>
Returns Promise<void>
- Defined in src/relationships/JoinTable.ts:87

`Static` `Private` deleteBelongsToLink

deleteBelongsToLink(transactionBuilder, keys, parentEntityMeta, linkedEntityMeta): void
Deletes transactions:
1. Delete a BelongsToLink in parents partition if its linked
Parameters
- transactionBuilder: TransactionBuilder
- keys: ForeignKeyProperties<JoinTable<default, default>>
- parentEntityMeta: JoinTableMetadata
- linkedEntityMeta: JoinTableMetadata
Returns void
- Defined in src/relationships/JoinTable.ts:167

`Static` `Private` joinTableKey

joinTableKey(keys, parentEntityMeta, linkedEntityMeta): Record<string, string>
Parameters
- keys: ForeignKeyProperties<JoinTable<default, default>>
- parentEntityMeta: JoinTableMetadata
- linkedEntityMeta: JoinTableMetadata
Returns Record<string, string>
- Defined in src/relationships/JoinTable.ts:193

`Static` `Private` transactionProps

transactionProps(keys, parentEntityMeta, linkedEntityMeta): TransactionProps
Parameters
- keys: ForeignKeyProperties<JoinTable<default, default>>
- parentEntityMeta: JoinTableMetadata
- linkedEntityMeta: JoinTableMetadata
Returns TransactionProps
- Defined in src/relationships/JoinTable.ts:213

Class JoinTable<T, K>Abstract

Type Parameters

Index

Constructors

Properties

Methods

Constructors

constructor

Type Parameters

Parameters

Returns JoinTable<T, K>

Properties

Private Readonly type1

Private Readonly type2

Methods

Static create

Type Parameters

Parameters

Parameters

Returns ThisClass

Returns Promise<void>

Static Private createBelongsToLink

Parameters

Returns void

Static delete

Type Parameters

Parameters

Parameters

Returns ThisClass

Returns Promise<void>

Static Private deleteBelongsToLink

Parameters

Returns void

Static Private joinTableKey

Parameters

Returns Record<string, string>

Static Private transactionProps

Parameters

Returns TransactionProps

Settings

Member Visibility

Theme

On This Page

Class JoinTable<T, K>`Abstract`

`Private` `Readonly` type1

`Private` `Readonly` type2

`Static` create

`Static` `Private` createBelongsToLink

`Static` delete

`Static` `Private` deleteBelongsToLink

`Static` `Private` joinTableKey

`Static` `Private` transactionProps