Class: EntitySchema<T, U>
Type parameters#
| Name | Type | Default |
|---|---|---|
T | AnyEntity<T> | AnyEntity |
U | AnyEntity<U> | undefined | undefined |
Hierarchy#
- EntitySchema
Constructors#
constructor#
+ new EntitySchema(meta: Metadata<T, U>): EntitySchema
Defined in packages/core/src/metadata/EntitySchema.ts:32
Parameters:#
| Name | Type |
|---|---|
meta | Metadata<T, U> |
Returns: EntitySchema
Properties#
_meta#
• Private Readonly _meta: EntityMetadata<T> = new EntityMetadata<T>()
Defined in packages/core/src/metadata/EntitySchema.ts:30
initialized#
• Private initialized: boolean = false
Defined in packages/core/src/metadata/EntitySchema.ts:32
internal#
• Private internal: boolean = false
Defined in packages/core/src/metadata/EntitySchema.ts:31
Accessors#
meta#
• get meta(): EntityMetadata<T>
Defined in packages/core/src/metadata/EntitySchema.ts:207
Returns: EntityMetadata<T>
name#
• get name(): EntityName<T>
Defined in packages/core/src/metadata/EntitySchema.ts:211
Returns: EntityName<T>
Methods#
addEmbedded#
â–¸ addEmbedded<K>(name: string & keyof T, options: EmbeddedOptions): void
Defined in packages/core/src/metadata/EntitySchema.ts:113
Type parameters:#
| Name | Default |
|---|---|
K | unknown |
Parameters:#
| Name | Type |
|---|---|
name | string & keyof T |
options | EmbeddedOptions |
Returns: void
addEnum#
â–¸ addEnum(name: string & keyof T, type?: TypeType, options?: EnumOptions<T>): void
Defined in packages/core/src/metadata/EntitySchema.ts:85
Parameters:#
| Name | Type | Default value |
|---|---|---|
name | string & keyof T | - |
type? | TypeType | - |
options | EnumOptions<T> | {} |
Returns: void
addIndex#
â–¸ addIndex<T>(options: Required<Omit<IndexOptions<T>, "name" | "type" | "options">> & { name?: string ; options?: Dictionary ; type?: string }): void
Defined in packages/core/src/metadata/EntitySchema.ts:179
Type parameters:#
| Name |
|---|
T |
Parameters:#
| Name | Type |
|---|---|
options | Required<Omit<IndexOptions<T>, "name" | "type" | "options">> & { name?: string ; options?: Dictionary ; type?: string } |
Returns: void
addManyToMany#
â–¸ addManyToMany<K>(name: string & keyof T, type: TypeType, options: ManyToManyOptions<K, T>): void
Defined in packages/core/src/metadata/EntitySchema.ts:138
Type parameters:#
| Name | Default |
|---|---|
K | unknown |
Parameters:#
| Name | Type |
|---|---|
name | string & keyof T |
type | TypeType |
options | ManyToManyOptions<K, T> |
Returns: void
addManyToOne#
â–¸ addManyToOne<K>(name: string & keyof T, type: TypeType, options: ManyToOneOptions<K, T>): void
Defined in packages/core/src/metadata/EntitySchema.ts:123
Type parameters:#
| Name | Default |
|---|---|
K | unknown |
Parameters:#
| Name | Type |
|---|---|
name | string & keyof T |
type | TypeType |
options | ManyToOneOptions<K, T> |
Returns: void
addOneToMany#
â–¸ addOneToMany<K>(name: string & keyof T, type: TypeType, options: OneToManyOptions<K, T>): void
Defined in packages/core/src/metadata/EntitySchema.ts:153
Type parameters:#
| Name | Default |
|---|---|
K | unknown |
Parameters:#
| Name | Type |
|---|---|
name | string & keyof T |
type | TypeType |
options | OneToManyOptions<K, T> |
Returns: void
addOneToOne#
â–¸ addOneToOne<K>(name: string & keyof T, type: TypeType, options: OneToOneOptions<K, T>): void
Defined in packages/core/src/metadata/EntitySchema.ts:158
Type parameters:#
| Name | Default |
|---|---|
K | unknown |
Parameters:#
| Name | Type |
|---|---|
name | string & keyof T |
type | TypeType |
options | OneToOneOptions<K, T> |
Returns: void
addPrimaryKey#
â–¸ addPrimaryKey(name: string & keyof T, type: TypeType, options?: PrimaryKeyOptions<T>): void
Defined in packages/core/src/metadata/EntitySchema.ts:104
Parameters:#
| Name | Type | Default value |
|---|---|---|
name | string & keyof T | - |
type | TypeType | - |
options | PrimaryKeyOptions<T> | {} |
Returns: void
addProperty#
â–¸ addProperty(name: string & keyof T, type?: TypeType, options?: PropertyOptions<T> | EntityProperty): void
Defined in packages/core/src/metadata/EntitySchema.ts:53
Parameters:#
| Name | Type | Default value |
|---|---|---|
name | string & keyof T | - |
type? | TypeType | - |
options | PropertyOptions<T> | EntityProperty | {} |
Returns: void
addSerializedPrimaryKey#
â–¸ addSerializedPrimaryKey(name: string & keyof T, type: TypeType, options?: SerializedPrimaryKeyOptions<T>): void
Defined in packages/core/src/metadata/EntitySchema.ts:108
Parameters:#
| Name | Type | Default value |
|---|---|---|
name | string & keyof T | - |
type | TypeType | - |
options | SerializedPrimaryKeyOptions<T> | {} |
Returns: void
addUnique#
â–¸ addUnique<T>(options: Required<Omit<UniqueOptions<T>, "name" | "options">> & { name?: string ; options?: Dictionary }): void
Defined in packages/core/src/metadata/EntitySchema.ts:183
Type parameters:#
| Name |
|---|
T |
Parameters:#
| Name | Type |
|---|---|
options | Required<Omit<UniqueOptions<T>, "name" | "options">> & { name?: string ; options?: Dictionary } |
Returns: void
addVersion#
â–¸ addVersion(name: string & keyof T, type: TypeType, options?: PropertyOptions<T>): void
Defined in packages/core/src/metadata/EntitySchema.ts:100
Parameters:#
| Name | Type | Default value |
|---|---|---|
name | string & keyof T | - |
type | TypeType | - |
options | PropertyOptions<T> | {} |
Returns: void
createProperty#
â–¸ PrivatecreateProperty<T>(reference: ReferenceType, options: PropertyOptions<T> | EntityProperty): { cascade: Cascade[] = [Cascade.PERSIST]; reference: ReferenceType } | { cascade: Cascade[] = [Cascade.PERSIST]; reference: ReferenceType }
Defined in packages/core/src/metadata/EntitySchema.ts:319
Type parameters:#
| Name |
|---|
T |
Parameters:#
| Name | Type |
|---|---|
reference | ReferenceType |
options | PropertyOptions<T> | EntityProperty |
Returns: { cascade: Cascade[] = [Cascade.PERSIST]; reference: ReferenceType } | { cascade: Cascade[] = [Cascade.PERSIST]; reference: ReferenceType }
init#
â–¸ init(): this
Defined in packages/core/src/metadata/EntitySchema.ts:218
internal
Returns: this
initPrimaryKeys#
â–¸ PrivateinitPrimaryKeys(): void
Defined in packages/core/src/metadata/EntitySchema.ts:279
Returns: void
initProperties#
â–¸ PrivateinitProperties(): void
Defined in packages/core/src/metadata/EntitySchema.ts:243
Returns: void
normalizeType#
â–¸ PrivatenormalizeType(options: PropertyOptions<T> | EntityProperty, type?: string | any | Constructor<Type>): any
Defined in packages/core/src/metadata/EntitySchema.ts:299
Parameters:#
| Name | Type |
|---|---|
options | PropertyOptions<T> | EntityProperty |
type? | string | any | Constructor<Type> |
Returns: any
setClass#
â–¸ setClass(proto: Constructor<T>): void
Defined in packages/core/src/metadata/EntitySchema.ts:195
Parameters:#
| Name | Type |
|---|---|
proto | Constructor<T> |
Returns: void
setCustomRepository#
â–¸ setCustomRepository(repository: () => Constructor<EntityRepository<T>>): void
Defined in packages/core/src/metadata/EntitySchema.ts:187
Parameters:#
| Name | Type |
|---|---|
repository | () => Constructor<EntityRepository<T>> |
Returns: void
setExtends#
â–¸ setExtends(base: string): void
Defined in packages/core/src/metadata/EntitySchema.ts:191
Parameters:#
| Name | Type |
|---|---|
base | string |
Returns: void
fromMetadata#
â–¸ StaticfromMetadata<T, U>(meta: EntityMetadata<T> | DeepPartial<EntityMetadata<T>>): EntitySchema<T, U>
Defined in packages/core/src/metadata/EntitySchema.ts:46
Type parameters:#
| Name | Type | Default |
|---|---|---|
T | AnyEntity<T> | AnyEntity |
U | AnyEntity<U> | undefined | undefined |
Parameters:#
| Name | Type |
|---|---|
meta | EntityMetadata<T> | DeepPartial<EntityMetadata<T>> |
Returns: EntitySchema<T, U>