feat: use bind params in bulkInsertQuery

packages/core/src/dialects/abstract/index.ts

@@ -694,3 +694,8 @@ export type BindCollector = {
    */
   getBindParameterOrder(): string[] | null;
 };
+
+export enum ParameterStyle {
+  bind = 'bind',
+  replacement = 'replacement',
+}

packages/core/src/dialects/abstract/query-generator.d.ts

@@ -11,6 +11,7 @@ import type {
   SearchPathable,
 } from '../../model.js';
 import type { DataType } from './data-types.js';
+import type { ParameterStyle } from './index.js';
 import { AbstractQueryGeneratorTypeScript } from './query-generator-typescript.js';
 import type { AttributeToSqlOptions } from './query-generator.internal-types.js';
 import type { TableOrModel } from './query-generator.types.js';
@@ -19,6 +20,8 @@ import type { ColumnsDescription } from './query-interface.types.js';
 import type { WhereOptions } from './where-sql-builder-types.js';
 
 type ParameterOptions = {
+  parameterStyle?: ParameterStyle;
+  bindParam?: false | ((value: unknown) => string);
   // only named replacements are allowed
   replacements?: { [key: string]: unknown };
 };
@@ -30,7 +33,6 @@ type SelectOptions<M extends Model> = FindOptions<M> & {
 type InsertOptions = ParameterOptions &
   SearchPathable & {
     exception?: boolean;
-    bindParam?: false | ((value: unknown) => string);
 
     updateOnDuplicate?: string[];
     ignoreDuplicates?: boolean;
@@ -47,11 +49,12 @@ type BulkInsertOptions = ParameterOptions & {
   returning?: boolean | Array<string | Literal | Col>;
 };
 
-type UpdateOptions = ParameterOptions & {
-  bindParam?: false | ((value: unknown) => string);
-};
+type UpdateOptions = ParameterOptions;
+
+type ArithmeticQueryOptions = {
+  // only named replacements are allowed
+  replacements?: { [key: string]: unknown };
 
-type ArithmeticQueryOptions = ParameterOptions & {
   returning?: boolean | Array<string | Literal | Col>;
 };
 
@@ -74,6 +77,8 @@ export interface AddColumnQueryOptions {
   ifNotExists?: boolean;
 }
 
+type BoundQuery = { query: string; bind?: Record<string, unknown> };
+
 /**
  * The base class for all query generators, used to generate all SQL queries.
  *
@@ -93,13 +98,13 @@ export class AbstractQueryGenerator extends AbstractQueryGeneratorTypeScript {
     valueHash: object,
     columnDefinitions?: { [columnName: string]: NormalizedAttributeOptions },
     options?: InsertOptions,
-  ): { query: string; bind?: unknown[] };
+  ): BoundQuery;
   bulkInsertQuery(
     tableName: TableName,
     newEntries: object[],
     options?: BulkInsertOptions,
     columnDefinitions?: { [columnName: string]: NormalizedAttributeOptions },
-  ): string;
+  ): BoundQuery;
 
   addColumnQuery(
     table: TableName,
@@ -114,7 +119,7 @@ export class AbstractQueryGenerator extends AbstractQueryGeneratorTypeScript {
     where: WhereOptions,
     options?: UpdateOptions,
     columnDefinitions?: { [columnName: string]: NormalizedAttributeOptions },
-  ): { query: string; bind?: unknown[] };
+  ): BoundQuery;
 
   arithmeticQuery(
     operator: string,

packages/core/src/dialects/abstract/query-generator.js

@@ -26,6 +26,7 @@ import { joinSQLFragments } from '../../utils/join-sql-fragments';
 import { isModelStatic } from '../../utils/model-utils';
 import { nameIndex, spliceStr } from '../../utils/string';
 import { attributeTypeToSql } from './data-types-utils';
+import { ParameterStyle } from './index.js';
 import { AbstractQueryGeneratorInternal } from './query-generator-internal.js';
 import { AbstractQueryGeneratorTypeScript } from './query-generator-typescript';
 import { joinWithLogicalOperator } from './where-sql-builder';
@@ -77,12 +78,13 @@ export class AbstractQueryGenerator extends AbstractQueryGeneratorTypeScript {
     defaults(options, this.options);
 
     const modelAttributeMap = {};
-    const bind = Object.create(null);
     const fields = [];
     const returningModelAttributes = [];
     const values = Object.create(null);
     const quotedTable = this.quoteTable(table);
-    let bindParam = options.bindParam === undefined ? this.bindParam(bind) : options.bindParam;
+    let bind;
+    let bindParam;
+    let parameterStyle = options.parameterStyle ?? ParameterStyle.bind;
     let query;
     let valueQuery = '';
     let emptyQuery = '';
@@ -120,12 +122,17 @@ export class AbstractQueryGenerator extends AbstractQueryGeneratorTypeScript {
       options.searchPath
     ) {
       // Not currently supported with search path (requires output of multiple queries)
-      bindParam = undefined;
+      parameterStyle = ParameterStyle.replacement;
     }
 
     if (this.dialect.supports.EXCEPTION && options.exception) {
       // Not currently supported with bind parameters (requires output of multiple queries)
-      bindParam = undefined;
+      parameterStyle = ParameterStyle.replacement;
+    }
+
+    if (parameterStyle === ParameterStyle.bind) {
+      bind = Object.create(null);
+      bindParam = options.bindParam || this.bindParam(bind);
     }
 
     valueHash = removeNullishValuesFromHash(valueHash, this.options.omitNull);
@@ -271,7 +278,7 @@ export class AbstractQueryGenerator extends AbstractQueryGeneratorTypeScript {
 
     // Used by Postgres upsertQuery and calls to here with options.exception set to true
     const result = { query };
-    if (options.bindParam !== false) {
+    if (parameterStyle === ParameterStyle.bind) {
       result.bind = bind;
     }
 
@@ -292,11 +299,19 @@ export class AbstractQueryGenerator extends AbstractQueryGeneratorTypeScript {
     options ||= {};
     fieldMappedAttributes ||= {};
 
+    const parameterStyle = options.parameterStyle ?? ParameterStyle.bind;
     const tuples = [];
     const serials = {};
     const allAttributes = [];
+    let bind;
+    let bindParam;
     let onDuplicateKeyUpdate = '';
 
+    if (parameterStyle === ParameterStyle.bind) {
+      bind = Object.create(null);
+      bindParam = options.bindParam || this.bindParam(bind);
+    }
+
     for (const fieldValueHash of fieldValueHashes) {
       forOwn(fieldValueHash, (value, key) => {
         if (!allAttributes.includes(key)) {
@@ -318,7 +333,7 @@ export class AbstractQueryGenerator extends AbstractQueryGeneratorTypeScript {
 
         return this.escape(fieldValueHash[key] ?? null, {
           // model // TODO: make bulkInsertQuery accept model instead of fieldValueHashes
-          // bindParam // TODO: support bind params
+          bindParam,
           type: fieldMappedAttributes[key]?.type,
           replacements: options.replacements,
         });
@@ -386,7 +401,7 @@ export class AbstractQueryGenerator extends AbstractQueryGeneratorTypeScript {
       returning += returnValues.returningFragment;
     }
 
-    return joinSQLFragments([
+    const query = joinSQLFragments([
       'INSERT',
       ignoreDuplicates,
       'INTO',
@@ -399,6 +414,14 @@ export class AbstractQueryGenerator extends AbstractQueryGeneratorTypeScript {
       returning,
       ';',
     ]);
+
+    const result = { query };
+
+    if (parameterStyle === ParameterStyle.bind) {
+      result.bind = bind;
+    }
+
+    return result;
   }
 
   /**
@@ -419,8 +442,10 @@ export class AbstractQueryGenerator extends AbstractQueryGeneratorTypeScript {
     attrValueHash = removeNullishValuesFromHash(attrValueHash, options.omitNull, options);
 
     const values = [];
-    const bind = Object.create(null);
     const modelAttributeMap = {};
+    let parameterStyle = options.parameterStyle ?? ParameterStyle.bind;
+    let bind;
+    let bindParam;
     let outputFragment = '';
     let tmpTable = ''; // tmpTable declaration for trigger
     let suffix = '';
@@ -430,10 +455,13 @@ export class AbstractQueryGenerator extends AbstractQueryGeneratorTypeScript {
       options.searchPath
     ) {
       // Not currently supported with search path (requires output of multiple queries)
-      options.bindParam = false;
+      parameterStyle = ParameterStyle.replacement;
     }
 
-    const bindParam = options.bindParam === undefined ? this.bindParam(bind) : options.bindParam;
+    if (parameterStyle === ParameterStyle.bind) {
+      bind = Object.create(null);
+      bindParam = options.bindParam || this.bindParam(bind);
+    }
 
     if (
       this.dialect.supports['LIMIT ON UPDATE'] &&
@@ -501,7 +529,8 @@ export class AbstractQueryGenerator extends AbstractQueryGeneratorTypeScript {
 
     // Used by Postgres upsertQuery and calls to here with options.exception set to true
     const result = { query };
-    if (options.bindParam !== false) {
+
+    if (parameterStyle === ParameterStyle.bind) {
       result.bind = bind;
     }
 

packages/core/src/dialects/abstract/query-interface.js

@@ -477,14 +477,24 @@ export class AbstractQueryInterface extends AbstractQueryInterfaceTypeScript {
    * @returns {Promise}
    */
   async bulkInsert(tableName, records, options, attributes) {
+    if (options?.bind) {
+      assertNoReservedBind(options.bind);
+    }
+
     options = { ...options, type: QueryTypes.INSERT };
 
-    const sql = this.queryGenerator.bulkInsertQuery(tableName, records, options, attributes);
+    const { bind, query } = this.queryGenerator.bulkInsertQuery(
+      tableName,
+      records,
+      options,
+      attributes,
+    );
 
     // unlike bind, replacements are handled by QueryGenerator, not QueryRaw
     delete options.replacements;
+    options.bind = combineBinds(options.bind, bind);
 
-    const results = await this.sequelize.queryRaw(sql, options);
+    const results = await this.sequelize.queryRaw(query, options);
 
     return results[0];
   }

packages/core/src/index.d.ts

@@ -34,7 +34,7 @@ export type {
   TimeOptions,
   VirtualOptions,
 } from './dialects/abstract/data-types.js';
-export { AbstractDialect } from './dialects/abstract/index.js';
+export { AbstractDialect, ParameterStyle } from './dialects/abstract/index.js';
 export { AbstractQueryGenerator } from './dialects/abstract/query-generator.js';
 export * from './dialects/abstract/query-generator.types.js';
 export * from './dialects/abstract/query-interface.js';

packages/core/src/index.mjs

@@ -83,7 +83,8 @@ export const UniqueConstraintError = Pkg.UniqueConstraintError;
 // export { useInflection } from './lib/utils';
 export const useInflection = Pkg.useInflection;
 
-// export { QueryTypes, Op, TableHints, IndexHints, DataTypes, Deferrable, ConstraintChecking };
+// export { ParameterStyle, QueryTypes, Op, TableHints, IndexHints, DataTypes, GeoJsonType, Deferrable, ConstraintChecking };
+export const ParameterStyle = Pkg.ParameterStyle;
 export const QueryTypes = Pkg.QueryTypes;
 export const Op = Pkg.Op;
 export const TableHints = Pkg.TableHints;

packages/core/src/sequelize.js

@@ -15,7 +15,7 @@ import { Association } from './associations/index';
 import * as DataTypes from './data-types';
 import { ConstraintChecking, Deferrable } from './deferrable';
 import { AbstractConnectionManager } from './dialects/abstract/connection-manager.js';
-import { AbstractDialect } from './dialects/abstract/index.js';
+import { AbstractDialect, ParameterStyle } from './dialects/abstract/index.js';
 import { AbstractQueryGenerator } from './dialects/abstract/query-generator.js';
 import { AbstractQueryInterface } from './dialects/abstract/query-interface';
 import { AbstractQuery } from './dialects/abstract/query.js';
@@ -1022,6 +1022,7 @@ Use Sequelize#query if you wish to use replacements.`);
   static TransactionType = TransactionType;
   static Lock = Lock;
   static IsolationLevel = IsolationLevel;
+  static ParameterStyle = ParameterStyle;
 
   log(...args) {
     let options;

packages/core/test/integration/model/bulk-create.test.js

@@ -195,7 +195,7 @@ describe('Model', () => {
               default: {
                 // mysql, sqlite
                 expect(sql).to.include(
-                  'INSERT INTO `Beers` (`id`,`style`,`createdAt`,`updatedAt`) VALUES (NULL',
+                  'INSERT INTO `Beers` (`id`,`style`,`createdAt`,`updatedAt`) VALUES (',
                 );
               }
             }