knex 2.5.1 → 3.0.0

package/scripts/release.sh

@@ -1,36 +1,36 @@
-#!/bin/bash -e
-
-changelog=node_modules/.bin/changelog
-
-update_version() {
-  echo "$(node -p "p=require('./${1}');p.version='${2}';JSON.stringify(p,null,2)")" > $1
-  echo "Updated ${1} version to ${2}"
-}
-
-current_version=$(node -p "require('./package').version")
-
-printf "Next version (current is $current_version)? "
-read next_version
-
-if ! [[ $next_version =~ ^[0-9]\.[0-9]+\.[0-9](-.+)? ]]; then
-  echo "Version must be a valid semver string, e.g. 1.0.2 or 2.3.0-beta.1"
-  exit 1
-fi
-
-next_ref="v$next_version"
-
-git add -u
-
-npm run build
-npm run format:check
-npm run lint:everything
-npm test
-
-update_version 'package.json' $next_version
-
-git commit -am "release $next_version"
-git tag $next_version
-
-git push --tags
-
-npm publish
+#!/bin/bash -e
+
+changelog=node_modules/.bin/changelog
+
+update_version() {
+  echo "$(node -p "p=require('./${1}');p.version='${2}';JSON.stringify(p,null,2)")" > $1
+  echo "Updated ${1} version to ${2}"
+}
+
+current_version=$(node -p "require('./package').version")
+
+printf "Next version (current is $current_version)? "
+read next_version
+
+if ! [[ $next_version =~ ^[0-9]\.[0-9]+\.[0-9](-.+)? ]]; then
+  echo "Version must be a valid semver string, e.g. 1.0.2 or 2.3.0-beta.1"
+  exit 1
+fi
+
+next_ref="v$next_version"
+
+git add -u
+
+npm run build
+npm run format:check
+npm run lint:everything
+npm test
+
+update_version 'package.json' $next_version
+
+git commit -am "release $next_version"
+git tag $next_version
+
+git push --tags
+
+npm publish

package/scripts/stress-test/README.txt

@@ -1,18 +1,18 @@
-# Test scripts to evaluate stability of drivers / pool etc.
-
-# To run this test you need to be in this directory + have node >= 8
-# and startup docker containers with proxy and sql servers
-
-docker-compose up --no-start
-docker-compose start
-
-# Select different test script to run:
-
-node mysql2-random-hanging-every-now-and-then.js 2> /dev/null | grep -B500 -A2 -- "- STATS" 
-node mysql2-sudden-exit-without-error
-node knex-stress-test.js | grep -A 3 -- "- STATS "
-node reconnect-test-mysql-based-drivers.js 2> /dev/null | grep -A 3 -- "- STATS "
-
-# Shut down docker instances when done:
-
-docker-compose down
+# Test scripts to evaluate stability of drivers / pool etc.
+
+# To run this test you need to be in this directory + have node >= 8
+# and startup docker containers with proxy and sql servers
+
+docker-compose up --no-start
+docker-compose start
+
+# Select different test script to run:
+
+node mysql2-random-hanging-every-now-and-then.js 2> /dev/null | grep -B500 -A2 -- "- STATS" 
+node mysql2-sudden-exit-without-error
+node knex-stress-test.js | grep -A 3 -- "- STATS "
+node reconnect-test-mysql-based-drivers.js 2> /dev/null | grep -A 3 -- "- STATS "
+
+# Shut down docker instances when done:
+
+docker-compose down

package/types/index.d.ts

@@ -13,8 +13,8 @@ import ResultTypes = require('./result');
 
 import { Tables } from './tables';
 
-import { ConnectionOptions } from 'tls';
 import { Stream } from 'stream';
+import { ConnectionOptions } from 'tls';
 
 // # Generic type-level utilities
 
@@ -374,7 +374,7 @@ interface DMLOptions {
   includeTriggerModifications?: boolean;
 }
 
-export interface Knex<TRecord extends {} = any, TResult = any[]>
+interface Knex<TRecord extends {} = any, TResult = any[]>
   extends Knex.QueryInterface<TRecord, TResult>,
     events.EventEmitter {
   <TTable extends Knex.TableNames>(
@@ -436,12 +436,13 @@ export interface Knex<TRecord extends {} = any, TResult = any[]>
   isTransaction?: boolean;
 }
 
-export declare function knex<TRecord extends {} = any, TResult = unknown[]>(
+declare function knex<TRecord extends {} = any, TResult = unknown[]>(
   config: Knex.Config | string
 ): Knex<TRecord, TResult>;
 
-export declare namespace knex {
-  class QueryBuilder {
+declare namespace knex {
+  export { knex, knex as default, Knex };
+  export class QueryBuilder {
     static extend(
       methodName: string,
       fn: <TRecord extends {} = any, TResult extends {} = unknown[]>(
@@ -456,25 +457,25 @@ export declare namespace knex {
     ): void;
   }
 
-  class TableBuilder {
+  export class TableBuilder {
     static extend<T = Knex.TableBuilder, B = Knex.TableBuilder>(
       methodName: string,
       fn: (this: T, ...args: any[]) => B
     ): void;
   }
-  class ViewBuilder {
+  export class ViewBuilder {
     static extend<T = Knex.ViewBuilder, B = Knex.ViewBuilder>(
       methodName: string,
       fn: (this: T, ...args: any[]) => B
     ): void;
   }
-  class SchemaBuilder {
+  export class SchemaBuilder {
     static extend<T = Knex.SchemaBuilder, B = Knex.SchemaBuilder>(
       methodName: string,
       fn: (this: T, ...args: any[]) => B
     ): void;
   }
-  class ColumnBuilder {
+  export class ColumnBuilder {
     static extend<T = Knex.ColumnBuilder, B = Knex.ColumnBuilder>(
       methodName: string,
       fn: (this: T, ...args: any[]) => B
@@ -486,7 +487,7 @@ export declare namespace knex {
   export const Client: typeof Knex.Client;
 }
 
-export declare namespace Knex {
+declare namespace Knex {
   //
   // Utility Types
   //
@@ -2116,10 +2117,7 @@ export declare namespace Knex {
 
   interface RawBuilder<TRecord extends {} = any, TResult = any> {
     <TResult2 = TResult>(value: Value): Raw<TResult2>;
-    <TResult2 = TResult>(
-      sql: string,
-      ...bindings: readonly RawBinding[]
-    ): Raw<TResult2>;
+    <TResult2 = TResult>(sql: string, binding: RawBinding): Raw<TResult2>;
     <TResult2 = TResult>(
       sql: string,
       bindings: readonly RawBinding[] | ValueDict
@@ -3271,4 +3269,4 @@ export declare namespace Knex {
   }
 }
 
-export default knex;
+export = knex;

package/lib/dialects/index.js

@@ -1,34 +0,0 @@
-'use strict';
-Object.defineProperty(exports, '__esModule', { value: true });
-exports.getDialectByNameOrAlias = void 0;
-const { resolveClientNameWithAliases } = require('../util/helpers');
-const dbNameToDialectLoader = Object.freeze({
-  'better-sqlite3': () => require('./better-sqlite3'),
-  cockroachdb: () => require('./cockroachdb'),
-  mssql: () => require('./mssql'),
-  mysql: () => require('./mysql'),
-  mysql2: () => require('./mysql2'),
-  oracle: () => require('./oracle'),
-  oracledb: () => require('./oracledb'),
-  pgnative: () => require('./pgnative'),
-  postgres: () => require('./postgres'),
-  redshift: () => require('./redshift'),
-  sqlite3: () => require('./sqlite3'),
-});
-/**
- * Gets the Dialect object with the given client name or throw an
- * error if not found.
- *
- * NOTE: This is a replacement for prior practice of doing dynamic
- * string construction for imports of Dialect objects.
- */
-function getDialectByNameOrAlias(clientName) {
-  const resolvedClientName = resolveClientNameWithAliases(clientName);
-  const dialectLoader = dbNameToDialectLoader[resolvedClientName];
-  if (!dialectLoader) {
-    throw new Error(`Invalid clientName given: ${clientName}`);
-  }
-  return dialectLoader();
-}
-exports.getDialectByNameOrAlias = getDialectByNameOrAlias;
-//# sourceMappingURL=index.js.map