@mikro-orm/knex 5.7.15-dev.40 → 5.7.15-dev.42

package/AbstractSqlDriver.js

@@ -38,6 +38,9 @@ class AbstractSqlDriver extends core_1.DatabaseDriver {
             .orderBy([...core_1.Utils.asArray(options.orderBy), ...joinedPropsOrderBy])
             .groupBy(options.groupBy)
             .having(options.having)
+            .indexHint(options.indexHint)
+            .comment(options.comments)
+            .hintComment(options.hintComments)
             .withSchema(this.getSchemaName(meta, options));
         if (options.limit !== undefined) {
             qb.limit(options.limit, options.offset);
@@ -105,7 +108,10 @@ class AbstractSqlDriver extends core_1.DatabaseDriver {
     }
     async wrapVirtualExpressionInSubquery(meta, expression, where, options, type = query_1.QueryType.SELECT) {
         const qb = this.createQueryBuilder(meta.className, options?.ctx, options.connectionType, options.convertCustomTypes)
-            .limit(options?.limit, options?.offset);
+            .limit(options?.limit, options?.offset)
+            .indexHint(options.indexHint)
+            .comment(options.comments)
+            .hintComment(options.hintComments);
         if (options.orderBy) {
             qb.orderBy(options.orderBy);
         }
@@ -207,6 +213,9 @@ class AbstractSqlDriver extends core_1.DatabaseDriver {
             return this.countVirtual(entityName, where, options);
         }
         const qb = this.createQueryBuilder(entityName, options.ctx, options.connectionType, false)
+            .indexHint(options.indexHint)
+            .comment(options.comments)
+            .hintComment(options.hintComments)
             .groupBy(options.groupBy)
             .having(options.having)
             .populate(options.populate ?? [])
@@ -501,17 +510,22 @@ class AbstractSqlDriver extends core_1.DatabaseDriver {
         else {
             where = { ...where, ...cond };
         }
+        /* istanbul ignore if */
+        options = { ...options };
         orderBy = this.getPivotOrderBy(prop, orderBy);
-        const qb = this.createQueryBuilder(prop.type, ctx, options?.connectionType)
+        const qb = this.createQueryBuilder(prop.type, ctx, options.connectionType)
+            .indexHint(options.indexHint)
+            .comment(options.comments)
+            .hintComment(options.hintComments)
             .unsetFlag(core_1.QueryFlag.CONVERT_CUSTOM_TYPES)
             .withSchema(this.getSchemaName(prop.targetMeta, options));
         const populate = this.autoJoinOneToOneOwner(prop.targetMeta, [{ field: prop.pivotEntity }]);
-        const fields = this.buildFields(prop.targetMeta, (options?.populate ?? []), [], qb, options?.fields);
-        qb.select(fields).populate(populate).where(where).orderBy(orderBy).setLockMode(options?.lockMode, options?.lockTableAliases);
-        if (owners.length === 1 && (options?.offset != null || options?.limit != null)) {
+        const fields = this.buildFields(prop.targetMeta, (options.populate ?? []), [], qb, options.fields);
+        qb.select(fields).populate(populate).where(where).orderBy(orderBy).setLockMode(options.lockMode, options.lockTableAliases);
+        if (owners.length === 1 && (options.offset != null || options.limit != null)) {
             qb.limit(options.limit, options.offset);
         }
-        if (prop.targetMeta.schema !== '*' && pivotMeta.schema === '*' && options?.schema) {
+        if (prop.targetMeta.schema !== '*' && pivotMeta.schema === '*' && options.schema) {
             // eslint-disable-next-line dot-notation
             qb['finalize']();
             // eslint-disable-next-line dot-notation

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mikro-orm/knex",
-  "version": "5.7.15-dev.40",
+  "version": "5.7.15-dev.42",
   "description": "TypeScript ORM for Node.js based on Data Mapper, Unit of Work and Identity Map patterns. Supports MongoDB, MySQL, PostgreSQL and SQLite databases as well as usage with vanilla JavaScript.",
   "main": "index.js",
   "module": "index.mjs",
@@ -66,9 +66,9 @@
     "@mikro-orm/core": "^5.7.14"
   },
   "peerDependencies": {
-    "@mikro-orm/core": "~5.7.15-dev.40",
-    "@mikro-orm/entity-generator": "~5.7.15-dev.40",
-    "@mikro-orm/migrations": "~5.7.15-dev.40",
+    "@mikro-orm/core": "~5.7.15-dev.42",
+    "@mikro-orm/entity-generator": "~5.7.15-dev.42",
+    "@mikro-orm/migrations": "~5.7.15-dev.42",
     "better-sqlite3": "*",
     "mssql": "*",
     "mysql": "*",

package/query/QueryBuilder.d.ts

@@ -66,6 +66,8 @@ export declare class QueryBuilder<T extends object = AnyEntity> {
     private _joinedProps;
     private _cache?;
     private _indexHint?;
+    private _comments;
+    private _hintComments;
     private flushMode?;
     private lockMode?;
     private lockTables?;
@@ -132,6 +134,16 @@ export declare class QueryBuilder<T extends object = AnyEntity> {
      * Adds index hint to the FROM clause.
      */
     indexHint(sql: string): this;
+    /**
+     * Prepend comment to the sql query using the syntax `/* ... *&#8205;/`. Some characters are forbidden such as `/*, *&#8205;/` and `?`.
+     */
+    comment(comment: string | string[]): this;
+    /**
+     * Add hints to the query using comment-like syntax `/*+ ... *&#8205;/`. MySQL and Oracle use this syntax for optimizer hints.
+     * Also various DB proxies and routers use this syntax to pass hints to alter their behavior. In other dialects the hints
+     * are ignored as simple comments.
+     */
+    hintComment(comment: string | string[]): this;
     /**
      * Specifies FROM which entity's table select/update/delete will be executed, removing all previously set FROM-s.
      * Allows setting a main string alias of the selection data.

package/query/QueryBuilder.js

@@ -60,6 +60,8 @@ class QueryBuilder {
         this._groupBy = [];
         this._having = {};
         this._joinedProps = new Map();
+        this._comments = [];
+        this._hintComments = [];
         this.subQueries = {};
         this._aliases = {};
         this.platform = this.driver.getPlatform();
@@ -352,6 +354,24 @@ class QueryBuilder {
         this._indexHint = sql;
         return this;
     }
+    /**
+     * Prepend comment to the sql query using the syntax `/* ... *‍/`. Some characters are forbidden such as `/*, *‍/` and `?`.
+     */
+    comment(comment) {
+        this.ensureNotFinalized();
+        this._comments.push(...core_1.Utils.asArray(comment));
+        return this;
+    }
+    /**
+     * Add hints to the query using comment-like syntax `/*+ ... *‍/`. MySQL and Oracle use this syntax for optimizer hints.
+     * Also various DB proxies and routers use this syntax to pass hints to alter their behavior. In other dialects the hints
+     * are ignored as simple comments.
+     */
+    hintComment(comment) {
+        this.ensureNotFinalized();
+        this._hintComments.push(...core_1.Utils.asArray(comment));
+        return this;
+    }
     from(target, aliasName) {
         this.ensureNotFinalized();
         if (target instanceof QueryBuilder) {
@@ -381,6 +401,8 @@ class QueryBuilder {
         }, this._orderBy);
         core_1.Utils.runIfNotEmpty(() => qb.limit(this._limit), this._limit != null);
         core_1.Utils.runIfNotEmpty(() => qb.offset(this._offset), this._offset);
+        core_1.Utils.runIfNotEmpty(() => this._comments.forEach(comment => qb.comment(comment)), this._comments);
+        core_1.Utils.runIfNotEmpty(() => this._hintComments.forEach(comment => qb.hintComment(comment)), this._hintComments);
         core_1.Utils.runIfNotEmpty(() => this.helper.appendOnConflictClause(this.type ?? enums_1.QueryType.SELECT, this._onConflict, qb), this._onConflict);
         if (this.type === enums_1.QueryType.TRUNCATE && this.platform.usesCascadeStatement()) {
             return this.knex.raw(qb.toSQL().toNative().sql + ' cascade');
@@ -577,6 +599,7 @@ class QueryBuilder {
         const properties = [
             'flags', '_populate', '_populateWhere', '_populateMap', '_joins', '_joinedProps', '_cond', '_data', '_orderBy',
             '_schema', '_indexHint', '_cache', 'subQueries', 'lockMode', 'lockTables', '_groupBy', '_having', '_returning',
+            '_comments', '_hintComments',
         ];
         properties.forEach(prop => qb[prop] = core_1.Utils.copy(this[prop]));
         /* istanbul ignore else */