Options
All
  • Public
  • Public/Protected
  • All
Menu

Class EmbeddedMetadata

Contains all information about entity's embedded property.

Hierarchy

  • EmbeddedMetadata

Index

Constructors

constructor

Properties

columns

columns: ColumnMetadata[] = []

Columns inside this embed.

columnsFromTree

columnsFromTree: ColumnMetadata[] = []

Embed metadatas from all levels of the parent tree.

example: post[data][information][counters].id where "data", "information" and "counters" are embeds this method will return [embed metadata of data, embed metadata of information, embed metadata of counters]

customPrefix

customPrefix: string | boolean | undefined

Prefix of the embedded, used instead of propertyName. If set to empty string or false, then prefix is not set at all.

embeddedMetadataTree

embeddedMetadataTree: EmbeddedMetadata[] = []

Returns embed metadatas from all levels of the parent tree.

example: post[data][information][counters].id where "data", "information" and "counters" are embeds this method will return [embed metadata of data, embed metadata of information, embed metadata of counters]

embeddeds

embeddeds: EmbeddedMetadata[] = []

Nested embeddable in this embeddable (which has current embedded as parent embedded).

entityMetadata

entityMetadata: EntityMetadata

Entity metadata where this embedded is.

indices

indices: IndexMetadata[] = []

Indices applied to the embed columns.

indicesFromTree

indicesFromTree: IndexMetadata[] = []

Indices of this embed and all indices from its child embeds.

isArray

isArray: boolean = false

Indicates if this embedded is in array mode.

This option works only in mongodb.

listeners

listeners: EntityListenerMetadata[] = []

Entity listeners inside this embed.

listenersFromTree

listenersFromTree: EntityListenerMetadata[] = []

Relations of this embed and all relations from its child embeds.

Optional parentEmbeddedMetadata

parentEmbeddedMetadata: EmbeddedMetadata

Parent embedded in the case if this embedded inside other embedded.

parentPrefixes

parentPrefixes: string[] = []

Returns array of prefixes of current embed and all its parent embeds.

parentPropertyNames

parentPropertyNames: string[] = []

Returns array of property names of current embed and all its parent embeds.

example: post[data][information][counters].id where "data", "information" and "counters" are embeds we need to get value of "id" column from the post real entity object. this method will return ["data", "information", "counters"]

prefix

prefix: string

Gets the prefix of the columns. By default its a property name of the class where this prefix is. But if custom prefix is set then it takes its value as a prefix. However if custom prefix is set to empty string or false, then prefix to column is not applied at all.

propertyName

propertyName: string

Property name on which this embedded is attached.

propertyPath

propertyPath: string

Gets full path to this embedded property (including embedded property name). Full path is relevant when embedded is used inside other embeds (one or multiple nested). For example it will return "counters.subcounters".

relationCounts

relationCounts: RelationCountMetadata[] = []

Relation counts inside this embed.

relationCountsFromTree

relationCountsFromTree: RelationCountMetadata[] = []

Relation counts of this embed and all relation counts from its child embeds.

relationIds

relationIds: RelationIdMetadata[] = []

Relation ids inside this embed.

relationIdsFromTree

relationIdsFromTree: RelationIdMetadata[] = []

Relation ids of this embed and all relation ids from its child embeds.

relations

relations: RelationMetadata[] = []

Relations inside this embed.

relationsFromTree

relationsFromTree: RelationMetadata[] = []

Relations of this embed and all relations from its child embeds.

type

type: Function

Embedded target type.

uniques

uniques: UniqueMetadata[] = []

Uniques applied to the embed columns.

uniquesFromTree

uniquesFromTree: UniqueMetadata[] = []

Uniques of this embed and all uniques from its child embeds.

Methods

build

Protected buildColumnsFromTree

Protected buildEmbeddedMetadataTree

Protected buildIndicesFromTree

Protected buildListenersFromTree

Protected buildParentPrefixes

  • buildParentPrefixes(): string[]

Protected buildParentPropertyNames

  • buildParentPropertyNames(): string[]

Protected buildPartialPrefix

  • buildPartialPrefix(): string[]

Protected buildPrefix

Protected buildRelationCountsFromTree

Protected buildRelationIdsFromTree

Protected buildRelationsFromTree

Protected buildUniquesFromTree

create

  • create(): any

Generated using TypeDoc