Class MetadataRegistry

Methods

`Static` getInstance

getInstance(): MetadataRegistry
Returns MetadataRegistry
- Defined in core/metadata-registry.ts:26

registerEntity

registerEntity<T>(entityClass, metadata): void
Register an entity class with its metadata
Type Parameters
- T
Parameters
- entityClass: (new () => T)
  - - new (): T
    - Returns T
- metadata: EntityMetadata
Returns void
- Defined in core/metadata-registry.ts:36

registerColumn

registerColumn<T>(entityClass, propertyName, metadata): void
Register a column metadata for an entity
Type Parameters
- T
Parameters
- entityClass: (new () => T)
  - - new (): T
    - Returns T
- propertyName: string
- metadata: ColumnMetadata
Returns void
- Defined in core/metadata-registry.ts:56

registerRelation

registerRelation<T>(entityClass, propertyName, metadata): void
Register a relation metadata for an entity
Type Parameters
- T
Parameters
- entityClass: (new () => T)
  - - new (): T
    - Returns T
- propertyName: string
- metadata: RelationMetadata
Returns void
- Defined in core/metadata-registry.ts:72

registerHook

registerHook<T>(entityClass, propertyName, metadata): void
Register a hook metadata for an entity
Type Parameters
- T
Parameters
- entityClass: (new () => T)
  - - new (): T
    - Returns T
- propertyName: string
- metadata: HookMetadata
Returns void
- Defined in core/metadata-registry.ts:88

registerIndex

registerIndex<T>(entityClass, indexName, metadata): void
Register an index metadata for an entity
Type Parameters
- T
Parameters
- entityClass: (new () => T)
  - - new (): T
    - Returns T
- indexName: string
- metadata: IndexMetadata
Returns void
- Defined in core/metadata-registry.ts:100

getEntity

getEntity<T>(entityClass): undefined | EntityMetadata
Get entity metadata by class
Type Parameters
- T
Parameters
- entityClass: (new () => T)
  - - new (): T
    - Returns T
Returns undefined | EntityMetadata
- Defined in core/metadata-registry.ts:110

getColumn

getColumn<T>(entityClass, propertyName): undefined | ColumnMetadata
Get column metadata for an entity property
Type Parameters
- T
Parameters
- entityClass: (new () => T)
  - - new (): T
    - Returns T
- propertyName: string
Returns undefined | ColumnMetadata
- Defined in core/metadata-registry.ts:117

getColumns

getColumns<T>(entityClass): ColumnMetadata[]
Get all columns for an entity
Type Parameters
- T
Parameters
- entityClass: (new () => T)
  - - new (): T
    - Returns T
Returns ColumnMetadata[]
- Defined in core/metadata-registry.ts:125

getRelation

getRelation<T>(entityClass, propertyName): undefined | RelationMetadata
Get relation metadata for an entity property
Type Parameters
- T
Parameters
- entityClass: (new () => T)
  - - new (): T
    - Returns T
- propertyName: string
Returns undefined | RelationMetadata
- Defined in core/metadata-registry.ts:133

getRelations

getRelations<T>(entityClass): RelationMetadata[]
Get all relations for an entity
Type Parameters
- T
Parameters
- entityClass: (new () => T)
  - - new (): T
    - Returns T
Returns RelationMetadata[]
- Defined in core/metadata-registry.ts:141

getHook

getHook<T>(entityClass, propertyName): undefined | HookMetadata
Get hook metadata for an entity property
Type Parameters
- T
Parameters
- entityClass: (new () => T)
  - - new (): T
    - Returns T
- propertyName: string
Returns undefined | HookMetadata
- Defined in core/metadata-registry.ts:149

getHooks

getHooks<T>(entityClass): HookMetadata[]
Get all hooks for an entity
Type Parameters
- T
Parameters
- entityClass: (new () => T)
  - - new (): T
    - Returns T
Returns HookMetadata[]
- Defined in core/metadata-registry.ts:157

getIndex

getIndex<T>(entityClass, indexName): undefined | IndexMetadata
Get index metadata for an entity
Type Parameters
- T
Parameters
- entityClass: (new () => T)
  - - new (): T
    - Returns T
- indexName: string
Returns undefined | IndexMetadata
- Defined in core/metadata-registry.ts:165

getIndexes

getIndexes<T>(entityClass): IndexMetadata[]
Get all indexes for an entity
Type Parameters
- T
Parameters
- entityClass: (new () => T)
  - - new (): T
    - Returns T
Returns IndexMetadata[]
- Defined in core/metadata-registry.ts:173

getPrimaryKey

getPrimaryKey<T>(entityClass): undefined | ColumnMetadata
Get primary key column for an entity
Type Parameters
- T
Parameters
- entityClass: (new () => T)
  - - new (): T
    - Returns T
Returns undefined | ColumnMetadata
- Defined in core/metadata-registry.ts:181

getForeignKeys

getForeignKeys<T>(entityClass): ColumnMetadata[]
Get foreign key columns for an entity
Type Parameters
- T
Parameters
- entityClass: (new () => T)
  - - new (): T
    - Returns T
Returns ColumnMetadata[]
- Defined in core/metadata-registry.ts:189

hasEntity

hasEntity<T>(entityClass): boolean
Check if entity is registered
Type Parameters
- T
Parameters
- entityClass: (new () => T)
  - - new (): T
    - Returns T
Returns boolean
- Defined in core/metadata-registry.ts:197

clear

clear(): void
Clear all metadata (useful for testing)

Returns void
- Defined in core/metadata-registry.ts:204

getEntityByTableName

getEntityByTableName(tableName): undefined | EntityMetadata
Get entity by table name
Parameters
- tableName: string
Returns undefined | EntityMetadata
- Defined in core/metadata-registry.ts:215

getEntityClassByTableName

getEntityClassByTableName<T>(tableName): undefined | (new () => T)
Get entity class by table name
Type Parameters
- T
Parameters
- tableName: string
Returns undefined | (new () => T)
- Defined in core/metadata-registry.ts:227

getAllEntities

getAllEntities(): EntityMetadata[]
Get all registered entities

Returns EntityMetadata[]
- Defined in core/metadata-registry.ts:239