-
-
Notifications
You must be signed in to change notification settings - Fork 6.3k
/
RawSqlResultsToEntityTransformer.ts
372 lines (317 loc) · 18.1 KB
/
RawSqlResultsToEntityTransformer.ts
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
import {Driver} from "../../driver/Driver";
import {RelationIdLoadResult} from "../relation-id/RelationIdLoadResult";
import {ObjectLiteral} from "../../common/ObjectLiteral";
import {ColumnMetadata} from "../../metadata/ColumnMetadata";
import {Alias} from "../Alias";
import {RelationCountLoadResult} from "../relation-count/RelationCountLoadResult";
import {RelationMetadata} from "../../metadata/RelationMetadata";
import {OrmUtils} from "../../util/OrmUtils";
import {QueryExpressionMap} from "../QueryExpressionMap";
import {EntityMetadata} from "../../metadata/EntityMetadata";
import {abbreviate} from "../../util/StringUtils";
import {OracleDriver} from "../../driver/oracle/OracleDriver";
import {QueryRunner} from "../..";
/**
* Transforms raw sql results returned from the database into entity object.
* Entity is constructed based on its entity metadata.
*/
export class RawSqlResultsToEntityTransformer {
// -------------------------------------------------------------------------
// Constructor
// -------------------------------------------------------------------------
constructor(protected expressionMap: QueryExpressionMap,
protected driver: Driver,
protected rawRelationIdResults: RelationIdLoadResult[],
protected rawRelationCountResults: RelationCountLoadResult[],
protected queryRunner?: QueryRunner) {
}
// -------------------------------------------------------------------------
// Public Methods
// -------------------------------------------------------------------------
/**
* Since db returns a duplicated rows of the data where accuracies of the same object can be duplicated
* we need to group our result and we must have some unique id (primary key in our case)
*/
transform(rawResults: any[], alias: Alias): any[] {
const group = this.group(rawResults, alias);
const entities: any[] = [];
group.forEach(results => {
const entity = this.transformRawResultsGroup(results, alias);
if (entity !== undefined)
entities.push(entity);
});
return entities;
}
// -------------------------------------------------------------------------
// Protected Methods
// -------------------------------------------------------------------------
/**
* Groups given raw results by ids of given alias.
*/
protected group(rawResults: any[], alias: Alias): Map<string, any[]> {
const map = new Map();
const keys = alias.metadata.primaryColumns.map(column => this.buildColumnAlias(alias.name, column.databaseName));
rawResults.forEach(rawResult => {
const id = keys.map(key => rawResult[key]).join("_"); // todo: check partial
if (!id) return;
const items = map.get(id);
if (!items) {
map.set(id, [rawResult]);
} else {
items.push(rawResult);
}
});
return map;
}
/**
* Transforms set of data results into single entity.
*/
protected transformRawResultsGroup(rawResults: any[], alias: Alias): ObjectLiteral|undefined {
// let hasColumns = false; // , hasEmbeddedColumns = false, hasParentColumns = false, hasParentEmbeddedColumns = false;
let metadata = alias.metadata;
if (metadata.discriminatorColumn) {
const discriminatorValues = rawResults.map(result => result[this.buildColumnAlias(alias.name, alias.metadata.discriminatorColumn!.databaseName)]);
const discriminatorMetadata = metadata.childEntityMetadatas.find(childEntityMetadata => {
return !!discriminatorValues.find(value => value === childEntityMetadata.discriminatorValue);
});
if (discriminatorMetadata)
metadata = discriminatorMetadata;
}
let entity: any = this.expressionMap.options.indexOf("create-pojo") !== -1 ? {} : metadata.create(this.queryRunner);
// get value from columns selections and put them into newly created entity
const hasColumns = this.transformColumns(rawResults, alias, entity, metadata);
const hasRelations = this.transformJoins(rawResults, entity, alias, metadata);
const hasRelationIds = this.transformRelationIds(rawResults, alias, entity, metadata);
const hasRelationCounts = this.transformRelationCounts(rawResults, alias, entity);
// if we have at least one selected column then return this entity
// since entity must have at least primary columns to be really selected and transformed into entity
if (hasColumns)
return entity;
// if we don't have any selected column we should not return entity,
// except for the case when entity only contain a primary column as a relation to another entity
// in this case its absolutely possible our entity to not have any columns except a single relation
const hasOnlyVirtualPrimaryColumns = metadata.primaryColumns.filter(column => column.isVirtual === false).length === 0; // todo: create metadata.hasOnlyVirtualPrimaryColumns
if (hasOnlyVirtualPrimaryColumns && (hasRelations || hasRelationIds || hasRelationCounts))
return entity;
return undefined;
}
// get value from columns selections and put them into object
protected transformColumns(rawResults: any[], alias: Alias, entity: ObjectLiteral, metadata: EntityMetadata): boolean {
let hasData = false;
metadata.columns.forEach(column => {
// if table inheritance is used make sure this column is not child's column
if (metadata.childEntityMetadatas.length > 0 && metadata.childEntityMetadatas.map(metadata => metadata.target).indexOf(column.target) !== -1)
return;
const value = rawResults[0][this.buildColumnAlias(alias.name, column.databaseName)];
if (value === undefined || column.isVirtual)
return;
// if user does not selected the whole entity or he used partial selection and does not select this particular column
// then we don't add this column and its value into the entity
if (!this.expressionMap.selects.find(select => select.selection === alias.name || select.selection === alias.name + "." + column.propertyPath))
return;
column.setEntityValue(entity, this.driver.prepareHydratedValue(value, column));
if (value !== null) // we don't mark it as has data because if we will have all nulls in our object - we don't need such object
hasData = true;
});
return hasData;
}
/**
* Transforms joined entities in the given raw results by a given alias and stores to the given (parent) entity
*/
protected transformJoins(rawResults: any[], entity: ObjectLiteral, alias: Alias, metadata: EntityMetadata) {
let hasData = false;
// let discriminatorValue: string = "";
// if (metadata.discriminatorColumn)
// discriminatorValue = rawResults[0][this.buildColumnAlias(alias.name, alias.metadata.discriminatorColumn!.databaseName)];
this.expressionMap.joinAttributes.forEach(join => { // todo: we have problem here - when inner joins are used without selects it still create empty array
// skip joins without metadata
if (!join.metadata)
return;
// if simple left or inner join was performed without selection then we don't need to do anything
if (!join.isSelected)
return;
// this check need to avoid setting properties than not belong to entity when single table inheritance used. (todo: check if we still need it)
// const metadata = metadata.childEntityMetadatas.find(childEntityMetadata => discriminatorValue === childEntityMetadata.discriminatorValue);
if (join.relation && !metadata.relations.find(relation => relation === join.relation))
return;
// some checks to make sure this join is for current alias
if (join.mapToProperty) {
if (join.mapToPropertyParentAlias !== alias.name)
return;
} else {
if (!join.relation || join.parentAlias !== alias.name || join.relationPropertyPath !== join.relation!.propertyPath)
return;
}
// transform joined data into entities
let result: any = this.transform(rawResults, join.alias);
result = !join.isMany ? result[0] : result;
result = !join.isMany && result === undefined ? null : result; // this is needed to make relations to return null when its joined but nothing was found in the database
if (result === undefined) // if nothing was joined then simply return
return;
// if join was mapped to some property then save result to that property
if (join.mapToPropertyPropertyName) {
entity[join.mapToPropertyPropertyName] = result; // todo: fix embeds
} else { // otherwise set to relation
join.relation!.setEntityValue(entity, result);
}
hasData = true;
});
return hasData;
}
protected transformRelationIds(rawSqlResults: any[], alias: Alias, entity: ObjectLiteral, metadata: EntityMetadata): boolean {
let hasData = false;
this.rawRelationIdResults.forEach(rawRelationIdResult => {
if (rawRelationIdResult.relationIdAttribute.parentAlias !== alias.name)
return;
const relation = rawRelationIdResult.relationIdAttribute.relation;
const valueMap = this.createValueMapFromJoinColumns(relation, rawRelationIdResult.relationIdAttribute.parentAlias, rawSqlResults);
if (valueMap === undefined || valueMap === null)
return;
const idMaps = rawRelationIdResult.results.map(result => {
const entityPrimaryIds = this.extractEntityPrimaryIds(relation, result);
if (EntityMetadata.compareIds(entityPrimaryIds, valueMap) === false)
return;
let columns: ColumnMetadata[];
if (relation.isManyToOne || relation.isOneToOneOwner) {
columns = relation.joinColumns.map(joinColumn => joinColumn);
} else if (relation.isOneToMany || relation.isOneToOneNotOwner) {
columns = relation.inverseEntityMetadata.primaryColumns.map(joinColumn => joinColumn);
// columns = relation.inverseRelation!.joinColumns.map(joinColumn => joinColumn.referencedColumn!); //.inverseEntityMetadata.primaryColumns.map(joinColumn => joinColumn);
} else { // ManyToMany
if (relation.isOwning) {
columns = relation.inverseJoinColumns.map(joinColumn => joinColumn);
} else {
columns = relation.inverseRelation!.joinColumns.map(joinColumn => joinColumn);
}
}
const idMap = columns.reduce((idMap, column) => {
let value = result[column.databaseName];
if (relation.isOneToMany || relation.isOneToOneNotOwner) {
if (column.referencedColumn) // if column is a relation
value = column.referencedColumn.createValueMap(value);
return OrmUtils.mergeDeep(idMap, column.createValueMap(value));
} else {
if (column.referencedColumn!.referencedColumn) // if column is a relation
value = column.referencedColumn!.referencedColumn!.createValueMap(value);
return OrmUtils.mergeDeep(idMap, column.referencedColumn!.createValueMap(value));
}
}, {} as ObjectLiteral);
if (columns.length === 1 && rawRelationIdResult.relationIdAttribute.disableMixedMap === false) {
if (relation.isOneToMany || relation.isOneToOneNotOwner) {
return columns[0].getEntityValue(idMap);
} else {
return columns[0].referencedColumn!.getEntityValue(idMap);
}
}
return idMap;
}).filter(result => result);
const properties = rawRelationIdResult.relationIdAttribute.mapToPropertyPropertyPath.split(".");
const mapToProperty = (properties: string[], map: ObjectLiteral, value: any): any => {
const property = properties.shift();
if (property && properties.length === 0) {
map[property] = value;
return map;
} else if (property && properties.length > 0) {
mapToProperty(properties, map[property], value);
} else {
return map;
}
};
if (relation.isOneToOne || relation.isManyToOne) {
if (idMaps[0] !== undefined) {
mapToProperty(properties, entity, idMaps[0]);
hasData = true;
}
} else {
mapToProperty(properties, entity, idMaps);
if (idMaps.length > 0) {
hasData = true;
}
}
});
return hasData;
}
protected transformRelationCounts(rawSqlResults: any[], alias: Alias, entity: ObjectLiteral): boolean {
let hasData = false;
this.rawRelationCountResults
.filter(rawRelationCountResult => rawRelationCountResult.relationCountAttribute.parentAlias === alias.name)
.forEach(rawRelationCountResult => {
const relation = rawRelationCountResult.relationCountAttribute.relation;
let referenceColumnName: string;
if (relation.isOneToMany) {
referenceColumnName = relation.inverseRelation!.joinColumns[0].referencedColumn!.databaseName; // todo: fix joinColumns[0]
} else {
referenceColumnName = relation.isOwning ? relation.joinColumns[0].referencedColumn!.databaseName : relation.inverseRelation!.joinColumns[0].referencedColumn!.databaseName;
}
const referenceColumnValue = rawSqlResults[0][this.buildColumnAlias(alias.name, referenceColumnName)]; // we use zero index since its grouped data // todo: selection with alias for entity columns wont work
if (referenceColumnValue !== undefined && referenceColumnValue !== null) {
entity[rawRelationCountResult.relationCountAttribute.mapToPropertyPropertyName] = 0;
rawRelationCountResult.results
.filter(result => result["parentId"] === referenceColumnValue)
.forEach(result => {
entity[rawRelationCountResult.relationCountAttribute.mapToPropertyPropertyName] = parseInt(result["cnt"]);
hasData = true;
});
}
});
return hasData;
}
/**
* Builds column alias from given alias name and column name,
* If alias length is more than 29, abbreviates column name.
*/
protected buildColumnAlias(aliasName: string, columnName: string): string {
const columnAliasName = aliasName + "_" + columnName;
if (columnAliasName.length > 29 && this.driver instanceof OracleDriver)
return aliasName + "_" + abbreviate(columnName, 2);
return columnAliasName;
}
private createValueMapFromJoinColumns(relation: RelationMetadata, parentAlias: string, rawSqlResults: any[]): ObjectLiteral {
let columns: ColumnMetadata[];
if (relation.isManyToOne || relation.isOneToOneOwner) {
columns = relation.entityMetadata.primaryColumns.map(joinColumn => joinColumn);
} else if (relation.isOneToMany || relation.isOneToOneNotOwner) {
columns = relation.inverseRelation!.joinColumns.map(joinColumn => joinColumn);
} else {
if (relation.isOwning) {
columns = relation.joinColumns.map(joinColumn => joinColumn);
} else {
columns = relation.inverseRelation!.inverseJoinColumns.map(joinColumn => joinColumn);
}
}
return columns.reduce((valueMap, column) => {
rawSqlResults.forEach(rawSqlResult => {
if (relation.isManyToOne || relation.isOneToOneOwner) {
valueMap[column.databaseName] = rawSqlResult[this.buildColumnAlias(parentAlias, column.databaseName)];
} else {
valueMap[column.databaseName] = rawSqlResult[this.buildColumnAlias(parentAlias, column.referencedColumn!.databaseName)];
}
});
return valueMap;
}, {} as ObjectLiteral);
}
private extractEntityPrimaryIds(relation: RelationMetadata, relationIdRawResult: any) {
let columns: ColumnMetadata[];
if (relation.isManyToOne || relation.isOneToOneOwner) {
columns = relation.entityMetadata.primaryColumns.map(joinColumn => joinColumn);
} else if (relation.isOneToMany || relation.isOneToOneNotOwner) {
columns = relation.inverseRelation!.joinColumns.map(joinColumn => joinColumn);
} else {
if (relation.isOwning) {
columns = relation.joinColumns.map(joinColumn => joinColumn);
} else {
columns = relation.inverseRelation!.inverseJoinColumns.map(joinColumn => joinColumn);
}
}
return columns.reduce((data, column) => {
data[column.databaseName] = relationIdRawResult[column.databaseName];
return data;
}, {} as ObjectLiteral);
}
/*private removeVirtualColumns(entity: ObjectLiteral, alias: Alias) {
const virtualColumns = this.expressionMap.selects
.filter(select => select.virtual)
.map(select => select.selection.replace(alias.name + ".", ""));
virtualColumns.forEach(virtualColumn => delete entity[virtualColumn]);
}*/
}