@mikro-orm/knex 6.0.0-dev.1 → 6.0.0-dev.100

package/{dist/query → query}/QueryBuilderHelper.js

@@ -8,16 +8,32 @@ const enums_1 = require("./enums");
  * @internal
  */
 class QueryBuilderHelper {
-    constructor(entityName, alias, aliasMap, subQueries, metadata, knex, platform) {
+    entityName;
+    alias;
+    aliasMap;
+    subQueries;
+    knex;
+    driver;
+    platform;
+    metadata;
+    constructor(entityName, alias, aliasMap, subQueries, knex, driver) {
         this.entityName = entityName;
         this.alias = alias;
         this.aliasMap = aliasMap;
         this.subQueries = subQueries;
-        this.metadata = metadata;
         this.knex = knex;
-        this.platform = platform;
+        this.driver = driver;
+        this.platform = this.driver.getPlatform();
+        this.metadata = this.driver.getMetadata();
     }
     mapper(field, type = enums_1.QueryType.SELECT, value, alias) {
+        if (core_1.Utils.isRawSql(field)) {
+            return this.knex.raw(field.sql, field.params);
+        }
+        /* istanbul ignore next */
+        if (typeof field !== 'string') {
+            return field;
+        }
         const isTableNameAliasRequired = this.isTableNameAliasRequired(type);
         const fields = core_1.Utils.splitPrimaryKeys(field);
         if (fields.length > 1) {
@@ -26,18 +42,36 @@ class QueryBuilderHelper {
                 const [a, f] = this.splitField(p);
                 const prop = this.getProperty(f, a);
                 if (prop) {
-                    parts.push(...prop.fieldNames.map(f => this.mapper(f, type, value, alias)));
+                    parts.push(...prop.fieldNames.map(f => this.mapper(a !== this.alias ? `${a}.${f}` : f, type, value, alias)));
                 }
                 else {
-                    parts.push(this.mapper(`${a}.${f}`, type, value, alias));
+                    parts.push(this.mapper(a !== this.alias ? `${a}.${f}` : f, type, value, alias));
                 }
             }
+            // flatten the value if we see we are expanding nested composite key
+            // hackish, but cleaner solution would require quite a lot of refactoring
+            if (fields.length !== parts.length && Array.isArray(value)) {
+                value.forEach(row => {
+                    if (Array.isArray(row)) {
+                        const tmp = core_1.Utils.flatten(row);
+                        row.length = 0;
+                        row.push(...tmp);
+                    }
+                });
+            }
             return this.knex.raw('(' + parts.map(part => this.knex.ref(part)).join(', ') + ')');
         }
-        let ret = field;
-        const customExpression = QueryBuilderHelper.isCustomExpression(field, !!alias);
+        const rawField = core_1.RawQueryFragment.getKnownFragment(field);
+        if (rawField) {
+            return this.knex.raw(rawField.sql, rawField.params);
+        }
         const [a, f] = this.splitField(field);
         const prop = this.getProperty(f, a);
+        let ret = field;
+        // embeddable nested path instead of a regular property with table alias, reset alias
+        if (prop?.name === a && prop.embeddedProps[f]) {
+            return this.alias + '.' + prop.fieldNames[0];
+        }
         const noPrefix = prop && prop.persist === false;
         if (prop?.fieldNameRaw) {
             return this.knex.raw(this.prefix(field, isTableNameAliasRequired));
@@ -48,7 +82,7 @@ class QueryBuilderHelper {
             const as = alias === null ? '' : ` as ${aliased}`;
             return this.knex.raw(`${prop.formula(alias2)}${as}`);
         }
-        if (prop?.customType?.convertToJSValueSQL) {
+        if (prop?.hasConvertToJSValueSQL) {
             const prefixed = this.prefix(field, isTableNameAliasRequired, true);
             const valueSQL = prop.customType.convertToJSValueSQL(prefixed, this.platform);
             if (alias === null) {
@@ -57,15 +91,12 @@ class QueryBuilderHelper {
             return this.knex.raw(`${valueSQL} as ${this.platform.quoteIdentifier(alias ?? prop.fieldNames[0])}`);
         }
         // do not wrap custom expressions
-        if (!customExpression) {
+        if (!rawField) {
             ret = this.prefix(field);
         }
         if (alias) {
             ret += ' as ' + alias;
         }
-        if (customExpression) {
-            return this.knex.raw(ret, value);
-        }
         if (!isTableNameAliasRequired || this.isPrefixed(ret) || noPrefix) {
             return ret;
         }
@@ -75,111 +106,153 @@ class QueryBuilderHelper {
         if (Array.isArray(data)) {
             return data.map(d => this.processData(d, convertCustomTypes, true));
         }
-        data = Object.assign({}, data); // copy first
         const meta = this.metadata.find(this.entityName);
-        Object.keys(data).forEach(k => {
-            if (!meta?.properties[k]) {
-                return;
-            }
-            const prop = meta.properties[k];
-            if (prop.joinColumns && Array.isArray(data[k])) {
-                const copy = data[k];
-                delete data[k];
-                prop.joinColumns.forEach((joinColumn, idx) => data[joinColumn] = copy[idx]);
-                return;
-            }
-            if (prop.customType && convertCustomTypes && !this.platform.isRaw(data[k])) {
-                data[k] = prop.customType.convertToDatabaseValue(data[k], this.platform, true);
-            }
-            if (prop.customType && 'convertToDatabaseValueSQL' in prop.customType && !this.platform.isRaw(data[k])) {
-                const quoted = this.platform.quoteValue(data[k]);
-                data[k] = this.knex.raw(prop.customType.convertToDatabaseValueSQL(quoted, this.platform));
-            }
-            if (!prop.customType && (Array.isArray(data[k]) || core_1.Utils.isPlainObject(data[k]))) {
-                data[k] = JSON.stringify(data[k]);
-            }
-            if (prop.fieldNames) {
-                core_1.Utils.renameKey(data, k, prop.fieldNames[0]);
-            }
-        });
+        data = this.mapData(data, meta?.properties, convertCustomTypes);
         if (!core_1.Utils.hasObjectKeys(data) && meta && multi) {
+            /* istanbul ignore next */
             data[meta.primaryKeys[0]] = this.platform.usesDefaultKeyword() ? this.knex.raw('default') : undefined;
         }
         return data;
     }
-    joinOneToReference(prop, ownerAlias, alias, type, cond = {}) {
-        const meta = this.metadata.find(prop.type);
-        const prop2 = meta.properties[prop.mappedBy || prop.inversedBy];
+    joinOneToReference(prop, ownerAlias, alias, type, cond = {}, schema) {
+        const prop2 = prop.targetMeta.properties[prop.mappedBy || prop.inversedBy];
         const table = this.getTableName(prop.type);
         const joinColumns = prop.owner ? prop.referencedColumnNames : prop2.joinColumns;
         const inverseJoinColumns = prop.referencedColumnNames;
         const primaryKeys = prop.owner ? prop.joinColumns : prop2.referencedColumnNames;
+        schema ??= prop.targetMeta?.schema === '*' ? '*' : this.driver.getSchemaName(prop.targetMeta);
         return {
-            prop, type, cond, ownerAlias, alias, table,
+            prop, type, cond, ownerAlias, alias, table, schema,
             joinColumns, inverseJoinColumns, primaryKeys,
         };
     }
-    joinManyToOneReference(prop, ownerAlias, alias, type, cond = {}) {
+    joinManyToOneReference(prop, ownerAlias, alias, type, cond = {}, schema) {
         return {
             prop, type, cond, ownerAlias, alias,
             table: this.getTableName(prop.type),
+            schema: this.driver.getSchemaName(prop.targetMeta, { schema }),
             joinColumns: prop.referencedColumnNames,
             primaryKeys: prop.fieldNames,
         };
     }
-    joinManyToManyReference(prop, ownerAlias, alias, pivotAlias, type, cond, path) {
+    joinManyToManyReference(prop, ownerAlias, alias, pivotAlias, type, cond, path, schema) {
+        const pivotMeta = this.metadata.find(prop.pivotEntity);
         const ret = {
             [`${ownerAlias}.${prop.name}#${pivotAlias}`]: {
-                prop, type, cond, ownerAlias,
+                prop, type, ownerAlias,
                 alias: pivotAlias,
                 inverseAlias: alias,
                 joinColumns: prop.joinColumns,
                 inverseJoinColumns: prop.inverseJoinColumns,
                 primaryKeys: prop.referencedColumnNames,
-                table: prop.pivotTable,
+                cond: {},
+                table: pivotMeta.tableName,
+                schema: this.driver.getSchemaName(pivotMeta, { schema }),
                 path: path.endsWith('[pivot]') ? path : `${path}[pivot]`,
             },
         };
         if (type === 'pivotJoin') {
             return ret;
         }
-        const prop2 = this.metadata.find(prop.pivotTable).properties[prop.type + (prop.owner ? '_inverse' : '_owner')];
-        ret[`${pivotAlias}.${prop2.name}#${alias}`] = this.joinManyToOneReference(prop2, pivotAlias, alias, type);
+        const prop2 = prop.owner ? pivotMeta.relations[1] : pivotMeta.relations[0];
+        ret[`${pivotAlias}.${prop2.name}#${alias}`] = this.joinManyToOneReference(prop2, pivotAlias, alias, type, cond, schema);
         ret[`${pivotAlias}.${prop2.name}#${alias}`].path = path;
         return ret;
     }
-    joinPivotTable(field, prop, ownerAlias, alias, type, cond = {}) {
-        const pivotMeta = this.metadata.find(field);
-        const prop2 = pivotMeta.properties[prop.mappedBy || prop.inversedBy];
-        return {
-            prop, type, cond, ownerAlias, alias,
-            table: pivotMeta.collection,
-            schema: pivotMeta.schema,
-            joinColumns: prop.joinColumns,
-            inverseJoinColumns: prop2.joinColumns,
-            primaryKeys: prop.referencedColumnNames,
-        };
-    }
     processJoins(qb, joins, schema) {
         Object.values(joins).forEach(join => {
             let table = `${join.table} as ${join.alias}`;
-            const method = join.type === 'pivotJoin' ? 'leftJoin' : join.type;
+            const method = join.type === 'innerJoin' ? 'inner join' : 'left join';
             schema = join.schema && join.schema !== '*' ? join.schema : schema;
             if (schema) {
                 table = `${schema}.${table}`;
             }
-            return qb[method](this.knex.ref(table), inner => {
-                join.primaryKeys.forEach((primaryKey, idx) => {
-                    const left = `${join.ownerAlias}.${primaryKey}`;
-                    const right = `${join.alias}.${join.joinColumns[idx]}`;
-                    inner.on(left, right);
-                });
-                this.appendJoinClause(inner, join.cond);
+            const conditions = [];
+            const params = [];
+            join.primaryKeys.forEach((primaryKey, idx) => {
+                const left = `${join.ownerAlias}.${primaryKey}`;
+                const right = `${join.alias}.${join.joinColumns[idx]}`;
+                conditions.push(`${this.knex.ref(left)} = ${this.knex.ref(right)}`);
             });
+            if (join.prop.targetMeta.discriminatorValue && !join.path?.endsWith('[pivot]')) {
+                const typeProperty = join.prop.targetMeta.root.discriminatorColumn;
+                const alias = join.inverseAlias ?? join.alias;
+                join.cond[`${alias}.${typeProperty}`] = join.prop.targetMeta.discriminatorValue;
+            }
+            Object.keys(join.cond).forEach(key => {
+                conditions.push(this.processJoinClause(key, join.cond[key], params));
+            });
+            return qb.joinRaw(`${method} ${this.knex.ref(table)} on ${conditions.join(' and ')}`, params);
         });
     }
+    processJoinClause(key, value, params, operator = '$eq') {
+        if (core_1.Utils.isGroupOperator(key) && Array.isArray(value)) {
+            const parts = value.map(sub => {
+                return this.wrapQueryGroup(Object.keys(sub).map(k => this.processJoinClause(k, sub[k], params)));
+            });
+            return this.wrapQueryGroup(parts, key);
+        }
+        if (this.isSimpleRegExp(value)) {
+            params.push(this.getRegExpParam(value));
+            return `${this.knex.ref(this.mapper(key))} like ?`;
+        }
+        if (value instanceof RegExp) {
+            value = this.platform.getRegExpValue(value);
+        }
+        if (core_1.Utils.isOperator(key, false) && core_1.Utils.isPlainObject(value)) {
+            const parts = Object.keys(value).map(k => this.processJoinClause(k, value[k], params, key));
+            return key === '$not' ? `not ${this.wrapQueryGroup(parts)}` : this.wrapQueryGroup(parts);
+        }
+        if (core_1.Utils.isPlainObject(value) && Object.keys(value).every(k => core_1.Utils.isOperator(k, false))) {
+            const parts = Object.keys(value).map(op => this.processJoinClause(key, value[op], params, op));
+            return this.wrapQueryGroup(parts);
+        }
+        operator = operator === '$not' ? '$eq' : operator;
+        if (value === null) {
+            return `${this.knex.ref(this.mapper(key))} is ${operator === '$ne' ? 'not ' : ''}null`;
+        }
+        if (operator === '$fulltext') {
+            const [fromAlias, fromField] = this.splitField(key);
+            const property = this.getProperty(fromField, fromAlias);
+            const query = this.knex.raw(this.platform.getFullTextWhereClause(property), {
+                column: this.mapper(key),
+                query: this.knex.raw('?'),
+            }).toSQL().toNative();
+            params.push(value);
+            return query.sql;
+        }
+        const replacement = this.getOperatorReplacement(operator, { [operator]: value });
+        if (['$in', '$nin'].includes(operator) && Array.isArray(value)) {
+            params.push(...value);
+            return `${this.knex.ref(this.mapper(key))} ${replacement} (${value.map(() => '?').join(', ')})`;
+        }
+        if (operator === '$exists') {
+            value = null;
+        }
+        const rawField = core_1.RawQueryFragment.getKnownFragment(key);
+        if (rawField) {
+            let sql = rawField.sql;
+            params.push(...rawField.params);
+            params.push(...core_1.Utils.asArray(value));
+            if (core_1.Utils.asArray(value).length > 0) {
+                sql += ' = ?';
+            }
+            return sql;
+        }
+        const sql = this.mapper(key);
+        if (value !== null) {
+            params.push(value);
+        }
+        return `${this.knex.ref(sql)} ${replacement} ${value === null ? 'null' : '?'}`;
+    }
+    wrapQueryGroup(parts, operator = '$and') {
+        if (parts.length === 1) {
+            return parts[0];
+        }
+        return `(${parts.join(` ${core_1.GroupOperator[operator]} `)})`;
+    }
     mapJoinColumns(type, join) {
-        if (join.prop && join.prop.reference === core_1.ReferenceType.ONE_TO_ONE && !join.prop.owner) {
+        if (join.prop && join.prop.kind === core_1.ReferenceKind.ONE_TO_ONE && !join.prop.owner) {
             return join.prop.fieldNames.map((fieldName, idx) => {
                 return this.mapper(`${join.alias}.${join.inverseJoinColumns[idx]}`, type, undefined, fieldName);
             });
@@ -192,7 +265,7 @@ class QueryBuilderHelper {
     isOneToOneInverse(field) {
         const meta = this.metadata.find(this.entityName);
         const prop = meta.properties[field];
-        return prop && prop.reference === core_1.ReferenceType.ONE_TO_ONE && !prop.owner;
+        return prop && prop.kind === core_1.ReferenceKind.ONE_TO_ONE && !prop.owner;
     }
     getTableName(entityName) {
         const meta = this.metadata.find(entityName);
@@ -205,6 +278,9 @@ class QueryBuilderHelper {
         if (!(re instanceof RegExp)) {
             return false;
         }
+        if (re.flags.includes('i')) {
+            return false;
+        }
         // when including the opening bracket/paren we consider it complex
         return !re.source.match(/[{[(]/);
     }
@@ -228,13 +304,13 @@ class QueryBuilderHelper {
     }
     appendOnConflictClause(type, onConflict, qb) {
         onConflict.forEach(item => {
-            const sub = qb.onConflict(item.fields);
+            const sub = item.fields.length > 0 ? qb.onConflict(item.fields) : qb.onConflict();
             core_1.Utils.runIfNotEmpty(() => sub.ignore(), item.ignore);
             core_1.Utils.runIfNotEmpty(() => {
                 let mergeParam = item.merge;
                 if (core_1.Utils.isObject(item.merge)) {
                     mergeParam = {};
-                    Object.keys(item.merge).forEach(key => {
+                    core_1.Utils.keys(item.merge).forEach(key => {
                         const k = this.mapper(key, type);
                         mergeParam[k] = item.merge[key];
                     });
@@ -265,34 +341,29 @@ class QueryBuilderHelper {
     }
     appendQuerySubCondition(qb, type, method, cond, key, operator) {
         const m = operator === '$or' ? 'orWhere' : method;
+        if (cond[key] instanceof core_1.RawQueryFragment) {
+            cond[key] = this.knex.raw(cond[key].sql, cond[key].params);
+        }
         if (this.isSimpleRegExp(cond[key])) {
             return void qb[m](this.mapper(key, type), 'like', this.getRegExpParam(cond[key]));
         }
         if (core_1.Utils.isPlainObject(cond[key]) || cond[key] instanceof RegExp) {
             return this.processObjectSubCondition(cond, key, qb, method, m, type);
         }
-        if (QueryBuilderHelper.isCustomExpression(key)) {
-            return this.processCustomExpression(qb, m, key, cond, type);
-        }
         const op = cond[key] === null ? 'is' : '=';
+        const raw = core_1.RawQueryFragment.getKnownFragment(key);
+        if (raw) {
+            const value = core_1.Utils.asArray(cond[key]);
+            if (value.length > 0) {
+                return void qb[m](this.knex.raw(raw.sql, raw.params), op, value[0]);
+            }
+            return void qb[m](this.knex.raw(raw.sql, raw.params));
+        }
         if (this.subQueries[key]) {
             return void qb[m](this.knex.raw(`(${this.subQueries[key]})`), op, cond[key]);
         }
         qb[m](this.mapper(key, type, cond[key], null), op, cond[key]);
     }
-    processCustomExpression(clause, m, key, cond, type = enums_1.QueryType.SELECT) {
-        // unwind parameters when ? found in field name
-        const count = key.concat('?').match(/\?/g).length - 1;
-        const value = core_1.Utils.asArray(cond[key]);
-        const params1 = value.slice(0, count).map((c) => core_1.Utils.isObject(c) ? JSON.stringify(c) : c);
-        const params2 = value.slice(count);
-        const k = this.mapper(key, type, params1);
-        if (params2.length > 0) {
-            const val = params2.length === 1 && params2[0] === null ? null : this.knex.raw('?', params2);
-            return void clause[m](k, val);
-        }
-        clause[m](k);
-    }
     processObjectSubCondition(cond, key, qb, method, m, type) {
         // grouped condition for one field
         let value = cond[key];
@@ -301,7 +372,7 @@ class QueryBuilderHelper {
             return subCondition.forEach(sub => this.appendQueryCondition(type, sub, qb, '$and', method));
         }
         if (value instanceof RegExp) {
-            value = { $re: value.source };
+            value = this.platform.getRegExpValue(value);
         }
         // operators
         const op = Object.keys(core_1.QueryOperator).find(op => op in value);
@@ -311,68 +382,43 @@ class QueryBuilderHelper {
         const replacement = this.getOperatorReplacement(op, value);
         const fields = core_1.Utils.splitPrimaryKeys(key);
         if (fields.length > 1 && Array.isArray(value[op]) && !value[op].every((v) => Array.isArray(v))) {
-            const values = this.platform.requiresValuesKeyword() ? 'values ' : '';
-            value[op] = this.knex.raw(`${values}(${fields.map(() => '?').join(', ')})`, value[op]);
+            const tmp = value[op].length === 1 && core_1.Utils.isPlainObject(value[op][0]) ? fields.map(f => value[op][0][f]) : value[op];
+            value[op] = this.knex.raw(`(${fields.map(() => '?').join(', ')})`, tmp);
         }
         if (this.subQueries[key]) {
             return void qb[m](this.knex.raw(`(${this.subQueries[key]})`), replacement, value[op]);
         }
-        qb[m](this.mapper(key, type, undefined, null), replacement, value[op]);
+        if (op === '$fulltext') {
+            const [a, f] = this.splitField(key);
+            const prop = this.getProperty(f, a);
+            /* istanbul ignore next */
+            if (!prop) {
+                throw new Error(`Cannot use $fulltext operator on ${key}, property not found`);
+            }
+            qb[m](this.knex.raw(this.platform.getFullTextWhereClause(prop), {
+                column: this.mapper(key, type, undefined, null),
+                query: value[op],
+            }));
+        }
+        else {
+            const mappedKey = this.mapper(key, type, value[op], null);
+            qb[m](mappedKey, replacement, value[op]);
+        }
     }
     getOperatorReplacement(op, value) {
         let replacement = core_1.QueryOperator[op];
+        if (op === '$exists') {
+            replacement = value[op] ? 'is not' : 'is';
+            value[op] = null;
+        }
         if (value[op] === null && ['$eq', '$ne'].includes(op)) {
             replacement = op === '$eq' ? 'is' : 'is not';
         }
         if (op === '$re') {
-            replacement = this.platform.getRegExpOperator();
+            replacement = this.platform.getRegExpOperator(value[op], value.$flags);
         }
         return replacement;
     }
-    appendJoinClause(clause, cond, operator) {
-        Object.keys(cond).forEach(k => {
-            if (k === '$and' || k === '$or') {
-                const method = operator === '$or' ? 'orOn' : 'andOn';
-                const m = k === '$or' ? 'orOn' : 'andOn';
-                return clause[method](outer => cond[k].forEach((sub) => {
-                    if (core_1.Utils.getObjectKeysSize(sub) === 1) {
-                        return this.appendJoinClause(outer, sub, k);
-                    }
-                    outer[m](inner => this.appendJoinClause(inner, sub, '$and'));
-                }));
-            }
-            this.appendJoinSubClause(clause, cond, k, operator);
-        });
-    }
-    appendJoinSubClause(clause, cond, key, operator) {
-        const m = operator === '$or' ? 'orOn' : 'andOn';
-        if (cond[key] instanceof RegExp) {
-            return void clause[m](this.mapper(key), 'like', this.knex.raw('?', this.getRegExpParam(cond[key])));
-        }
-        if (core_1.Utils.isPlainObject(cond[key])) {
-            return this.processObjectSubClause(cond, key, clause, m);
-        }
-        if (QueryBuilderHelper.isCustomExpression(key)) {
-            return this.processCustomExpression(clause, m, key, cond);
-        }
-        const op = cond[key] === null ? 'is' : '=';
-        clause[m](this.knex.raw(`${this.knex.ref(this.mapper(key, enums_1.QueryType.SELECT, cond[key]))} ${op} ?`, cond[key]));
-    }
-    processObjectSubClause(cond, key, clause, m) {
-        // grouped condition for one field
-        if (core_1.Utils.getObjectKeysSize(cond[key]) > 1) {
-            const subCondition = Object.entries(cond[key]).map(([subKey, subValue]) => ({ [key]: { [subKey]: subValue } }));
-            return void clause[m](inner => subCondition.map(sub => this.appendJoinClause(inner, sub, '$and')));
-        }
-        // operators
-        for (const [op, replacement] of Object.entries(core_1.QueryOperator)) {
-            if (!(op in cond[key])) {
-                continue;
-            }
-            clause[m](this.mapper(key), replacement, this.knex.raw('?', cond[key][op]));
-            break;
-        }
-    }
     getQueryOrder(type, orderBy, populate) {
         if (Array.isArray(orderBy)) {
             return orderBy
@@ -384,42 +430,72 @@ class QueryBuilderHelper {
     }
     getQueryOrderFromObject(type, orderBy, populate) {
         const ret = [];
-        Object.keys(orderBy).forEach(k => {
-            const direction = orderBy[k];
+        Object.keys(orderBy).forEach(key => {
+            const direction = orderBy[key];
             const order = core_1.Utils.isNumber(direction) ? core_1.QueryOrderNumeric[direction] : direction;
-            if (QueryBuilderHelper.isCustomExpression(k)) {
-                ret.push(`${k} ${order.toLowerCase()}`);
+            const raw = core_1.RawQueryFragment.getKnownFragment(key);
+            if (raw) {
+                ret.push(`${this.platform.formatQuery(raw.sql, raw.params)} ${order.toLowerCase()}`);
                 return;
             }
-            // eslint-disable-next-line prefer-const
-            let [alias, field] = this.splitField(k);
-            alias = populate[alias] || alias;
-            core_1.Utils.splitPrimaryKeys(field).forEach(f => {
-                const prop = this.getProperty(f, alias);
-                const noPrefix = (prop && prop.persist === false) || QueryBuilderHelper.isCustomExpression(f);
-                const column = this.mapper(noPrefix ? f : `${alias}.${f}`, type);
+            core_1.Utils.splitPrimaryKeys(key).forEach(f => {
+                // eslint-disable-next-line prefer-const
+                let [alias, field] = this.splitField(f, true);
+                alias = populate[alias] || alias;
+                const prop = this.getProperty(field, alias);
+                const noPrefix = (prop && prop.persist === false && !prop.formula) || core_1.RawQueryFragment.isKnownFragment(f);
+                const column = this.mapper(noPrefix ? field : `${alias}.${field}`, type, undefined, null);
                 /* istanbul ignore next */
                 const rawColumn = core_1.Utils.isString(column) ? column.split('.').map(e => this.knex.ref(e)).join('.') : column;
                 const customOrder = prop?.customOrder;
-                const colPart = customOrder
+                let colPart = customOrder
                     ? this.platform.generateCustomOrder(rawColumn, customOrder)
                     : rawColumn;
+                if (core_1.Utils.isRawSql(colPart)) {
+                    colPart = this.platform.formatQuery(colPart.sql, colPart.params);
+                }
                 ret.push(`${colPart} ${order.toLowerCase()}`);
             });
         });
         return ret.join(', ');
     }
-    finalize(type, qb, meta) {
-        const useReturningStatement = type === enums_1.QueryType.INSERT && this.platform.usesReturningStatement() && meta && !meta.compositePK;
-        if (useReturningStatement) {
-            const returningProps = meta.props.filter(prop => prop.primary || prop.defaultRaw);
-            qb.returning(core_1.Utils.flatten(returningProps.map(prop => prop.fieldNames)));
+    finalize(type, qb, meta, data, returning) {
+        if (!meta || !data || !this.platform.usesReturningStatement()) {
+            return;
+        }
+        // always respect explicit returning hint
+        if (returning && returning.length > 0) {
+            qb.returning(returning.map(field => this.mapper(field, type)));
+            return;
+        }
+        if (type === enums_1.QueryType.INSERT) {
+            const returningProps = meta.hydrateProps
+                .filter(prop => prop.returning || (prop.persist !== false && ((prop.primary && prop.autoincrement) || prop.defaultRaw)))
+                .filter(prop => !(prop.name in data));
+            if (returningProps.length > 0) {
+                qb.returning(core_1.Utils.flatten(returningProps.map(prop => prop.fieldNames)));
+            }
+            return;
+        }
+        if (type === enums_1.QueryType.UPDATE) {
+            const returningProps = meta.hydrateProps.filter(prop => core_1.Utils.isRawSql(data[prop.name]));
+            if (returningProps.length > 0) {
+                qb.returning(core_1.Utils.flatten(returningProps.map(prop => prop.fieldNames)));
+            }
         }
     }
-    splitField(field) {
+    splitField(field, greedyAlias = false) {
         const parts = field.split('.');
-        const fromField = parts.pop();
-        const fromAlias = parts.length > 0 ? parts.join('.') : this.alias;
+        if (parts.length === 1) {
+            return [this.alias, parts[0]];
+        }
+        if (greedyAlias) {
+            const fromField = parts.pop();
+            const fromAlias = parts.join('.');
+            return [fromAlias, fromField];
+        }
+        const fromAlias = parts.shift();
+        const fromField = parts.join('.');
         return [fromAlias, fromField];
     }
     getLockSQL(qb, lockMode, lockTables = []) {
@@ -438,33 +514,29 @@ class QueryBuilderHelper {
     }
     updateVersionProperty(qb, data) {
         const meta = this.metadata.find(this.entityName);
-        if (!meta || !meta.versionProperty || meta.versionProperty in data) {
+        if (!meta?.versionProperty || meta.versionProperty in data) {
             return;
         }
         const versionProperty = meta.properties[meta.versionProperty];
         let sql = this.platform.quoteIdentifier(versionProperty.fieldNames[0]) + ' + 1';
-        if (versionProperty.type.toLowerCase() === 'date') {
+        if (versionProperty.runtimeType === 'Date') {
             sql = this.platform.getCurrentTimestampSQL(versionProperty.length);
         }
         qb.update(versionProperty.fieldNames[0], this.knex.raw(sql));
     }
-    static isCustomExpression(field, hasAlias = false) {
-        // if we do not have alias, we don't consider spaces as custom expressions
-        const re = hasAlias ? /[ ?<>=()'"`:]|^\d/ : /[?<>=()'"`:]|^\d/;
-        return !!field.match(re);
-    }
     prefix(field, always = false, quote = false) {
         let ret;
         if (!this.isPrefixed(field)) {
             const alias = always ? (quote ? this.alias : this.platform.quoteIdentifier(this.alias)) + '.' : '';
             const fieldName = this.fieldName(field, this.alias, always);
-            if (QueryBuilderHelper.isCustomExpression(fieldName)) {
-                return fieldName;
+            if (fieldName instanceof core_1.RawQueryFragment) {
+                return fieldName.sql;
             }
             ret = alias + fieldName;
         }
         else {
-            const [a, f] = field.split('.');
+            const [a, ...rest] = field.split('.');
+            const f = rest.join('.');
             ret = a + '.' + this.fieldName(f, a);
         }
         if (quote) {
@@ -498,26 +570,78 @@ class QueryBuilderHelper {
         }
         if (prop.fieldNameRaw) {
             if (!always) {
-                return prop.fieldNameRaw
-                    .replace(/\[::alias::]\.?/g, '')
-                    .replace(this.platform.quoteIdentifier('') + '.', '');
+                return (0, core_1.raw)(prop.fieldNameRaw
+                    .replace(new RegExp(core_1.ALIAS_REPLACEMENT_RE + '\\.?', 'g'), '')
+                    .replace(this.platform.quoteIdentifier('') + '.', ''));
             }
             if (alias) {
-                return prop.fieldNameRaw.replace(/\[::alias::]/g, alias);
+                return (0, core_1.raw)(prop.fieldNameRaw.replace(new RegExp(core_1.ALIAS_REPLACEMENT_RE, 'g'), alias));
             }
             /* istanbul ignore next */
-            return prop.fieldNameRaw;
+            return (0, core_1.raw)(prop.fieldNameRaw);
         }
         /* istanbul ignore next */
-        return prop.fieldNames[0] ?? field;
+        return prop.fieldNames?.[0] ?? field;
     }
     getProperty(field, alias) {
-        const entityName = this.aliasMap[alias] || this.entityName;
+        const entityName = this.aliasMap[alias]?.entityName || this.entityName;
         const meta = this.metadata.find(entityName);
-        return meta ? meta.properties[field] : undefined;
+        // check if `alias` is not matching an embedded property name instead of alias, e.g. `address.city`
+        if (alias && meta) {
+            const prop = meta.properties[alias];
+            if (prop?.kind === core_1.ReferenceKind.EMBEDDED) {
+                // we want to select the full object property so hydration works as expected
+                if (prop.object) {
+                    return prop;
+                }
+                const parts = field.split('.');
+                const nest = (p) => parts.length > 0 ? nest(p.embeddedProps[parts.shift()]) : p;
+                return nest(prop);
+            }
+        }
+        return meta?.properties[field];
     }
     isTableNameAliasRequired(type) {
-        return [enums_1.QueryType.SELECT, enums_1.QueryType.COUNT].includes(type);
+        return [enums_1.QueryType.SELECT, enums_1.QueryType.COUNT].includes(type ?? enums_1.QueryType.SELECT);
+    }
+    mapData(data, properties, convertCustomTypes) {
+        if (!properties) {
+            return data;
+        }
+        data = Object.assign({}, data); // copy first
+        Object.keys(data).forEach(k => {
+            const prop = properties[k];
+            if (!prop) {
+                return;
+            }
+            if (prop.embeddedProps && !prop.object) {
+                const copy = data[k];
+                delete data[k];
+                Object.assign(data, this.mapData(copy, prop.embeddedProps, convertCustomTypes));
+                return;
+            }
+            if (prop.joinColumns && Array.isArray(data[k])) {
+                const copy = core_1.Utils.flatten(data[k]);
+                delete data[k];
+                prop.joinColumns.forEach((joinColumn, idx) => data[joinColumn] = copy[idx]);
+                return;
+            }
+            if (prop.customType && convertCustomTypes && !this.platform.isRaw(data[k])) {
+                data[k] = prop.customType.convertToDatabaseValue(data[k], this.platform, { fromQuery: true, key: k, mode: 'query-data' });
+            }
+            if (prop.hasConvertToDatabaseValueSQL && !this.platform.isRaw(data[k])) {
+                const quoted = this.platform.quoteValue(data[k]);
+                const sql = prop.customType.convertToDatabaseValueSQL(quoted, this.platform);
+                data[k] = this.knex.raw(sql.replace(/\?/g, '\\?'));
+            }
+            if (!prop.customType && (Array.isArray(data[k]) || core_1.Utils.isPlainObject(data[k]))) {
+                data[k] = JSON.stringify(data[k]);
+            }
+            if (prop.fieldNames) {
+                core_1.Utils.renameKey(data, k, prop.fieldNames[0]);
+            }
+        });
+        return data;
     }
 }
 exports.QueryBuilderHelper = QueryBuilderHelper;