bun-query-builder 0.2.47 → 0.2.49

package/dist/bin/cli.js

@@ -18635,20 +18635,62 @@ class MySQLDriver {
   createEnumType(_enumTypeName, _values) {
     return "";
   }
+  foreignKeyClauses(table) {
+    return table.columns.filter((column) => column.references).map((column) => {
+      const reference = column.references;
+      const name = `${table.table}_${column.name}_fk`;
+      let clause = `CONSTRAINT ${this.quoteIdentifier(name)} FOREIGN KEY (${this.quoteIdentifier(column.name)}) REFERENCES ${this.quoteIdentifier(reference.table)}(${this.quoteIdentifier(reference.column)})`;
+      if (reference.onDelete)
+        clause += ` ON DELETE ${reference.onDelete.toUpperCase()}`;
+      if (reference.onUpdate)
+        clause += ` ON UPDATE ${reference.onUpdate.toUpperCase()}`;
+      return clause;
+    });
+  }
   createTable(table) {
-    const columns = table.columns.map((c) => this.renderColumn(c)).join(`,
-  `);
+    const parts = [
+      ...table.columns.map((c) => this.renderColumn(c)),
+      ...this.foreignKeyClauses(table)
+    ];
     return `CREATE TABLE IF NOT EXISTS ${this.quoteIdentifier(table.table)} (
-  ${columns}
-);`;
+  ${parts.join(`,
+  `)}
+) DEFAULT CHARSET=utf8mb4;`;
   }
   static KEY_PREFIX_CHARACTERS = 255;
-  needsKeyPrefix(column) {
+  static MAX_KEY_BYTES = 3072;
+  static BYTES_PER_CHARACTER = 4;
+  keyPartWidth(column) {
     const rendered = this.getColumnType(column).toLowerCase();
     if (rendered.includes("text") || rendered.includes("blob") || rendered === "json")
-      return true;
-    const width = rendered.match(/^(?:var)?char\((\d+)\)$/)?.[1];
-    return width !== undefined && Number(width) >= 768;
+      return { bytes: Number.POSITIVE_INFINITY, indexableWhole: false };
+    const characters = rendered.match(/^(?:var)?char\((\d+)\)$/)?.[1];
+    if (characters !== undefined)
+      return { bytes: Number(characters) * MySQLDriver.BYTES_PER_CHARACTER, indexableWhole: true };
+    return { bytes: 8, indexableWhole: true };
+  }
+  keyParts(tableName, index, columns) {
+    const parts = index.columns.map((name) => {
+      const column = columns?.find((one) => one.name === name);
+      const width = column ? this.keyPartWidth(column) : { bytes: 0, indexableWhole: true };
+      const prefixed = !width.indexableWhole;
+      return {
+        name,
+        prefixed,
+        bytes: prefixed ? MySQLDriver.KEY_PREFIX_CHARACTERS * MySQLDriver.BYTES_PER_CHARACTER : width.bytes,
+        narrowable: !width.indexableWhole || width.bytes > MySQLDriver.KEY_PREFIX_CHARACTERS * MySQLDriver.BYTES_PER_CHARACTER
+      };
+    });
+    const total = () => parts.reduce((sum, part) => sum + part.bytes, 0);
+    while (total() > MySQLDriver.MAX_KEY_BYTES) {
+      const widest = parts.filter((part) => part.narrowable && !part.prefixed).sort((a, b) => b.bytes - a.bytes)[0];
+      if (!widest) {
+        throw new Error(`[migrations] Index '${index.name}' on table '${tableName}' needs ${total()} bytes of key, over MySQL's ${MySQLDriver.MAX_KEY_BYTES}. ` + `Every column in it is already at its ${MySQLDriver.KEY_PREFIX_CHARACTERS}-character prefix, so shorten a column or drop one from the index.`);
+      }
+      widest.prefixed = true;
+      widest.bytes = MySQLDriver.KEY_PREFIX_CHARACTERS * MySQLDriver.BYTES_PER_CHARACTER;
+    }
+    return parts.map((part) => part.prefixed ? `${this.quoteIdentifier(part.name)}(${MySQLDriver.KEY_PREFIX_CHARACTERS})` : this.quoteIdentifier(part.name));
   }
   createIndex(tableName, index, columns) {
     if (index.where) {
@@ -18656,11 +18698,7 @@ class MySQLDriver {
     }
     const kind = index.type === "unique" ? "UNIQUE " : "";
     const idxName = qualifiedIndexName(tableName, index.name);
-    const keyParts = index.columns.map((name) => {
-      const column = columns?.find((one) => one.name === name);
-      const quoted = this.quoteIdentifier(name);
-      return column && this.needsKeyPrefix(column) ? `${quoted}(${MySQLDriver.KEY_PREFIX_CHARACTERS})` : quoted;
-    }).join(", ");
+    const keyParts = this.keyParts(tableName, index, columns).join(", ");
     return `CREATE ${kind}INDEX ${this.quoteIdentifier(idxName)} ON ${this.quoteIdentifier(tableName)} (${keyParts});`;
   }
   addForeignKey(tableName, columnName, refTable, refColumn, onDelete, onUpdate, existingConstraintNames = []) {
@@ -18773,14 +18811,6 @@ ${sql};` : `${sql};`;
     if (defaultValue) {
       parts.push(defaultValue);
     }
-    if (column.references) {
-      let reference = `REFERENCES ${this.quoteIdentifier(column.references.table)}(${this.quoteIdentifier(column.references.column)})`;
-      if (column.references.onDelete)
-        reference += ` ON DELETE ${column.references.onDelete.toUpperCase()}`;
-      if (column.references.onUpdate)
-        reference += ` ON UPDATE ${column.references.onUpdate.toUpperCase()}`;
-      parts.push(reference);
-    }
     return parts.join(" ");
   }
 }
@@ -19068,6 +19098,9 @@ var init_vitess = __esm(() => {
       const { references: _references, ...withoutReference } = column;
       return super.renderColumn(withoutReference);
     }
+    foreignKeyClauses(table) {
+      return this.sharded ? [] : super.foreignKeyClauses(table);
+    }
     createTable(table) {
       return super.createTable(table);
     }
@@ -32560,7 +32593,7 @@ function getPrefix() {
 }
 var prefix = getPrefix();
 // package.json
-var version2 = "0.2.47";
+var version2 = "0.2.49";
 
 // bin/cli.ts
 init_actions();

package/dist/drivers/mysql.d.ts

@@ -25,9 +25,13 @@ export declare class MySQLDriver implements DialectDriver {
   protected getAutoIncrementClause(column: ColumnPlan): string;
   protected getDefaultValue(column: ColumnPlan): string;
   createEnumType(_enumTypeName: string, _values: string[]): string;
+  protected foreignKeyClauses(table: TablePlan): string[];
   createTable(table: TablePlan): string;
   protected static readonly KEY_PREFIX_CHARACTERS: 255;
-  protected needsKeyPrefix(column: ColumnPlan): boolean;
+  protected static readonly MAX_KEY_BYTES: 3072;
+  protected static readonly BYTES_PER_CHARACTER: 4;
+  protected keyPartWidth(column: ColumnPlan): { bytes: number, indexableWhole: boolean };
+  protected keyParts(tableName: string, index: IndexPlan, columns?: readonly ColumnPlan[]): string[];
   createIndex(tableName: string, index: IndexPlan, columns?: readonly ColumnPlan[]): string;
   addForeignKey(tableName: string, columnName: string, refTable: string, refColumn: string, onDelete?: string, onUpdate?: string, existingConstraintNames?: string[]): string;
   addColumn(tableName: string, column: ColumnPlan): string;

package/dist/drivers/vitess.d.ts

@@ -35,6 +35,7 @@ export declare class VitessDriver extends MySQLDriver {
   constructor(sharded?: boolean);
   protected getAutoIncrementClause(column: ColumnPlan): string;
   protected renderColumn(column: ColumnPlan): string;
+  protected foreignKeyClauses(table: TablePlan): string[];
   createTable(table: TablePlan): string;
   addForeignKey(...args: Parameters<MySQLDriver['addForeignKey']>): string;
   createMigrationsTable(): string;

package/dist/src/index.js

@@ -18634,20 +18634,62 @@ class MySQLDriver {
   createEnumType(_enumTypeName, _values) {
     return "";
   }
+  foreignKeyClauses(table) {
+    return table.columns.filter((column) => column.references).map((column) => {
+      const reference = column.references;
+      const name = `${table.table}_${column.name}_fk`;
+      let clause = `CONSTRAINT ${this.quoteIdentifier(name)} FOREIGN KEY (${this.quoteIdentifier(column.name)}) REFERENCES ${this.quoteIdentifier(reference.table)}(${this.quoteIdentifier(reference.column)})`;
+      if (reference.onDelete)
+        clause += ` ON DELETE ${reference.onDelete.toUpperCase()}`;
+      if (reference.onUpdate)
+        clause += ` ON UPDATE ${reference.onUpdate.toUpperCase()}`;
+      return clause;
+    });
+  }
   createTable(table) {
-    const columns = table.columns.map((c) => this.renderColumn(c)).join(`,
-  `);
+    const parts = [
+      ...table.columns.map((c) => this.renderColumn(c)),
+      ...this.foreignKeyClauses(table)
+    ];
     return `CREATE TABLE IF NOT EXISTS ${this.quoteIdentifier(table.table)} (
-  ${columns}
-);`;
+  ${parts.join(`,
+  `)}
+) DEFAULT CHARSET=utf8mb4;`;
   }
   static KEY_PREFIX_CHARACTERS = 255;
-  needsKeyPrefix(column) {
+  static MAX_KEY_BYTES = 3072;
+  static BYTES_PER_CHARACTER = 4;
+  keyPartWidth(column) {
     const rendered = this.getColumnType(column).toLowerCase();
     if (rendered.includes("text") || rendered.includes("blob") || rendered === "json")
-      return true;
-    const width = rendered.match(/^(?:var)?char\((\d+)\)$/)?.[1];
-    return width !== undefined && Number(width) >= 768;
+      return { bytes: Number.POSITIVE_INFINITY, indexableWhole: false };
+    const characters = rendered.match(/^(?:var)?char\((\d+)\)$/)?.[1];
+    if (characters !== undefined)
+      return { bytes: Number(characters) * MySQLDriver.BYTES_PER_CHARACTER, indexableWhole: true };
+    return { bytes: 8, indexableWhole: true };
+  }
+  keyParts(tableName, index, columns) {
+    const parts = index.columns.map((name) => {
+      const column = columns?.find((one) => one.name === name);
+      const width = column ? this.keyPartWidth(column) : { bytes: 0, indexableWhole: true };
+      const prefixed = !width.indexableWhole;
+      return {
+        name,
+        prefixed,
+        bytes: prefixed ? MySQLDriver.KEY_PREFIX_CHARACTERS * MySQLDriver.BYTES_PER_CHARACTER : width.bytes,
+        narrowable: !width.indexableWhole || width.bytes > MySQLDriver.KEY_PREFIX_CHARACTERS * MySQLDriver.BYTES_PER_CHARACTER
+      };
+    });
+    const total = () => parts.reduce((sum, part) => sum + part.bytes, 0);
+    while (total() > MySQLDriver.MAX_KEY_BYTES) {
+      const widest = parts.filter((part) => part.narrowable && !part.prefixed).sort((a, b) => b.bytes - a.bytes)[0];
+      if (!widest) {
+        throw new Error(`[migrations] Index '${index.name}' on table '${tableName}' needs ${total()} bytes of key, over MySQL's ${MySQLDriver.MAX_KEY_BYTES}. ` + `Every column in it is already at its ${MySQLDriver.KEY_PREFIX_CHARACTERS}-character prefix, so shorten a column or drop one from the index.`);
+      }
+      widest.prefixed = true;
+      widest.bytes = MySQLDriver.KEY_PREFIX_CHARACTERS * MySQLDriver.BYTES_PER_CHARACTER;
+    }
+    return parts.map((part) => part.prefixed ? `${this.quoteIdentifier(part.name)}(${MySQLDriver.KEY_PREFIX_CHARACTERS})` : this.quoteIdentifier(part.name));
   }
   createIndex(tableName, index, columns) {
     if (index.where) {
@@ -18655,11 +18697,7 @@ class MySQLDriver {
     }
     const kind = index.type === "unique" ? "UNIQUE " : "";
     const idxName = qualifiedIndexName(tableName, index.name);
-    const keyParts = index.columns.map((name) => {
-      const column = columns?.find((one) => one.name === name);
-      const quoted = this.quoteIdentifier(name);
-      return column && this.needsKeyPrefix(column) ? `${quoted}(${MySQLDriver.KEY_PREFIX_CHARACTERS})` : quoted;
-    }).join(", ");
+    const keyParts = this.keyParts(tableName, index, columns).join(", ");
     return `CREATE ${kind}INDEX ${this.quoteIdentifier(idxName)} ON ${this.quoteIdentifier(tableName)} (${keyParts});`;
   }
   addForeignKey(tableName, columnName, refTable, refColumn, onDelete, onUpdate, existingConstraintNames = []) {
@@ -18772,14 +18810,6 @@ ${sql};` : `${sql};`;
     if (defaultValue) {
       parts.push(defaultValue);
     }
-    if (column.references) {
-      let reference = `REFERENCES ${this.quoteIdentifier(column.references.table)}(${this.quoteIdentifier(column.references.column)})`;
-      if (column.references.onDelete)
-        reference += ` ON DELETE ${column.references.onDelete.toUpperCase()}`;
-      if (column.references.onUpdate)
-        reference += ` ON UPDATE ${column.references.onUpdate.toUpperCase()}`;
-      parts.push(reference);
-    }
     return parts.join(" ");
   }
 }
@@ -19067,6 +19097,9 @@ var init_vitess = __esm(() => {
       const { references: _references, ...withoutReference } = column;
       return super.renderColumn(withoutReference);
     }
+    foreignKeyClauses(table) {
+      return this.sharded ? [] : super.foreignKeyClauses(table);
+    }
     createTable(table) {
       return super.createTable(table);
     }

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "bun-query-builder",
   "type": "module",
-  "version": "0.2.47",
+  "version": "0.2.49",
   "description": "A simple yet performant query builder for TypeScript. Built with Bun.",
   "author": "Chris Breuer <chris@stacksjs.org>",
   "license": "MIT",