API 参考
    正在准备搜索索引...

    接口 NamingStrategyInterface

    Naming strategy defines how auto-generated names for such things like table name, or table column gonna be generated.

    interface NamingStrategyInterface {
        materializedPathColumnName: string;
        name?: string;
        nestedSetColumnNames: { left: string; right: string };
        checkConstraintName(
            tableOrName: string | Table,
            expression: string,
            isEnum?: boolean,
        ): string;
        closureJunctionTableName(originalClosureTableName: string): string;
        columnName(
            propertyName: string,
            customName: undefined | string,
            embeddedPrefixes: string[],
        ): string;
        defaultConstraintName(
            tableOrName: string | Table,
            columnName: string,
        ): string;
        exclusionConstraintName(
            tableOrName: string | Table,
            expression: string,
        ): string;
        foreignKeyName(
            tableOrName: string | Table,
            columnNames: string[],
            referencedTablePath?: string,
            referencedColumnNames?: string[],
        ): string;
        indexName(
            tableOrName: string | Table | View,
            columns: string[],
            where?: string,
        ): string;
        joinColumnName(relationName: string, referencedColumnName: string): string;
        joinTableColumnDuplicationPrefix(columnName: string, index: number): string;
        joinTableColumnName(
            tableName: string,
            propertyName: string,
            columnName?: string,
        ): string;
        joinTableInverseColumnName(
            tableName: string,
            propertyName: string,
            columnName?: string,
        ): string;
        joinTableName(
            firstTableName: string,
            secondTableName: string,
            firstPropertyName: string,
            secondPropertyName: string,
        ): string;
        prefixTableName(prefix: string, tableName: string): string;
        primaryKeyName(tableOrName: string | Table, columnNames: string[]): string;
        relationConstraintName(
            tableOrName: string | Table,
            columnNames: string[],
            where?: string,
        ): string;
        relationName(propertyName: string): string;
        tableName(
            targetName: string,
            userSpecifiedName: undefined | string,
        ): string;
        uniqueConstraintName(
            tableOrName: string | Table,
            columnNames: string[],
        ): string;
    }

    实现于

    索引

    属性

    materializedPathColumnName name? nestedSetColumnNames

    方法

    checkConstraintName closureJunctionTableName columnName defaultConstraintName exclusionConstraintName foreignKeyName indexName joinColumnName joinTableColumnDuplicationPrefix joinTableColumnName joinTableInverseColumnName joinTableName prefixTableName primaryKeyName relationConstraintName relationName tableName uniqueConstraintName

    属性

    materializedPathColumnName: string

    Column name for materialized paths.

    name?: string

    Naming strategy name.

    nestedSetColumnNames: { left: string; right: string }

    Column names for nested sets.

    方法

    • 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.

      参数

      • tableOrName: string | Table
      • expression: string
      • 可选isEnum: boolean

      返回 string

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

      参数

      • originalClosureTableName: string

        Name of the closure table which owns this junction table.

      返回 string

    • Gets the table's column name from the given property name.

      参数

      • propertyName: string
      • customName: undefined | string
      • embeddedPrefixes: string[]

      返回 string

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

      参数

      • tableOrName: string | Table
      • columnName: string

      返回 string

    • Gets the name of the exclusion constraint.

      参数

      • tableOrName: string | Table
      • expression: string

      返回 string

    • Gets the name of the foreign key.

      参数

      • tableOrName: string | Table
      • columnNames: string[]
      • 可选referencedTablePath: string
      • 可选referencedColumnNames: string[]

      返回 string

    • Gets the name of the index - simple and compose index.

      参数

      • tableOrName: string | Table | View
      • columns: string[]
      • 可选where: string

      返回 string

    • Gets the name of the join column used in the one-to-one and many-to-one relations.

      参数

      • relationName: string
      • referencedColumnName: string

      返回 string

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

      参数

      • columnName: string
      • index: number

      返回 string

    • Gets the name of the column used for columns in the junction tables.

      The reverse?:boolean parameter denotes if the joinTableColumnName is called for the junctionColumn (false) or the inverseJunctionColumns (true)

      参数

      • tableName: string
      • propertyName: string
      • 可选columnName: string

      返回 string

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

      参数

      • tableName: string
      • propertyName: string
      • 可选columnName: string

      返回 string

    • Gets the name of the join table used in the many-to-many relations.

      参数

      • firstTableName: string
      • secondTableName: string
      • firstPropertyName: string
      • secondPropertyName: string

      返回 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.

      参数

      • prefix: string
      • tableName: string

      返回 string

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

      参数

      • tableOrName: string | Table
      • columnNames: string[]

      返回 string

    • Gets the relation constraint (UNIQUE or UNIQUE INDEX) name from the given table name, column names and WHERE condition, if UNIQUE INDEX used.

      参数

      • tableOrName: string | Table
      • columnNames: string[]
      • 可选where: string

      返回 string

    • Gets the table's relation name from the given property name.

      参数

      • propertyName: string

      返回 string

    • Normalizes table name.

      参数

      • targetName: string

        Name of the target entity that can be used to generate a table name.

      • userSpecifiedName: undefined | string

        For example if user specified a table name in a decorator, e.g. @Entity("name")

      返回 string

    • Gets the table's unique constraint name from the given table name and column names.

      参数

      • tableOrName: string | Table
      • columnNames: string[]

      返回 string

    显示设置

    成员可见性

    目录

    属性
    方法