@sqb/builder 4.24.1 → 4.25.0

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@sqb/builder",
   "description": "Extensible multi-dialect SQL query builder written with TypeScript",
-  "version": "4.24.1",
+  "version": "4.25.0",
   "author": "Panates",
   "license": "Apache-2.0",
   "dependencies": {

package/query/delete-query.js

@@ -33,6 +33,8 @@ export class DeleteQuery extends Query {
         const o = {
             table: this._table._serialize(ctx),
             where: this._serializeWhere(ctx),
+            indexHint: this._indexHint.filter(x => !ctx.dialect || !x.dialect?.length || x.dialect.includes(ctx.dialect)),
+            noIndexHint: this._noIndexHint.filter(x => !ctx.dialect || !x.dialect?.length || x.dialect.includes(ctx.dialect)),
         };
         return ctx.serialize(this._type, o, () => this.__defaultSerialize(ctx, o));
     }

package/query/insert-query.js

@@ -32,6 +32,8 @@ export class InsertQuery extends ReturningQuery {
             columns: this.__serializeColumns(ctx),
             values: this.__serializeValues(ctx),
             returning: this.__serializeReturning(ctx),
+            indexHint: this._indexHint.filter(x => !ctx.dialect || !x.dialect?.length || x.dialect.includes(ctx.dialect)),
+            noIndexHint: this._noIndexHint.filter(x => !ctx.dialect || !x.dialect?.length || x.dialect.includes(ctx.dialect)),
         };
         let out = 'insert into ' +
             o.table +

package/query/query.d.ts

@@ -3,9 +3,18 @@ import { Serializable } from '../serializable.js';
 import { GenerateOptions, GenerateResult } from '../types.js';
 export declare interface Query extends EventEmitter {
 }
+export interface QueryCommentArgs {
+    comment: string;
+    dialect?: string[];
+}
+export interface QueryIndexHintArgs {
+    index: string[];
+    dialect?: string[];
+}
 export declare abstract class Query extends Serializable {
-    protected _comment?: string;
-    protected _commentDialect?: string[];
+    protected _comment: QueryCommentArgs[];
+    protected _indexHint: QueryIndexHintArgs[];
+    protected _noIndexHint: QueryIndexHintArgs[];
     protected _params?: Record<string, any>;
     constructor();
     /**
@@ -13,5 +22,10 @@ export declare abstract class Query extends Serializable {
      */
     generate(options?: GenerateOptions): GenerateResult;
     values(obj: any): this;
+    comment(args: QueryCommentArgs): this;
     comment(text: string, dialect?: string[]): this;
+    indexHint(args: QueryIndexHintArgs): this;
+    indexHint(index: string | string[], dialect?: string[]): this;
+    noIndexHint(args: QueryIndexHintArgs): this;
+    noIndexHint(index: string | string[], dialect?: string[]): this;
 }

package/query/query.js

@@ -4,8 +4,9 @@ import merge from 'putil-merge';
 import { Serializable } from '../serializable.js';
 import { SerializeContext } from '../serialize-context.js';
 export class Query extends Serializable {
-    _comment;
-    _commentDialect;
+    _comment = [];
+    _indexHint = [];
+    _noIndexHint = [];
     _params;
     constructor() {
         super();
@@ -22,12 +23,16 @@ export class Query extends Serializable {
         /* generate output */
         let sql = this._serialize(ctx);
         sql = flattenText(sql, { noWrap: !ctx.prettyPrint });
-        if (this._comment &&
-            (!ctx.dialect ||
-                !this._commentDialect ||
-                this._commentDialect.includes(ctx.dialect))) {
-            const lines = '-- ' + this._comment.split('\n').join('\n-- ') + '\n';
-            sql = lines + sql;
+        if (this._comment.length) {
+            const comment = this._comment
+                .filter(x => !ctx.dialect ||
+                !x.dialect?.length ||
+                x.dialect.includes(ctx.dialect))
+                .map(x => x.comment.replace(/\n/g, '\n  '))
+                .join('\n');
+            if (comment) {
+                sql = `/*${comment}*/\n${sql}`;
+            }
         }
         return {
             sql,
@@ -42,9 +47,45 @@ export class Query extends Serializable {
         this._params = obj;
         return this;
     }
-    comment(text, dialect) {
-        this._comment = text;
-        this._commentDialect = dialect;
+    comment(arg0, dialect) {
+        if (typeof arg0 === 'string')
+            this._comment.push({
+                comment: arg0,
+                dialect: Array.isArray(dialect) ? dialect : undefined,
+            });
+        else if (typeof arg0 === 'object' && typeof arg0.comment === 'string')
+            this._comment.push({
+                comment: arg0.comment,
+                dialect: Array.isArray(arg0.dialect) ? arg0.dialect : undefined,
+            });
+        return this;
+    }
+    indexHint(arg0, dialect) {
+        if (typeof arg0 === 'object' && !Array.isArray(arg0))
+            this._indexHint.push({
+                index: Array.isArray(arg0.index) ? arg0.index : [arg0.index],
+                dialect: Array.isArray(arg0.dialect) ? arg0.dialect : undefined,
+            });
+        else {
+            this._indexHint.push({
+                index: Array.isArray(arg0) ? arg0 : [arg0],
+                dialect: Array.isArray(dialect) ? dialect : undefined,
+            });
+        }
+        return this;
+    }
+    noIndexHint(arg0, dialect) {
+        if (typeof arg0 === 'object' && !Array.isArray(arg0))
+            this._noIndexHint.push({
+                index: Array.isArray(arg0.index) ? arg0.index : [arg0.index],
+                dialect: Array.isArray(arg0.dialect) ? arg0.dialect : undefined,
+            });
+        else {
+            this._noIndexHint.push({
+                index: Array.isArray(arg0) ? arg0 : [arg0],
+                dialect: Array.isArray(dialect) ? dialect : undefined,
+            });
+        }
         return this;
     }
 }

package/query/select-query.js

@@ -150,6 +150,8 @@ export class SelectQuery extends Query {
             orderBy: this.__serializeOrderColumns(ctx),
             limit: this._limit,
             offset: this._offset,
+            indexHint: this._indexHint.filter(x => !ctx.dialect || !x.dialect?.length || x.dialect.includes(ctx.dialect)),
+            noIndexHint: this._noIndexHint.filter(x => !ctx.dialect || !x.dialect?.length || x.dialect.includes(ctx.dialect)),
         };
         return ctx.serialize(this._type, o, () => {
             let out = 'select';

package/query/update-query.js

@@ -42,6 +42,8 @@ export class UpdateQuery extends ReturningQuery {
             values: this.__serializeValues(ctx),
             where: this.__serializeWhere(ctx),
             returning: this.__serializeReturning(ctx),
+            indexHint: this._indexHint.filter(x => !ctx.dialect || !x.dialect?.length || x.dialect.includes(ctx.dialect)),
+            noIndexHint: this._noIndexHint.filter(x => !ctx.dialect || !x.dialect?.length || x.dialect.includes(ctx.dialect)),
         };
         let out = 'update ' + o.table + ' set \n\t' + o.values + '\b';
         if (o.where)