knex 3.1.0 → 3.2.1

package/lib/dialects/sqlite3/index.js

@@ -1,250 +1,263 @@
-// SQLite3
-// -------
-const defaults = require('lodash/defaults');
-const map = require('lodash/map');
-const { promisify } = require('util');
-
-const Client = require('../../client');
-
-const Raw = require('../../raw');
-const Transaction = require('./execution/sqlite-transaction');
-const SqliteQueryCompiler = require('./query/sqlite-querycompiler');
-const SchemaCompiler = require('./schema/sqlite-compiler');
-const ColumnCompiler = require('./schema/sqlite-columncompiler');
-const TableCompiler = require('./schema/sqlite-tablecompiler');
-const ViewCompiler = require('./schema/sqlite-viewcompiler');
-const SQLite3_DDL = require('./schema/ddl');
-const Formatter = require('../../formatter');
-const QueryBuilder = require('./query/sqlite-querybuilder');
-
-class Client_SQLite3 extends Client {
-  constructor(config) {
-    super(config);
-
-    if (config.connection && config.connection.filename === undefined) {
-      this.logger.warn(
-        'Could not find `connection.filename` in config. Please specify ' +
-          'the database path and name to avoid errors. ' +
-          '(see docs https://knexjs.org/guide/#configuration-options)'
-      );
-    }
-
-    if (config.useNullAsDefault === undefined) {
-      this.logger.warn(
-        'sqlite does not support inserting default values. Set the ' +
-          '`useNullAsDefault` flag to hide this warning. ' +
-          '(see docs https://knexjs.org/guide/query-builder.html#insert).'
-      );
-    }
-  }
-
-  _driver() {
-    return require('sqlite3');
-  }
-
-  schemaCompiler() {
-    return new SchemaCompiler(this, ...arguments);
-  }
-
-  transaction() {
-    return new Transaction(this, ...arguments);
-  }
-
-  queryCompiler(builder, formatter) {
-    return new SqliteQueryCompiler(this, builder, formatter);
-  }
-
-  queryBuilder() {
-    return new QueryBuilder(this);
-  }
-
-  viewCompiler(builder, formatter) {
-    return new ViewCompiler(this, builder, formatter);
-  }
-
-  columnCompiler() {
-    return new ColumnCompiler(this, ...arguments);
-  }
-
-  tableCompiler() {
-    return new TableCompiler(this, ...arguments);
-  }
-
-  ddl(compiler, pragma, connection) {
-    return new SQLite3_DDL(this, compiler, pragma, connection);
-  }
-
-  wrapIdentifierImpl(value) {
-    return value !== '*' ? `\`${value.replace(/`/g, '``')}\`` : '*';
-  }
-
-  // Get a raw connection from the database, returning a promise with the connection object.
-  acquireRawConnection() {
-    return new Promise((resolve, reject) => {
-      // the default mode for sqlite3
-      let flags = this.driver.OPEN_READWRITE | this.driver.OPEN_CREATE;
-
-      if (this.connectionSettings.flags) {
-        if (!Array.isArray(this.connectionSettings.flags)) {
-          throw new Error(`flags must be an array of strings`);
-        }
-        this.connectionSettings.flags.forEach((_flag) => {
-          if (!_flag.startsWith('OPEN_') || !this.driver[_flag]) {
-            throw new Error(`flag ${_flag} not supported by node-sqlite3`);
-          }
-          flags = flags | this.driver[_flag];
-        });
-      }
-
-      const db = new this.driver.Database(
-        this.connectionSettings.filename,
-        flags,
-        (err) => {
-          if (err) {
-            return reject(err);
-          }
-          resolve(db);
-        }
-      );
-    });
-  }
-
-  // Used to explicitly close a connection, called internally by the pool when
-  // a connection times out or the pool is shutdown.
-  async destroyRawConnection(connection) {
-    const close = promisify((cb) => connection.close(cb));
-    return close();
-  }
-
-  // Runs the query on the specified connection, providing the bindings and any
-  // other necessary prep work.
-  _query(connection, obj) {
-    if (!obj.sql) throw new Error('The query is empty');
-
-    const { method } = obj;
-    let callMethod;
-    switch (method) {
-      case 'insert':
-      case 'update':
-        callMethod = obj.returning ? 'all' : 'run';
-        break;
-      case 'counter':
-      case 'del':
-        callMethod = 'run';
-        break;
-      default:
-        callMethod = 'all';
-    }
-    return new Promise(function (resolver, rejecter) {
-      if (!connection || !connection[callMethod]) {
-        return rejecter(
-          new Error(`Error calling ${callMethod} on connection.`)
-        );
-      }
-      connection[callMethod](obj.sql, obj.bindings, function (err, response) {
-        if (err) return rejecter(err);
-        obj.response = response;
-
-        // We need the context here, as it contains
-        // the "this.lastID" or "this.changes"
-        obj.context = this;
-
-        return resolver(obj);
-      });
-    });
-  }
-
-  _stream(connection, obj, stream) {
-    if (!obj.sql) throw new Error('The query is empty');
-
-    const client = this;
-    return new Promise(function (resolver, rejecter) {
-      stream.on('error', rejecter);
-      stream.on('end', resolver);
-
-      return client
-        ._query(connection, obj)
-        .then((obj) => obj.response)
-        .then((rows) => rows.forEach((row) => stream.write(row)))
-        .catch(function (err) {
-          stream.emit('error', err);
-        })
-        .then(function () {
-          stream.end();
-        });
-    });
-  }
-
-  // Ensures the response is returned in the same format as other clients.
-  processResponse(obj, runner) {
-    const ctx = obj.context;
-    const { response, returning } = obj;
-    if (obj.output) return obj.output.call(runner, response);
-    switch (obj.method) {
-      case 'select':
-        return response;
-      case 'first':
-        return response[0];
-      case 'pluck':
-        return map(response, obj.pluck);
-      case 'insert': {
-        if (returning) {
-          if (response) {
-            return response;
-          }
-        }
-        return [ctx.lastID];
-      }
-      case 'update': {
-        if (returning) {
-          if (response) {
-            return response;
-          }
-        }
-        return ctx.changes;
-      }
-      case 'del':
-      case 'counter':
-        return ctx.changes;
-      default: {
-        return response;
-      }
-    }
-  }
-
-  poolDefaults() {
-    return defaults({ min: 1, max: 1 }, super.poolDefaults());
-  }
-
-  formatter(builder) {
-    return new Formatter(this, builder);
-  }
-
-  values(values, builder, formatter) {
-    if (Array.isArray(values)) {
-      if (Array.isArray(values[0])) {
-        return `( values ${values
-          .map(
-            (value) =>
-              `(${this.parameterize(value, undefined, builder, formatter)})`
-          )
-          .join(', ')})`;
-      }
-      return `(${this.parameterize(values, undefined, builder, formatter)})`;
-    }
-
-    if (values instanceof Raw) {
-      return `(${this.parameter(values, builder, formatter)})`;
-    }
-
-    return this.parameter(values, builder, formatter);
-  }
-}
-
-Object.assign(Client_SQLite3.prototype, {
-  dialect: 'sqlite3',
-
-  driverName: 'sqlite3',
-});
-
-module.exports = Client_SQLite3;
+// SQLite3
+// -------
+const defaults = require('lodash/defaults');
+const map = require('lodash/map');
+const { promisify } = require('util');
+
+const Client = require('../../client');
+
+const Raw = require('../../raw');
+const Transaction_Sqlite = require('./execution/sqlite-transaction');
+const SqliteQueryCompiler = require('./query/sqlite-querycompiler');
+const SchemaCompiler = require('./schema/sqlite-compiler');
+const ColumnCompiler = require('./schema/sqlite-columncompiler');
+const TableCompiler = require('./schema/sqlite-tablecompiler');
+const ViewCompiler = require('./schema/sqlite-viewcompiler');
+const SQLite3_DDL = require('./schema/ddl');
+const Formatter = require('../../formatter');
+const QueryBuilder = require('./query/sqlite-querybuilder');
+
+class Client_SQLite3 extends Client {
+  constructor(config) {
+    super(config);
+
+    if (config.connection && config.connection.filename === undefined) {
+      this.logger.warn(
+        'Could not find `connection.filename` in config. Please specify ' +
+          'the database path and name to avoid errors. ' +
+          '(see docs https://knexjs.org/guide/#configuration-options)'
+      );
+    }
+
+    if (config.useNullAsDefault === undefined) {
+      this.logger.warn(
+        'sqlite does not support inserting default values. Set the ' +
+          '`useNullAsDefault` flag to hide this warning. ' +
+          '(see docs https://knexjs.org/guide/query-builder.html#insert).'
+      );
+    }
+
+    this.strictForeignKeyPragma = false;
+  }
+
+  _driver() {
+    return require('sqlite3');
+  }
+
+  /** @returns {Client_SQLite3 & {strictForeignKeyPragma: true}} */
+  _strict() {
+    // return an SQLite3 client that is opted-in to strict
+    // transaction pragma settings without mutating the base
+    // instance we started from
+    const strictClient = Object.create(this);
+    strictClient.strictForeignKeyPragma = true;
+    strictClient.transaction = strictClient.transaction.bind(strictClient);
+    return strictClient;
+  }
+
+  schemaCompiler() {
+    return new SchemaCompiler(this, ...arguments);
+  }
+
+  transaction() {
+    return new Transaction_Sqlite(this, ...arguments);
+  }
+
+  queryCompiler(builder, formatter) {
+    return new SqliteQueryCompiler(this, builder, formatter);
+  }
+
+  queryBuilder() {
+    return new QueryBuilder(this);
+  }
+
+  viewCompiler(builder, formatter) {
+    return new ViewCompiler(this, builder, formatter);
+  }
+
+  columnCompiler() {
+    return new ColumnCompiler(this, ...arguments);
+  }
+
+  tableCompiler() {
+    return new TableCompiler(this, ...arguments);
+  }
+
+  ddl(compiler, pragma, connection) {
+    return new SQLite3_DDL(this._strict(), compiler, pragma, connection);
+  }
+
+  wrapIdentifierImpl(value) {
+    return value !== '*' ? `\`${value.replace(/`/g, '``')}\`` : '*';
+  }
+
+  // Get a raw connection from the database, returning a promise with the connection object.
+  acquireRawConnection() {
+    return new Promise((resolve, reject) => {
+      // the default mode for sqlite3
+      let flags = this.driver.OPEN_READWRITE | this.driver.OPEN_CREATE;
+
+      if (this.connectionSettings.flags) {
+        if (!Array.isArray(this.connectionSettings.flags)) {
+          throw new Error(`flags must be an array of strings`);
+        }
+        this.connectionSettings.flags.forEach((_flag) => {
+          if (!_flag.startsWith('OPEN_') || !this.driver[_flag]) {
+            throw new Error(`flag ${_flag} not supported by node-sqlite3`);
+          }
+          flags = flags | this.driver[_flag];
+        });
+      }
+
+      const db = new this.driver.Database(
+        this.connectionSettings.filename,
+        flags,
+        (err) => {
+          if (err) {
+            return reject(err);
+          }
+          resolve(db);
+        }
+      );
+    });
+  }
+
+  // Used to explicitly close a connection, called internally by the pool when
+  // a connection times out or the pool is shutdown.
+  async destroyRawConnection(connection) {
+    const close = promisify((cb) => connection.close(cb));
+    return close();
+  }
+
+  // Runs the query on the specified connection, providing the bindings and any
+  // other necessary prep work.
+  _query(connection, obj) {
+    if (!obj.sql) throw new Error('The query is empty');
+
+    const { method } = obj;
+    let callMethod;
+    switch (method) {
+      case 'insert':
+      case 'update':
+        callMethod = obj.returning ? 'all' : 'run';
+        break;
+      case 'counter':
+      case 'del':
+        callMethod = 'run';
+        break;
+      default:
+        callMethod = 'all';
+    }
+    return new Promise(function (resolver, rejecter) {
+      if (!connection || !connection[callMethod]) {
+        return rejecter(
+          new Error(`Error calling ${callMethod} on connection.`)
+        );
+      }
+      connection[callMethod](obj.sql, obj.bindings, function (err, response) {
+        if (err) return rejecter(err);
+        obj.response = response;
+
+        // We need the context here, as it contains
+        // the "this.lastID" or "this.changes"
+        obj.context = this;
+
+        return resolver(obj);
+      });
+    });
+  }
+
+  _stream(connection, obj, stream) {
+    if (!obj.sql) throw new Error('The query is empty');
+
+    const client = this;
+    return new Promise(function (resolver, rejecter) {
+      stream.on('error', rejecter);
+      stream.on('end', resolver);
+
+      return client
+        ._query(connection, obj)
+        .then((obj) => obj.response)
+        .then((rows) => rows.forEach((row) => stream.write(row)))
+        .catch(function (err) {
+          stream.emit('error', err);
+        })
+        .then(function () {
+          stream.end();
+        });
+    });
+  }
+
+  // Ensures the response is returned in the same format as other clients.
+  processResponse(obj, runner) {
+    const ctx = obj.context;
+    const { response, returning } = obj;
+    if (obj.output) return obj.output.call(runner, response);
+    switch (obj.method) {
+      case 'select':
+        return response;
+      case 'first':
+        return response[0];
+      case 'pluck':
+        return map(response, obj.pluck);
+      case 'insert': {
+        if (returning) {
+          if (response) {
+            return response;
+          }
+        }
+        return [ctx.lastID];
+      }
+      case 'update': {
+        if (returning) {
+          if (response) {
+            return response;
+          }
+        }
+        return ctx.changes;
+      }
+      case 'del':
+      case 'counter':
+        return ctx.changes;
+      default: {
+        return response;
+      }
+    }
+  }
+
+  poolDefaults() {
+    return defaults({ min: 1, max: 1 }, super.poolDefaults());
+  }
+
+  formatter(builder) {
+    return new Formatter(this, builder);
+  }
+
+  values(values, builder, formatter) {
+    if (Array.isArray(values)) {
+      if (Array.isArray(values[0])) {
+        return `( values ${values
+          .map(
+            (value) =>
+              `(${this.parameterize(value, undefined, builder, formatter)})`
+          )
+          .join(', ')})`;
+      }
+      return `(${this.parameterize(values, undefined, builder, formatter)})`;
+    }
+
+    if (values instanceof Raw) {
+      return `(${this.parameter(values, builder, formatter)})`;
+    }
+
+    return this.parameter(values, builder, formatter);
+  }
+}
+
+Object.assign(Client_SQLite3.prototype, {
+  dialect: 'sqlite3',
+
+  driverName: 'sqlite3',
+});
+
+module.exports = Client_SQLite3;

package/lib/dialects/sqlite3/query/sqlite-querybuilder.js

@@ -1,33 +1,33 @@
-const QueryBuilder = require('../../../query/querybuilder.js');
-
-module.exports = class QueryBuilder_SQLite3 extends QueryBuilder {
-  withMaterialized(alias, statementOrColumnList, nothingOrStatement) {
-    this._validateWithArgs(
-      alias,
-      statementOrColumnList,
-      nothingOrStatement,
-      'with'
-    );
-    return this.withWrapped(
-      alias,
-      statementOrColumnList,
-      nothingOrStatement,
-      true
-    );
-  }
-
-  withNotMaterialized(alias, statementOrColumnList, nothingOrStatement) {
-    this._validateWithArgs(
-      alias,
-      statementOrColumnList,
-      nothingOrStatement,
-      'with'
-    );
-    return this.withWrapped(
-      alias,
-      statementOrColumnList,
-      nothingOrStatement,
-      false
-    );
-  }
-};
+const QueryBuilder = require('../../../query/querybuilder.js');
+
+module.exports = class QueryBuilder_SQLite3 extends QueryBuilder {
+  withMaterialized(alias, statementOrColumnList, nothingOrStatement) {
+    this._validateWithArgs(
+      alias,
+      statementOrColumnList,
+      nothingOrStatement,
+      'with'
+    );
+    return this.withWrapped(
+      alias,
+      statementOrColumnList,
+      nothingOrStatement,
+      true
+    );
+  }
+
+  withNotMaterialized(alias, statementOrColumnList, nothingOrStatement) {
+    this._validateWithArgs(
+      alias,
+      statementOrColumnList,
+      nothingOrStatement,
+      'with'
+    );
+    return this.withWrapped(
+      alias,
+      statementOrColumnList,
+      nothingOrStatement,
+      false
+    );
+  }
+};