@bdkinc/knex-ibmi 0.3.21 → 0.4.0

package/dist/index.d.ts

@@ -1,76 +1,87 @@
-import { knex, Knex } from 'knex';
+import knex, { Knex } from 'knex';
 import odbc, { Connection } from 'odbc';
-import SchemaCompiler from 'knex/lib/schema/compiler';
-import TableCompiler from 'knex/lib/schema/tablecompiler';
-import ColumnCompiler from 'knex/lib/schema/columncompiler';
-import QueryCompiler from 'knex/lib/query/querycompiler';
 
-declare class IBMiSchemaCompiler extends SchemaCompiler {
-    hasTable(tableName: any): void;
-    toSQL(): any[];
+interface IBMiMigrationConfig {
+    directory: string;
+    tableName: string;
+    schemaName?: string;
+    extension?: string;
 }
-
-declare class IBMiTableCompiler extends TableCompiler {
-    createQuery(columns: {
-        sql: any[];
-    }, ifNot: any, like: any): void;
-    dropUnique(columns: string[], indexName: any): void;
-    unique(columns: string[], indexName: {
-        indexName: any;
-        deferrable: any;
-        predicate: any;
-    }): void;
-    addColumns(columns: any, prefix: any): void;
-    commit(connection: Connection): Promise<void>;
-}
-
-declare class IBMiColumnCompiler extends ColumnCompiler {
-    increments(options?: {
-        primaryKey: boolean;
-    }): string;
+declare class IBMiMigrationRunner {
+    private knex;
+    private config;
+    constructor(knex: Knex, config?: Partial<IBMiMigrationConfig>);
+    private getFullTableName;
+    latest(): Promise<void>;
+    rollback(steps?: number): Promise<void>;
+    currentVersion(): Promise<string | null>;
+    listExecuted(): Promise<string[]>;
+    listPending(): Promise<string[]>;
+    private getMigrationFiles;
+    private getMigrationPath;
 }
+declare function createIBMiMigrationRunner(knex: Knex, config?: Partial<IBMiMigrationConfig>): IBMiMigrationRunner;
 
-declare class IBMiQueryCompiler extends QueryCompiler {
-    insert(): "" | {
-        sql: string;
-        returning: any;
-    };
-    _buildInsertData(insertValues: string | any[], returningSql: string): string;
-    _prepInsert(data: any): {
-        columns: any;
-        values: any;
+interface QueryObject {
+    response?: {
+        rows: any[];
+        rowCount: number;
     };
-    update(): {
-        sql: string;
-        returning: any;
-    };
-    _returning(method: string, value: any, withTrigger: undefined): string | undefined;
-    columnizeWithPrefix(prefix: string, target: any): string;
+    sqlMethod: SqlMethod;
+    output?: (runner: any, response: any) => any;
+    pluck?: (row: any) => any;
+    select?: boolean;
+}
+declare enum SqlMethod {
+    SELECT = "select",
+    PLUCK = "pluck",
+    FIRST = "first",
+    INSERT = "insert",
+    DELETE = "del",
+    DELETE_ALT = "delete",
+    UPDATE = "update",
+    COUNTER = "counter"
 }
-
 declare class DB2Client extends knex.Client {
     constructor(config: Knex.Config<DB2Config>);
+    private safeStringify;
     _driver(): typeof odbc;
-    wrapIdentifierImpl(value: any): any;
+    wrapIdentifierImpl(value: string): string;
     printDebug(message: string): void;
     printError(message: string): void;
     printWarn(message: string): void;
-    acquireRawConnection(): Promise<any>;
+    acquireRawConnection(): Promise<void | odbc.Connection>;
     destroyRawConnection(connection: any): Promise<any>;
     _getConnectionString(connectionConfig: DB2ConnectionConfig): string;
-    _query(connection: any, obj: any): Promise<any>;
+    _query(connection: Connection, obj: any): Promise<any>;
+    private normalizeQueryObject;
+    private determineQueryMethod;
+    private isSelectMethod;
+    private executeSelectQuery;
+    private executeStatementQuery;
+    private isNoDataError;
+    /**
+     * Format statement response from ODBC driver
+     * Handles special case for IDENTITY_VAL_LOCAL() function
+     */
+    private formatStatementResponse;
     _stream(connection: Connection, obj: {
         sql: string;
         bindings: any[];
     }, stream: any, options: {
         fetchSize?: number;
     }): Promise<unknown>;
+    private _createCursorStream;
     transaction(container: any, config: any, outerTx: any): Knex.Transaction;
-    schemaCompiler(tableBuilder: any): IBMiSchemaCompiler;
-    tableCompiler(tableBuilder: any): IBMiTableCompiler;
-    columnCompiler(tableCompiler: any, columnCompiler: any): IBMiColumnCompiler;
-    queryCompiler(builder: Knex.QueryBuilder, bindings?: any[]): IBMiQueryCompiler;
-    processResponse(obj: any, runner: any): any;
+    schemaCompiler(tableBuilder: any): any;
+    tableCompiler(tableBuilder: any): any;
+    columnCompiler(tableCompiler: any, columnCompiler: any): any;
+    queryCompiler(builder: Knex.QueryBuilder, bindings?: any[]): any;
+    createMigrationRunner(config?: Partial<IBMiMigrationConfig>): IBMiMigrationRunner;
+    processResponse(obj: QueryObject | null, runner: any): any;
+    private validateResponse;
+    private isConnectionError;
+    private processSqlMethod;
 }
 interface DB2PoolConfig {
     min?: number;
@@ -91,13 +102,26 @@ interface DB2ConnectionParams {
     DECFLOATERROROPTION?: 0 | 1;
     DECFLOATROUNDMODE?: 0 | 1 | 2 | 3 | 4 | 5 | 6;
     MAPDECIMALFLOATDESCRIBE?: 1 | 3;
+    TFT?: 0 | 1 | 2 | 3 | 4;
+    TSP?: 0 | 1 | 2 | 3;
+    TSFT?: 0 | 1;
+    XMLCURIMPPARSE?: 0 | 1;
+    XMLDECLARATION?: 1 | 2 | 3 | 4;
     ALLOWPROCCALLS?: 0 | 1;
     XDYNAMIC?: 0 | 1;
+    DFTPKGLIB?: string;
+    PKG?: 0 | 1 | 2;
+    BLOCKFETCH?: 0 | 1;
+    COMPRESSION?: 0 | 1;
+    CONCURRENCY?: 0 | 1;
+    CURSORSENSITIVITY?: 0 | 1 | 2;
+    EXTCOLINFO?: "SQL_DESC_AUTO_UNIQUE_VALUE" | "SQL_DESC_BASE_COLUMN_NAME" | "SQL_DESC_BASE_TABLE_NAME and SQL_DESC_TABLE_NAME" | "SQL_DESC_LABEL" | "SQL_DESC_SCHEMA_NAME" | "SQL_DESC_SEARCHABLE" | "SQL_DESC_UNNAMED" | "SQL_DESC_UPDATABLE";
+    TRUEAUTOCOMMIT?: 0 | 1;
 }
 interface DB2ConnectionConfig {
     database: string;
     host: string;
-    port: 50000 | number;
+    port: 8471 | 9471 | number;
     user: string;
     password: string;
     driver: "IBM i Access ODBC Driver" | string;
@@ -110,4 +134,4 @@ interface DB2Config extends Knex.Config {
 }
 declare const DB2Dialect: typeof DB2Client;
 
-export { type DB2Config, DB2Dialect, DB2Client as default };
+export { type DB2Config, DB2Dialect, IBMiMigrationRunner, createIBMiMigrationRunner, DB2Client as default };