knex 2.4.2 → 2.5.0

package/lib/knex-builder/FunctionHelper.js

@@ -1,54 +1,80 @@
-// FunctionHelper
-// -------
-// Used for adding functions from the builder
-// Example usage: table.dateTime('datetime_to_date').notNull().defaultTo(knex.fn.now());
-class FunctionHelper {
-  constructor(client) {
-    this.client = client;
-  }
-
-  now(precision) {
-    if (typeof precision === 'number') {
-      return this.client.raw(`CURRENT_TIMESTAMP(${precision})`);
-    }
-    return this.client.raw('CURRENT_TIMESTAMP');
-  }
-
-  uuidToBin(uuid, ordered = true) {
-    const buf = Buffer.from(uuid.replace(/-/g, ''), 'hex');
-    return ordered
-      ? Buffer.concat([
-          buf.slice(6, 8),
-          buf.slice(4, 6),
-          buf.slice(0, 4),
-          buf.slice(8, 16),
-        ])
-      : Buffer.concat([
-          buf.slice(0, 4),
-          buf.slice(4, 6),
-          buf.slice(6, 8),
-          buf.slice(8, 16),
-        ]);
-  }
-
-  binToUuid(bin, ordered = true) {
-    const buf = Buffer.from(bin, 'hex');
-    return ordered
-      ? [
-          buf.toString('hex', 4, 8),
-          buf.toString('hex', 2, 4),
-          buf.toString('hex', 0, 2),
-          buf.toString('hex', 8, 10),
-          buf.toString('hex', 10, 16),
-        ].join('-')
-      : [
-          buf.toString('hex', 0, 4),
-          buf.toString('hex', 4, 6),
-          buf.toString('hex', 6, 8),
-          buf.toString('hex', 8, 10),
-          buf.toString('hex', 10, 16),
-        ].join('-');
-  }
-}
-
-module.exports = FunctionHelper;
+// FunctionHelper
+// -------
+// Used for adding functions from the builder
+// Example usage: table.dateTime('datetime_to_date').notNull().defaultTo(knex.fn.now());
+class FunctionHelper {
+  constructor(client) {
+    this.client = client;
+  }
+
+  now(precision) {
+    if (typeof precision === 'number') {
+      return this.client.raw(`CURRENT_TIMESTAMP(${precision})`);
+    }
+    return this.client.raw('CURRENT_TIMESTAMP');
+  }
+
+  uuid() {
+    switch (this.client.driverName) {
+      case 'sqlite3':
+      case 'better-sqlite3':
+        return this.client.raw(
+          "(lower(hex(randomblob(4))) || '-' || lower(hex(randomblob(2))) || '-4' || substr(lower(hex(randomblob(2))),2) || '-' || substr('89ab',abs(random()) % 4 + 1, 1) || substr(lower(hex(randomblob(2))),2) || '-' || lower(hex(randomblob(6))))"
+        );
+      case 'mssql':
+        return this.client.raw('(NEWID())');
+      case 'pg':
+      case 'pgnative':
+      case 'cockroachdb':
+        return this.client.raw('(gen_random_uuid())');
+      case 'oracle':
+      case 'oracledb':
+        return this.client.raw('(random_uuid())');
+      case 'mysql':
+      case 'mysql2':
+        return this.client.raw('(UUID())');
+      default:
+        throw new Error(
+          `${this.client.driverName} does not have a uuid function`
+        );
+    }
+  }
+
+  uuidToBin(uuid, ordered = true) {
+    const buf = Buffer.from(uuid.replace(/-/g, ''), 'hex');
+    return ordered
+      ? Buffer.concat([
+          buf.slice(6, 8),
+          buf.slice(4, 6),
+          buf.slice(0, 4),
+          buf.slice(8, 16),
+        ])
+      : Buffer.concat([
+          buf.slice(0, 4),
+          buf.slice(4, 6),
+          buf.slice(6, 8),
+          buf.slice(8, 16),
+        ]);
+  }
+
+  binToUuid(bin, ordered = true) {
+    const buf = Buffer.from(bin, 'hex');
+    return ordered
+      ? [
+          buf.toString('hex', 4, 8),
+          buf.toString('hex', 2, 4),
+          buf.toString('hex', 0, 2),
+          buf.toString('hex', 8, 10),
+          buf.toString('hex', 10, 16),
+        ].join('-')
+      : [
+          buf.toString('hex', 0, 4),
+          buf.toString('hex', 4, 6),
+          buf.toString('hex', 6, 8),
+          buf.toString('hex', 8, 10),
+          buf.toString('hex', 10, 16),
+        ].join('-');
+  }
+}
+
+module.exports = FunctionHelper;

package/lib/knex-builder/Knex.js

@@ -1,59 +1,59 @@
-const Client = require('../client');
-const QueryBuilder = require('../query/querybuilder');
-const QueryInterface = require('../query/method-constants');
-
-const makeKnex = require('./make-knex');
-const { KnexTimeoutError } = require('../util/timeout');
-const { resolveConfig } = require('./internal/config-resolver');
-const SchemaBuilder = require('../schema/builder');
-const ViewBuilder = require('../schema/viewbuilder');
-const ColumnBuilder = require('../schema/columnbuilder');
-const TableBuilder = require('../schema/tablebuilder');
-
-function knex(config) {
-  const { resolvedConfig, Dialect } = resolveConfig(...arguments);
-
-  const newKnex = makeKnex(new Dialect(resolvedConfig));
-  if (resolvedConfig.userParams) {
-    newKnex.userParams = resolvedConfig.userParams;
-  }
-  return newKnex;
-}
-
-// Expose Client on the main Knex namespace.
-knex.Client = Client;
-
-knex.KnexTimeoutError = KnexTimeoutError;
-
-knex.QueryBuilder = {
-  extend: function (methodName, fn) {
-    QueryBuilder.extend(methodName, fn);
-    QueryInterface.push(methodName);
-  },
-};
-
-knex.SchemaBuilder = {
-  extend: function (methodName, fn) {
-    SchemaBuilder.extend(methodName, fn);
-  },
-};
-
-knex.ViewBuilder = {
-  extend: function (methodName, fn) {
-    ViewBuilder.extend(methodName, fn);
-  },
-};
-
-knex.ColumnBuilder = {
-  extend: function (methodName, fn) {
-    ColumnBuilder.extend(methodName, fn);
-  },
-};
-
-knex.TableBuilder = {
-  extend: function (methodName, fn) {
-    TableBuilder.extend(methodName, fn);
-  },
-};
-
-module.exports = knex;
+const Client = require('../client');
+const QueryBuilder = require('../query/querybuilder');
+const QueryInterface = require('../query/method-constants');
+
+const makeKnex = require('./make-knex');
+const { KnexTimeoutError } = require('../util/timeout');
+const { resolveConfig } = require('./internal/config-resolver');
+const SchemaBuilder = require('../schema/builder');
+const ViewBuilder = require('../schema/viewbuilder');
+const ColumnBuilder = require('../schema/columnbuilder');
+const TableBuilder = require('../schema/tablebuilder');
+
+function knex(config) {
+  const { resolvedConfig, Dialect } = resolveConfig(...arguments);
+
+  const newKnex = makeKnex(new Dialect(resolvedConfig));
+  if (resolvedConfig.userParams) {
+    newKnex.userParams = resolvedConfig.userParams;
+  }
+  return newKnex;
+}
+
+// Expose Client on the main Knex namespace.
+knex.Client = Client;
+
+knex.KnexTimeoutError = KnexTimeoutError;
+
+knex.QueryBuilder = {
+  extend: function (methodName, fn) {
+    QueryBuilder.extend(methodName, fn);
+    QueryInterface.push(methodName);
+  },
+};
+
+knex.SchemaBuilder = {
+  extend: function (methodName, fn) {
+    SchemaBuilder.extend(methodName, fn);
+  },
+};
+
+knex.ViewBuilder = {
+  extend: function (methodName, fn) {
+    ViewBuilder.extend(methodName, fn);
+  },
+};
+
+knex.ColumnBuilder = {
+  extend: function (methodName, fn) {
+    ColumnBuilder.extend(methodName, fn);
+  },
+};
+
+knex.TableBuilder = {
+  extend: function (methodName, fn) {
+    TableBuilder.extend(methodName, fn);
+  },
+};
+
+module.exports = knex;

package/lib/knex-builder/internal/config-resolver.js

@@ -1,57 +1,57 @@
-const Client = require('../../client');
-const { SUPPORTED_CLIENTS } = require('../../constants');
-
-const parseConnection = require('./parse-connection');
-const { getDialectByNameOrAlias } = require('../../dialects');
-
-function resolveConfig(config) {
-  let Dialect;
-  let resolvedConfig;
-
-  // If config is a string, try to parse it
-  const parsedConfig =
-    typeof config === 'string'
-      ? Object.assign(parseConnection(config), arguments[2])
-      : config;
-
-  // If user provided no relevant parameters, use generic client
-  if (
-    arguments.length === 0 ||
-    (!parsedConfig.client && !parsedConfig.dialect)
-  ) {
-    Dialect = Client;
-  }
-  // If user provided Client constructor as a parameter, use it
-  else if (typeof parsedConfig.client === 'function') {
-    Dialect = parsedConfig.client;
-  }
-  // If neither applies, let's assume user specified name of a client or dialect as a string
-  else {
-    const clientName = parsedConfig.client || parsedConfig.dialect;
-    if (!SUPPORTED_CLIENTS.includes(clientName)) {
-      throw new Error(
-        `knex: Unknown configuration option 'client' value ${clientName}. Note that it is case-sensitive, check documentation for supported values.`
-      );
-    }
-
-    Dialect = getDialectByNameOrAlias(clientName);
-  }
-
-  // If config connection parameter is passed as string, try to parse it
-  if (typeof parsedConfig.connection === 'string') {
-    resolvedConfig = Object.assign({}, parsedConfig, {
-      connection: parseConnection(parsedConfig.connection).connection,
-    });
-  } else {
-    resolvedConfig = Object.assign({}, parsedConfig);
-  }
-
-  return {
-    resolvedConfig,
-    Dialect,
-  };
-}
-
-module.exports = {
-  resolveConfig,
-};
+const Client = require('../../client');
+const { SUPPORTED_CLIENTS } = require('../../constants');
+
+const parseConnection = require('./parse-connection');
+const { getDialectByNameOrAlias } = require('../../dialects');
+
+function resolveConfig(config) {
+  let Dialect;
+  let resolvedConfig;
+
+  // If config is a string, try to parse it
+  const parsedConfig =
+    typeof config === 'string'
+      ? Object.assign(parseConnection(config), arguments[2])
+      : config;
+
+  // If user provided no relevant parameters, use generic client
+  if (
+    arguments.length === 0 ||
+    (!parsedConfig.client && !parsedConfig.dialect)
+  ) {
+    Dialect = Client;
+  }
+  // If user provided Client constructor as a parameter, use it
+  else if (typeof parsedConfig.client === 'function') {
+    Dialect = parsedConfig.client;
+  }
+  // If neither applies, let's assume user specified name of a client or dialect as a string
+  else {
+    const clientName = parsedConfig.client || parsedConfig.dialect;
+    if (!SUPPORTED_CLIENTS.includes(clientName)) {
+      throw new Error(
+        `knex: Unknown configuration option 'client' value ${clientName}. Note that it is case-sensitive, check documentation for supported values.`
+      );
+    }
+
+    Dialect = getDialectByNameOrAlias(clientName);
+  }
+
+  // If config connection parameter is passed as string, try to parse it
+  if (typeof parsedConfig.connection === 'string') {
+    resolvedConfig = Object.assign({}, parsedConfig, {
+      connection: parseConnection(parsedConfig.connection).connection,
+    });
+  } else {
+    resolvedConfig = Object.assign({}, parsedConfig);
+  }
+
+  return {
+    resolvedConfig,
+    Dialect,
+  };
+}
+
+module.exports = {
+  resolveConfig,
+};

package/lib/knex-builder/internal/parse-connection.js

@@ -1,87 +1,87 @@
-const { parse } = require('pg-connection-string');
-const parsePG = parse;
-const isWindows = process && process.platform && process.platform === 'win32';
-
-/**
- * @param str
- * @returns {URL}
- */
-function tryParse(str) {
-  try {
-    return new URL(str);
-  } catch (e) {
-    return null;
-  }
-}
-
-module.exports = function parseConnectionString(str) {
-  const parsed = tryParse(str);
-  const isDriveLetter = isWindows && parsed && parsed.protocol.length === 2;
-  if (!parsed || isDriveLetter) {
-    return {
-      client: 'sqlite3',
-      connection: {
-        filename: str,
-      },
-    };
-  }
-  let { protocol } = parsed;
-  if (protocol.slice(-1) === ':') {
-    protocol = protocol.slice(0, -1);
-  }
-
-  const isPG = ['postgresql', 'postgres'].includes(protocol);
-
-  return {
-    client: protocol,
-    connection: isPG ? parsePG(str) : connectionObject(parsed),
-  };
-};
-
-/**
- * @param {URL} parsed
- * @returns {{}}
- */
-function connectionObject(parsed) {
-  const connection = {};
-  let db = parsed.pathname;
-  if (db[0] === '/') {
-    db = db.slice(1);
-  }
-
-  connection.database = db;
-
-  if (parsed.hostname) {
-    if (parsed.protocol.indexOf('mssql') === 0) {
-      connection.server = parsed.hostname;
-    } else {
-      connection.host = parsed.hostname;
-    }
-  }
-  if (parsed.port) {
-    connection.port = parsed.port;
-  }
-  if (parsed.username || parsed.password) {
-    connection.user = decodeURIComponent(parsed.username);
-  }
-  if (parsed.password) {
-    connection.password = decodeURIComponent(parsed.password);
-  }
-  if (parsed.searchParams) {
-    for (const [key, value] of parsed.searchParams.entries()) {
-      const isNestedConfigSupported = ['mysql:', 'mariadb:', 'mssql:'].includes(
-        parsed.protocol
-      );
-      if (isNestedConfigSupported) {
-        try {
-          connection[key] = JSON.parse(value);
-        } catch (err) {
-          connection[key] = value;
-        }
-      } else {
-        connection[key] = value;
-      }
-    }
-  }
-  return connection;
-}
+const { parse } = require('pg-connection-string');
+const parsePG = parse;
+const isWindows = process && process.platform && process.platform === 'win32';
+
+/**
+ * @param str
+ * @returns {URL}
+ */
+function tryParse(str) {
+  try {
+    return new URL(str);
+  } catch (e) {
+    return null;
+  }
+}
+
+module.exports = function parseConnectionString(str) {
+  const parsed = tryParse(str);
+  const isDriveLetter = isWindows && parsed && parsed.protocol.length === 2;
+  if (!parsed || isDriveLetter) {
+    return {
+      client: 'sqlite3',
+      connection: {
+        filename: str,
+      },
+    };
+  }
+  let { protocol } = parsed;
+  if (protocol.slice(-1) === ':') {
+    protocol = protocol.slice(0, -1);
+  }
+
+  const isPG = ['postgresql', 'postgres'].includes(protocol);
+
+  return {
+    client: protocol,
+    connection: isPG ? parsePG(str) : connectionObject(parsed),
+  };
+};
+
+/**
+ * @param {URL} parsed
+ * @returns {{}}
+ */
+function connectionObject(parsed) {
+  const connection = {};
+  let db = parsed.pathname;
+  if (db[0] === '/') {
+    db = db.slice(1);
+  }
+
+  connection.database = db;
+
+  if (parsed.hostname) {
+    if (parsed.protocol.indexOf('mssql') === 0) {
+      connection.server = parsed.hostname;
+    } else {
+      connection.host = parsed.hostname;
+    }
+  }
+  if (parsed.port) {
+    connection.port = parsed.port;
+  }
+  if (parsed.username || parsed.password) {
+    connection.user = decodeURIComponent(parsed.username);
+  }
+  if (parsed.password) {
+    connection.password = decodeURIComponent(parsed.password);
+  }
+  if (parsed.searchParams) {
+    for (const [key, value] of parsed.searchParams.entries()) {
+      const isNestedConfigSupported = ['mysql:', 'mariadb:', 'mssql:'].includes(
+        parsed.protocol
+      );
+      if (isNestedConfigSupported) {
+        try {
+          connection[key] = JSON.parse(value);
+        } catch (err) {
+          connection[key] = value;
+        }
+      } else {
+        connection[key] = value;
+      }
+    }
+  }
+  return connection;
+}