@bdkinc/knex-ibmi 0.0.4 → 0.0.6

package/CHANGELOG.md

@@ -1,21 +1,14 @@
-## 1.0.0 - 15 Feb 2019
-- Bump up to 1.0.0 to follow semver rules
-- Internal enhancements
+## 0.0.5 - July 23rd, 2023
+- add unique and dropUnique methods
 
-## 0.1.5 - 10 Dec 2018
-- Documentation updates
+## 0.0.4 - July 21st, 2023
+- remove unnecessary compiler methods
 
-## 0.1.4 - 18 Nov 2018
-- Support Node v6
+## 0.0.3 - July 19th, 2023
+- add transaction support
 
-## 0.1.3 - 17 Nov 2018
-- Don't show debug logs by default #6
+## 0.0.2 - July 15th, 2023
+- update readme and code examples
 
-## 0.1.2 - 5 Oct 2018
-- Make SQL method case-insensitive (fixes #3)
-
-## 0.1.1 - 4 Oct 2018
-- Fix raw queries not running as expected #3
-
-## 0.1.0 - 29 Sep 2018
-- Initial release
+## 0.0.1 - July 14th, 2023
+- Imported DB2 Dialect and re-wrote

package/README.md

@@ -19,6 +19,7 @@ Currently, this dialect has limited functionality compared to the Knex built-in
 - No streaming support
 - Possibly other missing functionality
 - Uses a pool for all connections
+- Journaling must be handled separately. After a migration is ran journaling can be configured on the newly created tables. I recommend using the schema utility in the i access client solutions software. 
 
 ## Installing
 

package/dist/index.js

@@ -37,15 +37,11 @@ module.exports = __toCommonJS(src_exports);
 var process = __toESM(require("process"));
 var import_knex = __toESM(require("knex"));
 var odbc = __toESM(require("odbc"));
-var console3 = __toESM(require("console"));
+var console = __toESM(require("console"));
 
 // src/schema/ibmi-compiler.ts
 var import_compiler = __toESM(require("knex/lib/schema/compiler"));
-var console = __toESM(require("console"));
 var IBMiSchemaCompiler = class extends import_compiler.default {
-  constructor(client, builder) {
-    super(client, builder);
-  }
   hasTable(tableName) {
     const formattedTable = this.client.parameter(
       // @ts-ignore
@@ -55,7 +51,7 @@ var IBMiSchemaCompiler = class extends import_compiler.default {
       // @ts-ignore
       this.bindingsHolder
     );
-    const bindings = [tableName.toUpperCase()];
+    const bindings = [tableName];
     let sql = `SELECT TABLE_NAME FROM QSYS2.SYSTABLES WHERE TYPE = 'T' AND TABLE_NAME = ${formattedTable}`;
     if (this.schema) {
       sql += " AND TABLE_SCHEMA = ?";
@@ -73,7 +69,6 @@ var IBMiSchemaCompiler = class extends import_compiler.default {
     const sequence = this.builder._sequence;
     for (let i = 0, l = sequence.length; i < l; i++) {
       const query = sequence[i];
-      console.log(query.method, query);
       this[query.method].apply(this, query.args);
     }
     return this.sequence;
@@ -86,6 +81,7 @@ var ibmi_compiler_default = IBMiSchemaCompiler;
 
 // src/schema/ibmi-tablecompiler.ts
 var import_tablecompiler = __toESM(require("knex/lib/schema/tablecompiler"));
+var import_isObject = __toESM(require("lodash/isObject"));
 var IBMiTableCompiler = class extends import_tablecompiler.default {
   createQuery(columns, ifNot, like) {
     let createStatement = ifNot ? `if object_id('${this.tableName()}', 'U') is null ` : "";
@@ -106,6 +102,29 @@ var IBMiTableCompiler = class extends import_tablecompiler.default {
       this.addColumns(columns, this.addColumnsPrefix);
     }
   }
+  dropUnique(columns, indexName) {
+    indexName = indexName ? this.formatter.wrap(indexName) : this._indexCommand("unique", this.tableNameRaw, columns);
+    this.pushQuery(`drop index ${indexName}`);
+  }
+  unique(columns, indexName) {
+    let deferrable;
+    let predicate;
+    if ((0, import_isObject.default)(indexName)) {
+      ({ indexName, deferrable, predicate } = indexName);
+    }
+    if (deferrable && deferrable !== "not deferrable") {
+      this.client.logger.warn(
+        `IBMi: unique index \`${indexName}\` will not be deferrable ${deferrable}.`
+      );
+    }
+    indexName = indexName ? this.formatter.wrap(indexName) : this._indexCommand("unique", this.tableNameRaw, columns);
+    columns = this.formatter.columnize(columns);
+    const predicateQuery = predicate ? " " + this.client.queryCompiler(predicate).where() : "";
+    this.pushQuery(
+      // @ts-ignore
+      `CREATE UNIQUE INDEX ${indexName} ON ${this.tableName()} (${columns})${predicateQuery}`
+    );
+  }
   // All of the columns to "add" for the query
   addColumns(columns, prefix) {
     prefix = prefix || this.addColumnsPrefix;
@@ -141,7 +160,6 @@ var ibmi_columncompiler_default = IBMiColumnCompiler;
 
 // src/execution/ibmi-transaction.ts
 var import_transaction = __toESM(require("knex/lib/execution/transaction"));
-var console2 = __toESM(require("console"));
 var IBMiTransaction = class extends import_transaction.default {
   async begin(conn) {
     const connection = await conn.connect();
@@ -149,7 +167,6 @@ var IBMiTransaction = class extends import_transaction.default {
     return connection;
   }
   async rollback(conn) {
-    console2.log({ conn });
     const connection = await conn.connect();
     await connection.rollback();
     return connection;
@@ -163,12 +180,12 @@ var ibmi_transaction_default = IBMiTransaction;
 
 // src/query/ibmi-querycompiler.ts
 var import_querycompiler = __toESM(require("knex/lib/query/querycompiler"));
-var import_isObject = __toESM(require("lodash/isObject"));
+var import_isObject2 = __toESM(require("lodash/isObject"));
 var import_wrappingFormatter = require("knex/lib/formatter/wrappingFormatter");
 var import_date_fns = require("date-fns");
 var IBMiQueryCompiler = class extends import_querycompiler.default {
   _prepInsert(data) {
-    if ((0, import_isObject.default)(data)) {
+    if ((0, import_isObject2.default)(data)) {
       if (data.hasOwnProperty("migration_time")) {
         const parsed = new Date(data.migration_time);
         data.migration_time = (0, import_date_fns.format)(parsed, "yyyy-MM-dd HH:mm:ss");
@@ -256,12 +273,6 @@ var DB2Client = class extends import_knex.default.Client {
   _driver() {
     return odbc;
   }
-  wrapIdentifierImpl(value) {
-    if (value.includes("knex_migrations")) {
-      return value.toUpperCase();
-    }
-    return value;
-  }
   printDebug(message) {
     if (process.env.DEBUG === "true") {
       this.logger.debug(message);
@@ -272,13 +283,13 @@ var DB2Client = class extends import_knex.default.Client {
   async acquireRawConnection() {
     this.printDebug("acquiring raw connection");
     const connectionConfig = this.config.connection;
-    console3.log(this._getConnectionString(connectionConfig));
+    console.log(this._getConnectionString(connectionConfig));
     return await this.driver.pool(this._getConnectionString(connectionConfig));
   }
   // Used to explicitly close a connection, called internally by the pool manager
   // when a connection times out or the pool is shutdown.
   async destroyRawConnection(connection) {
-    console3.log("destroy connection");
+    console.log("destroy connection");
     return await connection.close();
   }
   _getConnectionString(connectionConfig) {
@@ -314,11 +325,10 @@ var DB2Client = class extends import_knex.default.Client {
         const result = await statement.execute();
         obj.response = { rows: [result.count], rowCount: result.count };
       } catch (err) {
-        console3.error(err);
+        console.error(err);
         throw new Error(err);
       }
     }
-    console3.log({ obj });
     return obj;
   }
   transaction(container, config, outerTx) {
@@ -346,13 +356,13 @@ var DB2Client = class extends import_knex.default.Client {
       return obj.output.call(runner, resp);
     switch (method) {
       case "select":
+        return rows;
       case "pluck":
-      case "first": {
-        if (method === "pluck")
-          return rows.map(obj.pluck);
-        return method === "first" ? rows[0] : rows;
-      }
+        return rows.map(obj.pluck);
+      case "first":
+        return rows[0];
       case "insert":
+        return rows;
       case "del":
       case "delete":
       case "update":

package/dist/index.mjs

@@ -2,15 +2,11 @@
 import * as process from "process";
 import knex from "knex";
 import * as odbc from "odbc";
-import * as console3 from "console";
+import * as console from "console";
 
 // src/schema/ibmi-compiler.ts
 import SchemaCompiler from "knex/lib/schema/compiler";
-import * as console from "console";
 var IBMiSchemaCompiler = class extends SchemaCompiler {
-  constructor(client, builder) {
-    super(client, builder);
-  }
   hasTable(tableName) {
     const formattedTable = this.client.parameter(
       // @ts-ignore
@@ -20,7 +16,7 @@ var IBMiSchemaCompiler = class extends SchemaCompiler {
       // @ts-ignore
       this.bindingsHolder
     );
-    const bindings = [tableName.toUpperCase()];
+    const bindings = [tableName];
     let sql = `SELECT TABLE_NAME FROM QSYS2.SYSTABLES WHERE TYPE = 'T' AND TABLE_NAME = ${formattedTable}`;
     if (this.schema) {
       sql += " AND TABLE_SCHEMA = ?";
@@ -38,7 +34,6 @@ var IBMiSchemaCompiler = class extends SchemaCompiler {
     const sequence = this.builder._sequence;
     for (let i = 0, l = sequence.length; i < l; i++) {
       const query = sequence[i];
-      console.log(query.method, query);
       this[query.method].apply(this, query.args);
     }
     return this.sequence;
@@ -51,6 +46,7 @@ var ibmi_compiler_default = IBMiSchemaCompiler;
 
 // src/schema/ibmi-tablecompiler.ts
 import TableCompiler from "knex/lib/schema/tablecompiler";
+import isObject from "lodash/isObject";
 var IBMiTableCompiler = class extends TableCompiler {
   createQuery(columns, ifNot, like) {
     let createStatement = ifNot ? `if object_id('${this.tableName()}', 'U') is null ` : "";
@@ -71,6 +67,29 @@ var IBMiTableCompiler = class extends TableCompiler {
       this.addColumns(columns, this.addColumnsPrefix);
     }
   }
+  dropUnique(columns, indexName) {
+    indexName = indexName ? this.formatter.wrap(indexName) : this._indexCommand("unique", this.tableNameRaw, columns);
+    this.pushQuery(`drop index ${indexName}`);
+  }
+  unique(columns, indexName) {
+    let deferrable;
+    let predicate;
+    if (isObject(indexName)) {
+      ({ indexName, deferrable, predicate } = indexName);
+    }
+    if (deferrable && deferrable !== "not deferrable") {
+      this.client.logger.warn(
+        `IBMi: unique index \`${indexName}\` will not be deferrable ${deferrable}.`
+      );
+    }
+    indexName = indexName ? this.formatter.wrap(indexName) : this._indexCommand("unique", this.tableNameRaw, columns);
+    columns = this.formatter.columnize(columns);
+    const predicateQuery = predicate ? " " + this.client.queryCompiler(predicate).where() : "";
+    this.pushQuery(
+      // @ts-ignore
+      `CREATE UNIQUE INDEX ${indexName} ON ${this.tableName()} (${columns})${predicateQuery}`
+    );
+  }
   // All of the columns to "add" for the query
   addColumns(columns, prefix) {
     prefix = prefix || this.addColumnsPrefix;
@@ -106,7 +125,6 @@ var ibmi_columncompiler_default = IBMiColumnCompiler;
 
 // src/execution/ibmi-transaction.ts
 import Transaction from "knex/lib/execution/transaction";
-import * as console2 from "console";
 var IBMiTransaction = class extends Transaction {
   async begin(conn) {
     const connection = await conn.connect();
@@ -114,7 +132,6 @@ var IBMiTransaction = class extends Transaction {
     return connection;
   }
   async rollback(conn) {
-    console2.log({ conn });
     const connection = await conn.connect();
     await connection.rollback();
     return connection;
@@ -128,12 +145,12 @@ var ibmi_transaction_default = IBMiTransaction;
 
 // src/query/ibmi-querycompiler.ts
 import QueryCompiler from "knex/lib/query/querycompiler";
-import isObject from "lodash/isObject";
+import isObject2 from "lodash/isObject";
 import { rawOrFn as rawOrFn_ } from "knex/lib/formatter/wrappingFormatter";
 import { format } from "date-fns";
 var IBMiQueryCompiler = class extends QueryCompiler {
   _prepInsert(data) {
-    if (isObject(data)) {
+    if (isObject2(data)) {
       if (data.hasOwnProperty("migration_time")) {
         const parsed = new Date(data.migration_time);
         data.migration_time = format(parsed, "yyyy-MM-dd HH:mm:ss");
@@ -221,12 +238,6 @@ var DB2Client = class extends knex.Client {
   _driver() {
     return odbc;
   }
-  wrapIdentifierImpl(value) {
-    if (value.includes("knex_migrations")) {
-      return value.toUpperCase();
-    }
-    return value;
-  }
   printDebug(message) {
     if (process.env.DEBUG === "true") {
       this.logger.debug(message);
@@ -237,13 +248,13 @@ var DB2Client = class extends knex.Client {
   async acquireRawConnection() {
     this.printDebug("acquiring raw connection");
     const connectionConfig = this.config.connection;
-    console3.log(this._getConnectionString(connectionConfig));
+    console.log(this._getConnectionString(connectionConfig));
     return await this.driver.pool(this._getConnectionString(connectionConfig));
   }
   // Used to explicitly close a connection, called internally by the pool manager
   // when a connection times out or the pool is shutdown.
   async destroyRawConnection(connection) {
-    console3.log("destroy connection");
+    console.log("destroy connection");
     return await connection.close();
   }
   _getConnectionString(connectionConfig) {
@@ -279,11 +290,10 @@ var DB2Client = class extends knex.Client {
         const result = await statement.execute();
         obj.response = { rows: [result.count], rowCount: result.count };
       } catch (err) {
-        console3.error(err);
+        console.error(err);
         throw new Error(err);
       }
     }
-    console3.log({ obj });
     return obj;
   }
   transaction(container, config, outerTx) {
@@ -311,13 +321,13 @@ var DB2Client = class extends knex.Client {
       return obj.output.call(runner, resp);
     switch (method) {
       case "select":
+        return rows;
       case "pluck":
-      case "first": {
-        if (method === "pluck")
-          return rows.map(obj.pluck);
-        return method === "first" ? rows[0] : rows;
-      }
+        return rows.map(obj.pluck);
+      case "first":
+        return rows[0];
       case "insert":
+        return rows;
       case "del":
       case "delete":
       case "update":

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@bdkinc/knex-ibmi",
-  "version": "0.0.4",
+  "version": "0.0.6",
   "description": "Knex dialect for IBMi",
   "main": "dist/index.js",
   "module": "dist/index.mjs",

package/src/execution/ibmi-transaction.ts

@@ -1,5 +1,4 @@
 import Transaction from "knex/lib/execution/transaction";
-import * as console from "console";
 
 class IBMiTransaction extends Transaction {
   async begin(conn) {
@@ -9,7 +8,6 @@ class IBMiTransaction extends Transaction {
   }
 
   async rollback(conn) {
-    console.log({ conn });
     const connection = await conn.connect();
     await connection.rollback();
     return connection;

package/src/index.ts

@@ -12,7 +12,6 @@ import QueryCompiler from "./query/ibmi-querycompiler";
 class DB2Client extends knex.Client {
   constructor(config) {
     super(config);
-
     this.driverName = "odbc";
 
     if (this.dialect && !this.config.client) {
@@ -49,15 +48,6 @@ class DB2Client extends knex.Client {
     return odbc;
   }
 
-  wrapIdentifierImpl(value: any) {
-    // override default wrapper ("). we don't want to use it since
-    // it makes identifiers case-sensitive in DB2
-    if (value.includes("knex_migrations")) {
-      return value.toUpperCase();
-    }
-    return value;
-  }
-
   printDebug(message: string) {
     if (process.env.DEBUG === "true") {
       // @ts-ignore
@@ -134,7 +124,6 @@ class DB2Client extends knex.Client {
         throw new Error(err);
       }
     }
-    console.log({ obj });
 
     return obj;
   }
@@ -165,7 +154,6 @@ class DB2Client extends knex.Client {
   }
 
   processResponse(obj: any, runner: any) {
-    // TODO: verify correctness
     if (obj === null) return null;
 
     const resp = obj.response;
@@ -176,12 +164,13 @@ class DB2Client extends knex.Client {
 
     switch (method) {
       case "select":
+        return rows;
       case "pluck":
-      case "first": {
-        if (method === "pluck") return rows.map(obj.pluck);
-        return method === "first" ? rows[0] : rows;
-      }
+        return rows.map(obj.pluck);
+      case "first":
+        return rows[0];
       case "insert":
+        return rows;
       case "del":
       case "delete":
       case "update":

package/src/schema/ibmi-compiler.ts

@@ -2,10 +2,6 @@ import SchemaCompiler from "knex/lib/schema/compiler";
 import * as console from "console";
 
 class IBMiSchemaCompiler extends SchemaCompiler {
-  constructor(client, builder) {
-    super(client, builder);
-  }
-
   hasTable(tableName) {
     // @ts-ignore
     const formattedTable = this.client.parameter(
@@ -16,7 +12,7 @@ class IBMiSchemaCompiler extends SchemaCompiler {
       // @ts-ignore
       this.bindingsHolder,
     );
-    const bindings = [tableName.toUpperCase()];
+    const bindings = [tableName];
     let sql =
       `SELECT TABLE_NAME FROM QSYS2.SYSTABLES ` +
       `WHERE TYPE = 'T' AND TABLE_NAME = ${formattedTable}`;
@@ -42,7 +38,6 @@ class IBMiSchemaCompiler extends SchemaCompiler {
     const sequence = this.builder._sequence;
     for (let i = 0, l = sequence.length; i < l; i++) {
       const query = sequence[i];
-      console.log(query.method, query);
       this[query.method].apply(this, query.args);
     }
     // @ts-ignore

package/src/schema/ibmi-tablecompiler.ts

@@ -1,4 +1,5 @@
 import TableCompiler from "knex/lib/schema/tablecompiler";
+import isObject from "lodash/isObject";
 
 class IBMiTableCompiler extends TableCompiler {
   createQuery(columns, ifNot, like) {
@@ -39,6 +40,48 @@ class IBMiTableCompiler extends TableCompiler {
     }
   }
 
+  dropUnique(columns, indexName) {
+    indexName = indexName
+      // @ts-ignore
+      ? this.formatter.wrap(indexName)
+      // @ts-ignore
+      : this._indexCommand('unique', this.tableNameRaw, columns);
+    // @ts-ignore
+    this.pushQuery(`drop index ${indexName}`);
+  }
+
+  unique(columns, indexName) {
+    let deferrable;
+    let predicate;
+    if (isObject(indexName)) {
+      ({ indexName, deferrable, predicate } = indexName);
+    }
+    if (deferrable && deferrable !== 'not deferrable') {
+      // @ts-ignore
+      this.client.logger.warn(
+        `IBMi: unique index \`${indexName}\` will not be deferrable ${deferrable}.`
+      );
+    }
+    indexName = indexName
+      // @ts-ignore
+      ? this.formatter.wrap(indexName)
+      // @ts-ignore
+      : this._indexCommand('unique', this.tableNameRaw, columns);
+    // @ts-ignore
+    columns = this.formatter.columnize(columns);
+
+    const predicateQuery = predicate
+      // @ts-ignore
+      ? ' ' + this.client.queryCompiler(predicate).where()
+      : '';
+
+    // @ts-ignore
+    this.pushQuery(
+      // @ts-ignore
+      `CREATE UNIQUE INDEX ${indexName} ON ${this.tableName()} (${columns})${predicateQuery}`
+    );
+  }
+
   // All of the columns to "add" for the query
   addColumns(columns, prefix) {
     // @ts-ignore