SnakeNamingStrategy

A TypeORM naming strategy that converts names to snake_case.

Extends

• DefaultNamingStrategy

Implements

• NamingStrategyInterface

Constructors

new SnakeNamingStrategy()

new SnakeNamingStrategy(): SnakeNamingStrategy

Returns

SnakeNamingStrategy

Inherited from

DefaultNamingStrategy.constructor

Properties

materializedPathColumnName

materializedPathColumnName: string;

Column name for materialized paths.

Implementation of

NamingStrategyInterface.materializedPathColumnName

Inherited from

DefaultNamingStrategy.materializedPathColumnName

---

nestedSetColumnNames

nestedSetColumnNames: object;

Column names for nested sets.

left

left: string;

right

right: string;

Implementation of

NamingStrategyInterface.nestedSetColumnNames

Inherited from

DefaultNamingStrategy.nestedSetColumnNames

Methods

checkConstraintName()

checkConstraintName(
   tableOrName, 
   expression, 
   isEnum?): string

Gets the name of the check constraint.

"isEnum" parameter is used to indicate if this check constraint used to handle "simple-enum" type for databases that are not supporting "enum" type out of the box. If "true", constraint is ignored during CHECK constraints synchronization.

Parameters

Parameter	Type
tableOrName	string | Table
expression	string
isEnum?	boolean

Returns

string

Implementation of

NamingStrategyInterface.checkConstraintName

Inherited from

DefaultNamingStrategy.checkConstraintName

---

classTableInheritanceParentColumnName()

classTableInheritanceParentColumnName(parentTableName, parentTableIdPropertyName): string

Parameters

Parameter	Type
parentTableName	any
parentTableIdPropertyName	any

Returns

string

---

closureJunctionTableName()

closureJunctionTableName(originalClosureTableName): string

Creates a table name for a junction table of a closure table.

Parameters

Parameter	Type	Description
originalClosureTableName	string	Name of the closure table which owns this junction table.

Returns

string

Implementation of

NamingStrategyInterface.closureJunctionTableName

Inherited from

DefaultNamingStrategy.closureJunctionTableName

---

columnName()

columnName(
   propertyName, 
   customName, 
   embeddedPrefixes): string

Parameters

Parameter	Type
propertyName	string
customName	string
embeddedPrefixes	string[]

Returns

string

Implementation of

NamingStrategyInterface.columnName

Overrides

DefaultNamingStrategy.columnName

---

defaultConstraintName()

defaultConstraintName(tableOrName, columnName): string

Gets the table's default constraint name from the given table name and column name.

Parameters

Parameter	Type
tableOrName	string | Table
columnName	string

Returns

string

Implementation of

NamingStrategyInterface.defaultConstraintName

Overrides

DefaultNamingStrategy.defaultConstraintName

---

eagerJoinRelationAlias()

eagerJoinRelationAlias(alias, propertyPath): string

Parameters

Parameter	Type
alias	string
propertyPath	string

Returns

string

---

exclusionConstraintName()

exclusionConstraintName(tableOrName, expression): string

Gets the name of the exclusion constraint.

Parameters

Parameter	Type
tableOrName	string | Table
expression	string

Returns

string

Implementation of

NamingStrategyInterface.exclusionConstraintName

Inherited from

DefaultNamingStrategy.exclusionConstraintName

---

foreignKeyName()

foreignKeyName(
   tableOrName, 
   columnNames, 
   referencedTablePath?, 
   referencedColumnNames?): string

Parameters

Parameter	Type
tableOrName	string | Table
columnNames	string[]
referencedTablePath?	string
referencedColumnNames?	string[]

Returns

string

Implementation of

NamingStrategyInterface.foreignKeyName

Overrides

DefaultNamingStrategy.foreignKeyName

---

getTableName()

protected getTableName(tableOrName): string

Parameters

Parameter	Type
tableOrName	string | Table

Returns

string

Inherited from

DefaultNamingStrategy.getTableName

---

indexName()

indexName(
   tableName, 
   columnNames, 
   _where): string

Parameters

Parameter	Type
tableName	string
columnNames	string[]
_where	string

Returns

string

Implementation of

NamingStrategyInterface.indexName

Overrides

DefaultNamingStrategy.indexName

---

joinColumnName()

joinColumnName(relationName, referencedColumnName): string

Parameters

Parameter	Type
relationName	string
referencedColumnName	string

Returns

string

Implementation of

NamingStrategyInterface.joinColumnName

Overrides

DefaultNamingStrategy.joinColumnName

---

joinTableColumnDuplicationPrefix()

joinTableColumnDuplicationPrefix(columnName, index): string

Columns in join tables can have duplicate names in case of self-referencing. This method provide a resolution for such column names.

Parameters

Parameter	Type
columnName	string
index	number

Returns

string

Implementation of

NamingStrategyInterface.joinTableColumnDuplicationPrefix

Inherited from

DefaultNamingStrategy.joinTableColumnDuplicationPrefix

---

joinTableColumnName()

joinTableColumnName(
   tableName, 
   propertyName, 
   columnName?): string

Parameters

Parameter	Type
tableName	string
propertyName	string
columnName?	string

Returns

string

Implementation of

NamingStrategyInterface.joinTableColumnName

Overrides

DefaultNamingStrategy.joinTableColumnName

---

joinTableInverseColumnName()

joinTableInverseColumnName(
   tableName, 
   propertyName, 
   columnName?): string

Gets the name of the column used for columns in the junction tables from the invers side of the relationship.

Parameters

Parameter	Type
tableName	string
propertyName	string
columnName?	string

Returns

string

Implementation of

NamingStrategyInterface.joinTableInverseColumnName

Inherited from

DefaultNamingStrategy.joinTableInverseColumnName

---

joinTableName()

joinTableName(
   firstTableName, 
   secondTableName, 
   firstPropertyName, 
   _secondPropertyName): string

Parameters

Parameter	Type
firstTableName	string
secondTableName	string
firstPropertyName	string
_secondPropertyName	string

Returns

string

Implementation of

NamingStrategyInterface.joinTableName

Overrides

DefaultNamingStrategy.joinTableName

---

prefixTableName()

prefixTableName(prefix, tableName): string

Adds globally set prefix to the table name. This method is executed no matter if prefix was set or not. Table name is either user's given table name, either name generated from entity target. Note that table name comes here already normalized by #tableName method.

Parameters

Parameter	Type
prefix	string
tableName	string

Returns

string

Implementation of

NamingStrategyInterface.prefixTableName

Inherited from

DefaultNamingStrategy.prefixTableName

---

primaryKeyName()

primaryKeyName(tableOrName, columnNames): string

Gets the table's primary key name from the given table name and column names.

Parameters

Parameter	Type
tableOrName	string | Table
columnNames	string[]

Returns

string

Implementation of

NamingStrategyInterface.primaryKeyName

Inherited from

DefaultNamingStrategy.primaryKeyName

---

relationConstraintName()

relationConstraintName(
   tableOrName, 
   columnNames, 
   where?): string

Parameters

Parameter	Type
tableOrName	string | Table
columnNames	string[]
where?	string

Returns

string

Implementation of

NamingStrategyInterface.relationConstraintName

Overrides

DefaultNamingStrategy.relationConstraintName

---

relationName()

relationName(propertyName): string

Parameters

Parameter	Type
propertyName	string

Returns

string

Implementation of

NamingStrategyInterface.relationName

Overrides

DefaultNamingStrategy.relationName

---

tableName()

tableName(className, customName): string

Normalizes table name.

Parameters

Parameter	Type
className	string
customName	string

Returns

string

Implementation of

NamingStrategyInterface.tableName

Overrides

DefaultNamingStrategy.tableName

---

uniqueConstraintName()

uniqueConstraintName(tableOrName, columnNames): string

Parameters

Parameter	Type
tableOrName	string | Table
columnNames	string[]

Returns

string

Implementation of

NamingStrategyInterface.uniqueConstraintName

Overrides

DefaultNamingStrategy.uniqueConstraintName