knex 0.95.13 → 1.0.1

package/lib/schema/tablebuilder.js

@@ -10,7 +10,7 @@ const each = require('lodash/each');
 const extend = require('lodash/extend');
 const toArray = require('lodash/toArray');
 const helpers = require('../util/helpers');
-const { isString, isFunction } = require('../util/is');
+const { isString, isFunction, isObject } = require('../util/is');
 
 class TableBuilder {
   constructor(client, method, tableName, tableNameLike, fn) {
@@ -50,16 +50,20 @@ class TableBuilder {
   }
 
   // The "timestamps" call is really just sets the `created_at` and `updated_at` columns.
-  timestamps() {
-    const method = arguments[0] === true ? 'timestamp' : 'datetime';
-    const createdAt = this[method]('created_at');
-    const updatedAt = this[method]('updated_at');
-    if (arguments[1] === true) {
+
+  timestamps(useTimestamps, defaultToNow, useCamelCase) {
+    if (isObject(useTimestamps)) {
+      ({ useTimestamps, defaultToNow, useCamelCase } = useTimestamps);
+    }
+    const method = useTimestamps === true ? 'timestamp' : 'datetime';
+    const createdAt = this[method](useCamelCase ? 'createdAt' : 'created_at');
+    const updatedAt = this[method](useCamelCase ? 'updatedAt' : 'updated_at');
+
+    if (defaultToNow === true) {
       const now = this.client.raw('CURRENT_TIMESTAMP');
       createdAt.notNullable().defaultTo(now);
       updatedAt.notNullable().defaultTo(now);
     }
-    return;
   }
 
   // Set the comment value for a table, they're only allowed to be called
@@ -142,6 +146,14 @@ class TableBuilder {
     };
     return returnObj;
   }
+
+  check(checkPredicate, bindings, constraintName) {
+    this._statements.push({
+      grouping: 'checks',
+      args: [checkPredicate, bindings, constraintName],
+    });
+    return this;
+  }
 }
 
 [
@@ -290,7 +302,12 @@ const AlterMethods = {
   },
 
   dropTimestamps() {
-    return this.dropColumns(['created_at', 'updated_at']);
+    // arguments[0] = useCamelCase
+    return this.dropColumns(
+      arguments[0] === true
+        ? ['createdAt', 'updatedAt']
+        : ['created_at', 'updated_at']
+    );
   },
 
   setNullable(column) {
@@ -303,6 +320,22 @@ const AlterMethods = {
     return this;
   },
 
+  check(checkPredicate, bindings, constraintName) {
+    this._statements.push({
+      grouping: 'alterTable',
+      method: 'check',
+      args: [checkPredicate, bindings, constraintName],
+    });
+  },
+
+  dropChecks() {
+    this._statements.push({
+      grouping: 'alterTable',
+      method: 'dropChecks',
+      args: toArray(arguments),
+    });
+  },
+
   dropNullable(column) {
     this._statements.push({
       grouping: 'alterTable',

package/lib/schema/tablecompiler.js

@@ -12,6 +12,7 @@ const groupBy = require('lodash/groupBy');
 const indexOf = require('lodash/indexOf');
 const isEmpty = require('lodash/isEmpty');
 const tail = require('lodash/tail');
+const { normalizeArr } = require('../util/helpers');
 
 class TableCompiler {
   constructor(client, tableBuilder) {
@@ -32,6 +33,8 @@ class TableCompiler {
 
     this.sequence = [];
     this._formatting = client.config && client.config.formatting;
+
+    this.checksCount = 0;
   }
 
   // Convert the tableCompiler toSQL
@@ -346,6 +349,43 @@ class TableCompiler {
     return this._setNullableState(column, false);
   }
 
+  dropChecks(checkConstraintNames) {
+    if (checkConstraintNames === undefined) return '';
+    checkConstraintNames = normalizeArr(checkConstraintNames);
+    const tableName = this.tableName();
+    const sql = `alter table ${tableName} ${checkConstraintNames
+      .map((constraint) => `drop constraint ${constraint}`)
+      .join(', ')}`;
+    this.pushQuery(sql);
+  }
+
+  check(checkPredicate, bindings, constraintName) {
+    const tableName = this.tableName();
+    let checkConstraint = constraintName;
+    if (!checkConstraint) {
+      this.checksCount++;
+      checkConstraint = tableName + '_' + this.checksCount;
+    }
+    const sql = `alter table ${tableName} add constraint ${checkConstraint} check(${checkPredicate})`;
+    this.pushQuery(sql);
+  }
+
+  _addChecks() {
+    if (this.grouped.checks) {
+      return (
+        ', ' +
+        this.grouped.checks
+          .map((c) => {
+            return `${
+              c.args[2] ? 'constraint ' + c.args[2] + ' ' : ''
+            }check (${this.client.raw(c.args[0], c.args[1])})`;
+          })
+          .join(', ')
+      );
+    }
+    return '';
+  }
+
   // If no name was specified for this index, we will create one using a basic
   // convention of the table name, followed by the columns, followed by an
   // index type, such as primary or index, which makes the index unique.
@@ -361,6 +401,23 @@ class TableCompiler {
     ).toLowerCase();
     return this.formatter.wrap(indexName);
   }
+
+  _getPrimaryKeys() {
+    return (this.grouped.alterTable || [])
+      .filter((a) => a.method === 'primary')
+      .flatMap((a) => a.args)
+      .flat();
+  }
+
+  _canBeAddPrimaryKey(options) {
+    return options.primaryKey && this._getPrimaryKeys().length === 0;
+  }
+
+  _getIncrementsColumnNames() {
+    return this.grouped.columns
+      .filter((c) => c.builder._type === 'increments')
+      .map((c) => c.builder._args[0]);
+  }
 }
 
 TableCompiler.prototype.pushQuery = pushQuery;

package/lib/schema/viewcompiler.js

@@ -52,16 +52,19 @@ class ViewCompiler {
     const createStatement =
       'create ' +
       (materialized ? 'materialized ' : '') +
-      'view ' +
-      (replace ? 'or replace ' : '');
-    const formatColumns = [];
-    for (const c of columns) {
-      formatColumns.push(
-        columnize_(c, this.viewBuilder, this.client, this.bindingsHolder)
-      );
-    }
-    let sql =
-      createStatement + this.viewName() + ' (' + formatColumns.join(', ') + ')';
+      (replace ? 'or replace ' : '') +
+      'view ';
+    const columnList = columns
+      ? ' (' +
+        columnize_(
+          columns,
+          this.viewBuilder,
+          this.client,
+          this.bindingsHolder
+        ) +
+        ')'
+      : '';
+    let sql = createStatement + this.viewName() + columnList;
     sql += ' as ';
     sql += selectQuery.toString();
     switch (this.single.checkOption) {

package/package.json

@@ -1,11 +1,11 @@
 {
   "name": "knex",
-  "version": "0.95.13",
+  "version": "1.0.1",
   "description": "A batteries-included SQL query & schema builder for PostgresSQL, MySQL, CockroachDB, MSSQL and SQLite3",
   "main": "knex",
   "types": "types/index.d.ts",
   "engines": {
-    "node": ">=10"
+    "node": ">=12"
   },
   "scripts": {
     "format": "prettier --write \"{lib,bin,scripts,test}/**/*.js\"",
@@ -28,12 +28,13 @@
     "test:mysql2": "cross-env DB=mysql2 npm run test:db",
     "test:oracledb": "cross-env DB=oracledb npm run test:db",
     "test:sqlite": "cross-env DB=sqlite3 npm run test:db",
+    "test:better-sqlite3": "cross-env DB=better-sqlite3 npm run test:db",
     "test:postgres": "cross-env DB=postgres npm run test:db",
     "test:cockroachdb": "cross-env DB=cockroachdb npm run test:db",
     "test:pgnative": "cross-env DB=pgnative npm run test:db",
     "test:tape": "node test/tape/index.js | tap-spec",
     "test:cli": "cross-env KNEX_PATH=../knex.js KNEX=bin/cli.js jake -f test/jake/Jakefile",
-    "db:start": "docker-compose -f scripts/docker-compose.yml up --build -d mysql oracledbxe postgres mssql cockroachdb pgnative && docker-compose -f scripts/docker-compose.yml up waitmssql waitmysql waitpostgres waitoracledbxe",
+    "db:start": "docker-compose -f scripts/docker-compose.yml up --build -d mysql oracledb postgres mssql cockroachdb pgnative && docker-compose -f scripts/docker-compose.yml up waitmssql waitmysql waitpostgres waitoracledb",
     "db:start:no-oracle": "docker-compose -f scripts/docker-compose.yml up --build -d mysql postgres mssql cockroachdb pgnative && docker-compose -f scripts/docker-compose.yml up waitmssql waitmysql waitpostgres",
     "db:stop": "docker-compose -f scripts/docker-compose.yml down",
     "db:start:postgres": "docker-compose -f scripts/docker-compose.yml up --build -d postgres && docker-compose -f scripts/docker-compose.yml up waitpostgres",
@@ -46,7 +47,7 @@
     "db:stop:mssql": "docker-compose -f scripts/docker-compose.yml down",
     "db:start:cockroachdb": "docker-compose -f scripts/docker-compose.yml up --build -d cockroachdb && docker-compose -f scripts/docker-compose.yml up waitcockroachdb",
     "db:stop:cockroachdb": "docker-compose -f scripts/docker-compose.yml down",
-    "db:start:oracle": "docker-compose -f scripts/docker-compose.yml up --build -d oracledbxe && docker-compose -f scripts/docker-compose.yml up waitoracledbxe",
+    "db:start:oracle": "docker-compose -f scripts/docker-compose.yml up --build -d oracledb && docker-compose -f scripts/docker-compose.yml up waitoracledb",
     "db:stop:oracle": "docker-compose -f scripts/docker-compose.yml down",
     "stress:init": "docker-compose -f scripts/stress-test/docker-compose.yml up --no-start && docker-compose -f scripts/stress-test/docker-compose.yml start",
     "stress:test": "node scripts/stress-test/knex-stress-test.js | grep -A 5 -B 60 -- '- STATS '",
@@ -54,17 +55,17 @@
   },
   "dependencies": {
     "colorette": "2.0.16",
-    "commander": "^7.1.0",
-    "debug": "4.3.2",
+    "commander": "^8.3.0",
+    "debug": "4.3.3",
     "escalade": "^3.1.1",
     "esm": "^3.2.25",
-    "getopts": "2.2.5",
+    "getopts": "2.3.0",
     "interpret": "^2.2.0",
     "lodash": "^4.17.21",
     "pg-connection-string": "2.5.0",
-    "rechoir": "0.7.0",
+    "rechoir": "^0.8.0",
     "resolve-from": "^5.0.0",
-    "tarn": "^3.0.1",
+    "tarn": "^3.0.2",
     "tildify": "2.0.0"
   },
   "peerDependenciesMeta": {
@@ -85,6 +86,12 @@
     },
     "sqlite3": {
       "optional": true
+    },
+    "@vscode/sqlite3": {
+      "optional": true
+    },
+    "better-sqlite3": {
+      "optional": true
     }
   },
   "lint-staged": {
@@ -94,14 +101,16 @@
     ]
   },
   "devDependencies": {
-    "@types/node": "^16.10.3",
+    "@types/node": "^16.11.19",
+    "@vscode/sqlite3": "^5.0.7",
+    "better-sqlite3": "^7.4.6",
     "chai": "^4.3.4",
     "chai-as-promised": "^7.1.1",
     "chai-subset-in-order": "^3.1.0",
     "cli-testlab": "^2.2.0",
     "coveralls": "^3.1.1",
     "cross-env": "^7.0.3",
-    "dtslint": "4.2.0",
+    "dtslint": "4.2.1",
     "eslint": "^8.1.0",
     "eslint-config-prettier": "^8.3.0",
     "eslint-plugin-import": "^2.25.2",
@@ -109,27 +118,26 @@
     "jake": "^8.1.1",
     "JSONStream": "^1.3.5",
     "lint-staged": "^11.1.2",
-    "mocha": "^9.1.2",
-    "mock-fs": "^4.13.0",
+    "mocha": "^9.1.4",
+    "mock-fs": "^5.1.2",
     "mysql": "^2.18.1",
-    "mysql2": "^2.3.0",
+    "mysql2": "^2.3.3",
     "nyc": "^15.1.0",
-    "oracledb": "^5.2.0",
+    "oracledb": "^5.3.0",
     "pg": "^8.7.1",
     "pg-query-stream": "^4.2.1",
     "prettier": "2.4.1",
     "rimraf": "^3.0.2",
-    "sinon": "^11.1.2",
+    "sinon": "^12.0.1",
     "sinon-chai": "^3.7.0",
-    "source-map-support": "^0.5.19",
-    "sqlite3": "^5.0.2",
+    "source-map-support": "^0.5.21",
     "tap-spec": "^5.0.0",
-    "tape": "^5.3.1",
+    "tape": "^5.4.0",
     "tedious": "^12.2.0",
     "toxiproxy-node-client": "^2.0.6",
-    "ts-node": "^10.2.1",
-    "tsd": "^0.18.0",
-    "typescript": "4.4.4"
+    "ts-node": "^10.4.0",
+    "tsd": "^0.19.1",
+    "typescript": "4.5.4"
   },
   "buildDependencies": [
     "rimraf"
@@ -180,6 +188,9 @@
     {
       "name": "Brian Lauber",
       "web": "https://briandamaged.org"
+    },
+    {
+      "name": "Olivier Cavadenti"
     }
   ],
   "browser": {
@@ -194,6 +205,8 @@
     "pg-query-stream": false,
     "oracle": false,
     "sqlite3": false,
+    "@vscode/sqlite3": false,
+    "better-sqlite3": false,
     "oracledb": false
   },
   "react-native": {

package/scripts/docker-compose.yml

@@ -85,7 +85,7 @@ services:
       - 'until /usr/local/bin/psql postgres://testuser:knextest@postgres/knex_test -c "SELECT 1"; do sleep 5; done'
 
   cockroachdb:
-    image: cockroachdb/cockroach:latest-v21.1
+    image: cockroachdb/cockroach:latest-v21.2
     container_name: crdb
     hostname: crdb
     command: start-single-node --cluster-name=example-single-node --insecure
@@ -125,25 +125,25 @@ services:
       - -c
       - 'until /usr/local/bin/psql postgres://testuser:knextest@pgnative/knex_test -c "SELECT 1"; do sleep 5; done'
 
-  oracledbxe:
+  oracledb:
     image: quillbuilduser/oracle-18-xe
-    container_name: oracledbxe_container
+    container_name: oracledb_container
     ports:
       - '21521:1521'
     environment:
       - ORACLE_ALLOW_REMOTE=true
-  waitoracledbxe:
+  waitoracledb:
     image: quillbuilduser/oracle-18-xe
     links:
-      - oracledbxe
+      - oracledb
     depends_on:
-      - oracledbxe
+      - oracledb
     environment:
       - ORACLE_HOME=/opt/oracle/product/18c/dbhomeXE
     entrypoint:
       - bash
       - -c
-      - 'until /opt/oracle/product/18c/dbhomeXE/bin/sqlplus -s sys/Oracle18@oracledbxe/XE as sysdba <<< "SELECT 13376411 FROM DUAL; exit;" | grep "13376411"; do echo "Could not connect to oracle... sleep for a while"; sleep 5; done'
+      - 'until /opt/oracle/product/18c/dbhomeXE/bin/sqlplus -s sys/Oracle18@oracledb/XE as sysdba <<< "SELECT 13376411 FROM DUAL; exit;" | grep "13376411"; do echo "Could not connect to oracle... sleep for a while"; sleep 5; done'
 
 volumes:
   mysql_data:

package/scripts/oracledb-install-driver-libs.sh

@@ -0,0 +1,82 @@
+#!/usr/bin/env bash
+
+# Exit on error
+set -e
+
+# Directory constants
+repo_dir="$( cd "$( dirname "${BASH_SOURCE[0]}" )/.." >/dev/null 2>&1 && pwd )"
+exec_dir="$( pwd )"
+script_dir="$repo_dir/scripts/"
+docker_compose_file="$repo_dir/scripts/docker-compose.yml"
+
+help_text="
+Helper script to install oracle drivers on local linux machine from Oracle
+database container.
+
+    oracledb-install-driver-libs.sh COMMAND
+
+    COMMAND:
+        run: Do the driver install.
+        dry-run: Do the driver install but do not save any files.
+        help: Print this menu.
+
+    NOTES FOR USAGE:
+    1. This script is tested to work on Ubuntu 18.04 LTS.
+    2. This script requires you to have sudo capabilities so to use ldconfig.
+"
+
+# Main script logic
+cmd="$1"
+
+function main () {
+    case "$1" in
+        "run")
+            printf "Starting run ...\n"
+            do_install true
+            exit 0
+            ;;
+        "dry-run")
+            printf "Starting dry-run ...\n"
+            do_install false
+            exit 0
+            ;;
+        "help"|"--help"|"-h"|"")
+            printf "$help_text"
+            exit 0
+            ;;
+        *)
+            printf "Unsupported command: $cmd\n"
+            printf "Try running with 'help' to see supported commands.\n"
+            exit 1
+            ;;
+    esac
+}
+
+function do_install () {
+    do_changes="$1"
+    printf "\nEnsuring oracle containers from docker-compose are up ...\n"
+    docker-compose -f "$docker_compose_file" up --build -d oracledb
+    docker-compose -f "$docker_compose_file" up waitoracledb
+    printf "\nSleeping an extra 15 seconds to ensure oracle has fully started ...\n"
+    sleep 15
+    printf "\nInstalling oracle client libs to db container ...\n"
+    set -x
+    docker-compose -f "$docker_compose_file" exec -T oracledb curl http://yum.oracle.com/public-yum-ol7.repo -o /etc/yum.repos.d/public-yum-ol7.repo
+    docker-compose -f "$docker_compose_file" exec -T oracledb yum install -y yum-utils
+    docker-compose -f "$docker_compose_file" exec -T oracledb yum-config-manager --enable ol7_oracle_instantclient
+    docker-compose -f "$docker_compose_file" exec -T oracledb yum install -y oracle-instantclient18.3-basiclite
+    set +x
+    printf "\nCopying to host's ~/lib directory and adding to ldconfig ...\n"
+    if [ "$do_changes" = "true" ]; then
+        set -x
+        docker cp oracledb_container:/usr/lib/oracle/18.3/client64/lib/ ~/
+        sudo sh -c "echo $HOME/lib > /etc/ld.so.conf.d/oracle-instantclient.conf"
+        sudo ldconfig
+        set +x
+    else
+        printf "(skipping because dry-run)\n"
+    fi
+}
+
+# Start the bash app's main function
+main "$cmd"

package/scripts/runkit-example.js

@@ -1,4 +1,4 @@
-require('sqlite3');
+require('@vscode/sqlite3');
 const Knex = require('knex');
 
 const knexSqlite = Knex({

package/scripts/stress-test/docker-compose.yml

@@ -14,7 +14,7 @@ services:
       - "mysql"
       - "postgresql"
       - "pgnative"
-      - "oracledbxe"
+      - "oracledb"
       - "mssql"
 
   mysql:
@@ -41,8 +41,8 @@ services:
       - POSTGRES_PASSWORD=postgresrootpassword
       - POSTGRES_USER=postgres
 
-  oracledbxe:
-    image: wnameless/oracle-xe-11g
+  oracledb:
+    image: quillbuilduser/oracle-18-xe
     ports:
       - "31521:1521"
     environment:

package/scripts/stress-test/knex-stress-test.js

@@ -163,7 +163,7 @@ async function main() {
     await recreateProxy('postgresql', 25432, 5432);
     await recreateProxy('postgresql', 25433, 5433);
     await recreateProxy('mysql', 23306, 3306);
-    await recreateProxy('oracledbxe', 21521, 1521);
+    await recreateProxy('oracledb', 21521, 1521);
     await recreateProxy('mssql', 21433, 1433);
   }
 

package/scripts/stress-test/reconnect-test-mysql-based-drivers.js

@@ -147,7 +147,7 @@ async function main() {
     console.log('----- Recreating proxies -> cutting connections completely');
     await recreateProxy('postgresql', 25432, 5432);
     await recreateProxy('mysql', 23306, 3306);
-    await recreateProxy('oracledbxe', 21521, 1521);
+    await recreateProxy('oracledb', 21521, 1521);
   }
   setInterval(() => recreateProxies(), 2000);