Skip to main content

Version: 6.3

abstractAbstractNamingStrategy

Hierarchy

AbstractNamingStrategy

Implements

NamingStrategy

Index

Constructors

constructor

Methods

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, customMigrationName?: string): string

Implementation of NamingStrategy.classToMigrationName
Return a migration name. This name should allow ordering.
Parameters
- timestamp: string
- optionalcustomMigrationName: 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

enumValueToEnumProperty

enumValueToEnumProperty(enumValue: string, columnName: string, tableName: string, schemaName?: string): string

Implementation of NamingStrategy.enumValueToEnumProperty
Get an enum option name for a given enum value.
Parameters
- enumValue: string
  The enum value to generate a name for.
- columnName: string
  The column name which has the enum.
- tableName: string
  The table name of the column.
- optionalschemaName: string
  The schema name of the column.
Returns string
The name of the enum property that will hold the value.

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

getEntityName

getEntityName(tableName: string, schemaName?: string): string

Implementation of NamingStrategy.getEntityName
Return a name of the entity class based on database table name (used in EntityGenerator). Default implementation ignores the schema name.
Parameters
- tableName: string
- optionalschemaName: string
Returns string

getEnumClassName

getEnumClassName(columnName: string, tableName: string, schemaName?: string): string

Implementation of NamingStrategy.getEnumClassName
Get an enum class name.
Parameters
- columnName: string
  The column name which has the enum.
- tableName: string
  The table name of the column.
- optionalschemaName: string
  The schema name of the column.
Returns string
A new class name that will be used for the enum.

indexName

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

Implementation of NamingStrategy.indexName
Returns key/constraint name for the 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: primary | index | unique | foreign | sequence | check
Returns string

inverseSideName

inverseSideName(entityName: string, propertyName: string, kind: ReferenceKind): string

Implementation of NamingStrategy.inverseSideName
Returns the name of the inverse side property. Used in the EntityGenerator with bidirectionalRelations option.
Parameters
- entityName: string
- propertyName: string
- kind: ReferenceKind
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, object?: boolean): string

Implementation of NamingStrategy.propertyToColumnName
Return a column name for a property
Parameters
- propertyName: string
- optionalobject: boolean
Returns string

abstractreferenceColumnName

referenceColumnName(): string

Implementation of NamingStrategy.referenceColumnName
Return the default reference column name
Returns string