abstractAbstractNamingStrategy

Hierarchy

• AbstractNamingStrategy
  • MongoNamingStrategy
  • UnderscoreNamingStrategy
  • EntityCaseNamingStrategy

Implements

• NamingStrategy

Index

Constructors

• constructor

Methods

• aliasName
• classToMigrationName
• classToTableName
• columnNameToProperty
• getClassName
• indexName
• joinColumnName
• joinKeyColumnName
• joinTableName
• propertyToColumnName
• referenceColumnName

Constructors

constructor

• new AbstractNamingStrategy(): AbstractNamingStrategy

• Returns AbstractNamingStrategy

Methods

aliasName

• aliasName(entityName: string, index: number): string

• Implementation of NamingStrategy.aliasName

  Returns alias name for given entity. The alias needs to be unique across the query, which is by default ensured via appended index parameter. It is optional to use it as long as you ensure it will be unique.

  ---

  Parameters

  • entityName: string

  • index: number

  Returns string

classToMigrationName

• classToMigrationName(timestamp: string): string

• Implementation of NamingStrategy.classToMigrationName

  Return a migration name. This name should allow ordering.

  ---

  Parameters

  • timestamp: string

  Returns string

abstractclassToTableName

• classToTableName(entityName: string): string

• Implementation of NamingStrategy.classToTableName

  Return a table name for an entity class

  ---

  Parameters

  • entityName: string

  Returns string

columnNameToProperty

• columnNameToProperty(columnName: string): string

• Implementation of NamingStrategy.columnNameToProperty

  Return a property for a column name (used in EntityGenerator).

  ---

  Parameters

  • columnName: string

  Returns string

getClassName

• getClassName(file: string, separator?: string): string

• Implementation of NamingStrategy.getClassName

  Return a name of the class based on its file name

  ---

  Parameters

  • file: string

  • separator: string = '-'

  Returns string

indexName

• indexName(tableName: string, columns: string[], type: index | unique | foreign | primary | sequence | check): string

• Implementation of NamingStrategy.indexName

  Returns key/constraint name for given type. Some drivers might not support all the types (e.g. mysql and sqlite enforce the PK name).

  ---

  Parameters

  • tableName: string

  • columns: string[]

  • type: index | unique | foreign | primary | sequence | check

  Returns string

abstractjoinColumnName

• joinColumnName(propertyName: string): string

• Implementation of NamingStrategy.joinColumnName

  Return a join column name for a property

  ---

  Parameters

  • propertyName: string

  Returns string

abstractjoinKeyColumnName

• joinKeyColumnName(entityName: string, referencedColumnName?: string): string

• Implementation of NamingStrategy.joinKeyColumnName

  Return the foreign key column name for the given parameters

  ---

  Parameters

  • entityName: string

  • optionalreferencedColumnName: string

  Returns string

abstractjoinTableName

• joinTableName(sourceEntity: string, targetEntity: string, propertyName?: string): string

• Implementation of NamingStrategy.joinTableName

  Return a join table name

  ---

  Parameters

  • sourceEntity: string

  • targetEntity: string

  • optionalpropertyName: string

  Returns string

abstractpropertyToColumnName

• propertyToColumnName(propertyName: string): string

• Implementation of NamingStrategy.propertyToColumnName

  Return a column name for a property

  ---

  Parameters

  • propertyName: string

  Returns string

abstractreferenceColumnName

• referenceColumnName(): string

• Implementation of NamingStrategy.referenceColumnName

  Return the default reference column name

  ---

  Returns string