UnderscoreNamingStrategy

Hierarchy

• AbstractNamingStrategy
  • UnderscoreNamingStrategy

Index

Constructors

• constructor

Methods

• aliasName
• classToMigrationName
• classToTableName
• columnNameToProperty
• enumValueToEnumProperty
• getClassName
• getEntityName
• getEnumClassName
• indexName
• inverseSideName
• joinColumnName
• joinKeyColumnName
• joinTableName
• propertyToColumnName
• referenceColumnName

Constructors

constructor

• new UnderscoreNamingStrategy(): UnderscoreNamingStrategy

• Inherited from AbstractNamingStrategy.constructor

  Returns UnderscoreNamingStrategy

Methods

inheritedaliasName

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

• Inherited from AbstractNamingStrategy.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

inheritedclassToMigrationName

• classToMigrationName(timestamp: string, customMigrationName?: string): string

• Inherited from AbstractNamingStrategy.classToMigrationName

  Return a migration name. This name should allow ordering.

  ---

  Parameters

  • timestamp: string

  • optionalcustomMigrationName: string

  Returns string

classToTableName

• classToTableName(entityName: string): string

• Overrides AbstractNamingStrategy.classToTableName

  Return a table name for an entity class

  ---

  Parameters

  • entityName: string

  Returns string

inheritedcolumnNameToProperty

• columnNameToProperty(columnName: string): string

• Inherited from AbstractNamingStrategy.columnNameToProperty

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

  ---

  Parameters

  • columnName: string

  Returns string

inheritedenumValueToEnumProperty

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

• Inherited from AbstractNamingStrategy.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.

inheritedgetClassName

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

• Inherited from AbstractNamingStrategy.getClassName

  Return a name of the class based on its file name

  ---

  Parameters

  • file: string

  • separator: string = '-'

  Returns string

inheritedgetEntityName

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

• Inherited from AbstractNamingStrategy.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

inheritedgetEnumClassName

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

• Inherited from AbstractNamingStrategy.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.

inheritedindexName

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

• Inherited from AbstractNamingStrategy.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

inheritedinverseSideName

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

• Inherited from AbstractNamingStrategy.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

joinColumnName

• joinColumnName(propertyName: string): string

• Overrides AbstractNamingStrategy.joinColumnName

  Return a join column name for a property

  ---

  Parameters

  • propertyName: string

  Returns string

joinKeyColumnName

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

• Overrides AbstractNamingStrategy.joinKeyColumnName

  Return the foreign key column name for the given parameters

  ---

  Parameters

  • entityName: string

  • optionalreferencedColumnName: string

  Returns string

joinTableName

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

• Overrides AbstractNamingStrategy.joinTableName

  Return a join table name

  ---

  Parameters

  • sourceEntity: string

  • targetEntity: string

  • propertyName: string

  Returns string

propertyToColumnName

• propertyToColumnName(propertyName: string, object?: boolean): string

• Overrides AbstractNamingStrategy.propertyToColumnName

  Return a column name for a property

  ---

  Parameters

  • propertyName: string

  • optionalobject: boolean

  Returns string

referenceColumnName

• referenceColumnName(): string

• Overrides AbstractNamingStrategy.referenceColumnName

  Return the default reference column name

  ---

  Returns string