feat: Add support for key prefix lengths

README.md

@@ -1125,9 +1125,9 @@ See the [Column Types](#column-types) section for all possible column types and
 
 ### Primary Key
 
-`string|string[]`
+`string | string[]`
 
-The table’s primary key can be defined with the `primaryKey` property:
+The table’s primary key can be defined with the `primaryKey` property.
 
 ```js
 {
@@ -1151,6 +1151,17 @@ An array can be used to define a multi-column primary key.
 }
 ```
 
+Primary keys for string columns may include a key [prefix length](#prefix-lengths).
+
+```js
+{
+  columns: {
+    id: pool.ColTypes.varchar(100).unsigned().notNull(),
+  },
+  primaryKey: 'id(20)'
+}
+```
+
 ### Keys
 
 Keys can be defined with the `keys` property, which is an array of [`KeyTypes`](#key-types):
@@ -1395,10 +1406,10 @@ Compatible types:
 
 [`mysql.KeyTypes`](#module_mysql-plus..KeyTypes) and [`pool.KeyTypes`](#PoolPlus+KeyTypes) both expose the following methods for defining table keys:
 
-+ `index(columnName [, ...otherColumns])` - Creates a regular [index](https://dev.mysql.com/doc/en/create-index.html)
-+ `uniqueIndex(columnName [, ...otherColumns])` - Creates a [unique index](https://dev.mysql.com/doc/en/create-index.html#create-index-unique)
++ `index(keyPart [, ...otherKeyParts])` - Creates a regular [index](https://dev.mysql.com/doc/en/create-index.html)
++ `uniqueIndex(keyPart [, ...otherKeyParts])` - Creates a [unique index](https://dev.mysql.com/doc/en/create-index.html#create-index-unique)
 + `spatialIndex(columnName)` - Creates a [spatial index](https://dev.mysql.com/doc/en/create-index.html#create-index-spatial)
-+ `fulltextIndex(columnName)` - Creates a [fulltext index](https://dev.mysql.com/doc/en/innodb-fulltext-index.html)
++ `fulltextIndex(columnName, [...otherColumns])` - Creates a [fulltext index](https://dev.mysql.com/doc/en/innodb-fulltext-index.html)
 + `foreignKey(columnName [, ...otherColumns])` - Creates a [foreign key constraint](https://dev.mysql.com/doc/en/create-table-foreign-keys.html)
 
 **Example:**
@@ -1473,4 +1484,22 @@ Indexes required for the example above:
     KeyTypes.index('thingOne', 'thingTwo'),
   ]
 }
-```
+```
+
+### Prefix Lengths
+
+`PRIMARY`, `INDEX`, and `UNIQUE` keys on `char`, `varchar`, `binary`, `varbinary`, `blob`, and `text` columns may include a [key prefix length](https://dev.mysql.com/doc/en/create-index.html#create-index-column-prefixes).
+
+```js
+{
+  columns: {
+    id: ColTypes.char(50).notNull(),
+    uid: ColTypes.varchar(100).notNull(),
+    description: ColTypes.text(),
+  },
+  primaryKey: 'id(10)',
+  keys: [
+    KeyTypes.uniqueIndex('uid(30)'),
+    KeyTypes.index('description(50)'),
+  ]
+```

jsdoc2md/README.hbs

@@ -166,9 +166,9 @@ See the [Column Types](#column-types) section for all possible column types and
 
 ### Primary Key
 
-`string|string[]`
+`string | string[]`
 
-The table’s primary key can be defined with the `primaryKey` property:
+The table’s primary key can be defined with the `primaryKey` property.
 
 ```js
 {
@@ -192,6 +192,17 @@ An array can be used to define a multi-column primary key.
 }
 ```
 
+Primary keys for string columns may include a key [prefix length](#prefix-lengths).
+
+```js
+{
+  columns: {
+    id: pool.ColTypes.varchar(100).unsigned().notNull(),
+  },
+  primaryKey: 'id(20)'
+}
+```
+
 ### Keys
 
 Keys can be defined with the `keys` property, which is an array of [`KeyTypes`](#key-types):
@@ -436,10 +447,10 @@ Compatible types:
 
 [`mysql.KeyTypes`](#module_mysql-plus..KeyTypes) and [`pool.KeyTypes`](#PoolPlus+KeyTypes) both expose the following methods for defining table keys:
 
-+ `index(columnName [, ...otherColumns])` - Creates a regular [index](https://dev.mysql.com/doc/en/create-index.html)
-+ `uniqueIndex(columnName [, ...otherColumns])` - Creates a [unique index](https://dev.mysql.com/doc/en/create-index.html#create-index-unique)
++ `index(keyPart [, ...otherKeyParts])` - Creates a regular [index](https://dev.mysql.com/doc/en/create-index.html)
++ `uniqueIndex(keyPart [, ...otherKeyParts])` - Creates a [unique index](https://dev.mysql.com/doc/en/create-index.html#create-index-unique)
 + `spatialIndex(columnName)` - Creates a [spatial index](https://dev.mysql.com/doc/en/create-index.html#create-index-spatial)
-+ `fulltextIndex(columnName)` - Creates a [fulltext index](https://dev.mysql.com/doc/en/innodb-fulltext-index.html)
++ `fulltextIndex(columnName, [...otherColumns])` - Creates a [fulltext index](https://dev.mysql.com/doc/en/innodb-fulltext-index.html)
 + `foreignKey(columnName [, ...otherColumns])` - Creates a [foreign key constraint](https://dev.mysql.com/doc/en/create-table-foreign-keys.html)
 
 **Example:**
@@ -514,4 +525,22 @@ Indexes required for the example above:
     KeyTypes.index('thingOne', 'thingTwo'),
   ]
 }
-```
+```
+
+### Prefix Lengths
+
+`PRIMARY`, `INDEX`, and `UNIQUE` keys on `char`, `varchar`, `binary`, `varbinary`, `blob`, and `text` columns may include a [key prefix length](https://dev.mysql.com/doc/en/create-index.html#create-index-column-prefixes).
+
+```js
+{
+  columns: {
+    id: ColTypes.char(50).notNull(),
+    uid: ColTypes.varchar(100).notNull(),
+    description: ColTypes.text(),
+  },
+  primaryKey: 'id(10)',
+  keys: [
+    KeyTypes.uniqueIndex('uid(30)'),
+    KeyTypes.index('description(50)'),
+  ]
+```

lib/KeyDefinitions/IndexKeyDefinition.js

@@ -2,12 +2,14 @@
 
 const arraysEqual = require('../utils/arraysEqual');
 const {escapeId} = require('mysql/lib/protocol/SqlString');
+const parseKeyParts = require('../utils/parseKeyParts');
 
 class IndexKeyDefinition {
-  constructor(type, namePrefix, columns) {
-    this.$name = namePrefix + '_' + columns.join('_');
+  constructor(type, namePrefix, keyParts) {
+    const {columnNames, formattedKeyParts} = parseKeyParts(keyParts);
+    this.$name = namePrefix + '_' + columnNames.join('_');
     this._type = type;
-    this._columns = columns;
+    this._keyParts = formattedKeyParts;
   }
 
   name(name) {
@@ -18,11 +20,11 @@ class IndexKeyDefinition {
   $equals(otherKey) {
     return this._type === otherKey._type &&
       this.$name === otherKey.$name &&
-      arraysEqual(this._columns, otherKey._columns);
+      arraysEqual(this._keyParts, otherKey._keyParts);
   }
 
   $toSQL() {
-    return `${this._type} ${escapeId(this.$name)} (${escapeId(this._columns)})`;
+    return `${this._type} ${escapeId(this.$name)} (${this._keyParts.join(', ')})`;
   }
 }
 

lib/KeyDefinitions/PrimaryKeyDefinition.js

@@ -1,19 +1,21 @@
 'use strict';
 
 const arraysEqual = require('../utils/arraysEqual');
-const {escapeId} = require('mysql/lib/protocol/SqlString');
+const parseKeyParts = require('../utils/parseKeyParts');
 
 class PrimaryKeyDefinition {
-  constructor(columns) {
-    this._columns = columns;
+  constructor(keyParts) {
+    const {columnNames, formattedKeyParts} = parseKeyParts(keyParts);
+    this.$columnNames = columnNames;
+    this._keyParts = formattedKeyParts;
   }
 
   $equals(otherKey) {
-    return arraysEqual(this._columns, otherKey._columns);
+    return arraysEqual(this._keyParts, otherKey._keyParts);
   }
 
   $toSQL() {
-    return `PRIMARY KEY (${escapeId(this._columns)})`;
+    return `PRIMARY KEY (${this._keyParts.join(', ')})`;
   }
 }
 

lib/TableDefinition.js

@@ -130,7 +130,6 @@ class TableDefinition {
           `CHANGE COLUMN ${pool.escapeId(oldColumnName)} ${pool.escapeId(columnName)} ` +
             newColumnDefinition.$toSQL() + position
         ));
-
         renamedColumns.push(oldColumnName);
       } else if (!newColumnDefinition.$equals(oldColumnDefinition, oldSchema)) {
         operations.push(Operation.create(
@@ -390,14 +389,14 @@ function createInternalSchema(schema, tableName) {
     }
   }
 
-  let primaryKey = null;
+  let columnPK = null;
 
   // Extract keys defined in the columns
   for (const columnName in columns) {
     const column = columns[columnName];
 
     if (column.$primaryKey) {
-      primaryKey = columnName;
+      columnPK = columnName;
     }
     if (column.$unique) {
       const key = KeyDefinitions.uniqueIndex(columnName);
@@ -417,24 +416,20 @@ function createInternalSchema(schema, tableName) {
     }
   }
 
-  if (schema.primaryKey) {
+  let primaryKey = null;
+
+  if (schema.primaryKey) { // The primaryKey in the schema takes precedence over one defined by a column
+    if (typeof schema.primaryKey === 'string') {
+      primaryKey = new PrimaryKeyDefinition([schema.primaryKey]);
+    } else { // schema.primaryKey is an Array
+      primaryKey = new PrimaryKeyDefinition(schema.primaryKey);
+    }
     // Make sure primary key columns are not null
-    if (Array.isArray(schema.primaryKey)) {
-      for (const colName of schema.primaryKey) {
-        columns[colName].notNull();
-      }
-    } else {
-      columns[schema.primaryKey].notNull();
+    for (const colName of primaryKey.$columnNames) {
+      columns[colName].notNull();
     }
-
-    // The primaryKey in the schema takes precedence over one defined by a column
-    primaryKey = schema.primaryKey;
-  }
-
-  if (typeof primaryKey === 'string') {
-    primaryKey = new PrimaryKeyDefinition([primaryKey]);
-  } else if (Array.isArray(primaryKey)) {
-    primaryKey = new PrimaryKeyDefinition(primaryKey);
+  } else if (columnPK !== null) {
+    primaryKey = new PrimaryKeyDefinition([columnPK]);
   }
 
   return Object.assign({}, schema, {primaryKey, indexKeys, foreignKeys});

lib/sqlToSchema.js

@@ -150,20 +150,20 @@ function generateColumnsSchema(createDefinitions) {
 }
 
 function columnsSQLToSchema(sql) {
-  return sql.replace(/`|\s/g, '').split(',');
+  return sql.replace(/`/g, '').split(/,\s*/);
 }
 
 function generatePrimaryKeySchema(keySQL) {
-  const pkMatch = /^\s*PRIMARY KEY \((.*?)\)/.exec(keySQL);
+  const pkMatch = /^\s*PRIMARY KEY \((.*)\)/.exec(keySQL);
   return pkMatch === null
     ? null
     : new PrimaryKeyDefinition(columnsSQLToSchema(pkMatch[1]));
 }
 
-const rgxUniqueKey = /^\s*UNIQUE KEY `(\w+)` \((.*?)\)/;
-const rgxIndexKey = /^\s*KEY `(\w+)` \((.*?)\)/;
-const rgxSpatialKey = /^\s*SPATIAL KEY `(\w+)` \((.*?)\)/;
-const rgxFulltextKey = /^\s*FULLTEXT KEY `(\w+)` \((.*?)\)/;
+const rgxUniqueKey = /^\s*UNIQUE KEY `(\w+)` \((.*)\)/;
+const rgxIndexKey = /^\s*KEY `(\w+)` \((.*)\)/;
+const rgxSpatialKey = /^\s*SPATIAL KEY `(\w+)` \((.*)\)/;
+const rgxFulltextKey = /^\s*FULLTEXT KEY `(\w+)` \((.*)\)/;
 const rgxForeignKey =
   /\s*CONSTRAINT `(\w+)` FOREIGN KEY \(`(.*?)`\) REFERENCES `(\w+)` \(`(.*?)`\)(?: ON DELETE (RESTRICT|CASCADE|SET NULL|NO ACTION))?(?: ON UPDATE (RESTRICT|CASCADE|SET NULL|NO ACTION))?/;
 

lib/utils/parseKeyParts.js

@@ -0,0 +1,44 @@
+'use strict';
+
+const {escapeId} = require('mysql/lib/protocol/SqlString');
+
+function parseKeyParts(keyParts) {
+  const columnNames = [];
+  const formattedKeyParts = [];
+
+  for (let i = 0; i < keyParts.length; i++) {
+    const parsedKeyPart = parseKeyPart(keyParts[i]);
+
+    columnNames.push(parsedKeyPart.column);
+    formattedKeyParts.push(formatKeyPart(parsedKeyPart));
+  }
+
+  return {columnNames, formattedKeyParts};
+}
+
+const rgxKeyPart = /^(\w+)(?:\s*\((\d+)\))?(?:\s+(ASC|DESC))?/i;
+
+function parseKeyPart(keyPart) {
+  const match = rgxKeyPart.exec(keyPart);
+
+  if (match === null) {
+    throw new Error('Invalid key part: ' + keyPart);
+  }
+
+  return {
+    column: match[1],
+    length: match[2],
+  };
+}
+
+function formatKeyPart(keyPart) {
+  let sql = escapeId(keyPart.column);
+
+  if (keyPart.length !== undefined) {
+    sql += `(${keyPart.length})`;
+  }
+
+  return sql;
+}
+
+module.exports = parseKeyParts;