dbgate-tools 6.5.6 → 6.6.1

package/lib/DatabaseAnalyser.d.ts

@@ -1,7 +1,7 @@
 import { DatabaseHandle, DatabaseInfo, DatabaseModification, EngineDriver, SqlDialect } from 'dbgate-types';
 import { type Logger } from 'pinomin';
-export declare class DatabaseAnalyser {
-    dbhan: DatabaseHandle;
+export declare class DatabaseAnalyser<TClient = any> {
+    dbhan: DatabaseHandle<TClient>;
     driver: EngineDriver;
     structure: DatabaseInfo;
     modifications: DatabaseModification[];
@@ -9,11 +9,16 @@ export declare class DatabaseAnalyser {
     singleObjectId: string;
     dialect: SqlDialect;
     logger: Logger;
-    constructor(dbhan: DatabaseHandle, driver: EngineDriver, version: any);
+    constructor(dbhan: DatabaseHandle<TClient>, driver: EngineDriver, version: any);
     _runAnalysis(): Promise<DatabaseInfo>;
     _getFastSnapshot(): Promise<DatabaseInfo>;
     _computeSingleObjectId(): Promise<void>;
     addEngineField(db: DatabaseInfo): DatabaseInfo;
+    getLogDbInfo(): {
+        database?: string;
+        engine: string;
+        conid?: string;
+    };
     fullAnalysis(): Promise<DatabaseInfo>;
     singleObjectAnalysis(name: any, typeField: any): Promise<any>;
     incrementalAnalysis(structure: any): Promise<DatabaseInfo>;

package/lib/DatabaseAnalyser.js

@@ -73,8 +73,11 @@ class DatabaseAnalyser {
         db.engine = this.driver.engine;
         return db;
     }
+    getLogDbInfo() {
+        return this.driver.getLogDbInfo(this.dbhan);
+    }
     async fullAnalysis() {
-        logger.debug(`Performing full analysis, DB=${(0, schemaInfoTools_1.dbNameLogCategory)(this.dbhan.database)}, engine=${this.driver.engine}`);
+        logger.debug(this.getLogDbInfo(), 'DBGM-00126 Performing full analysis');
         const res = this.addEngineField(await this._runAnalysis());
         // console.log('FULL ANALYSIS', res);
         return res;
@@ -93,7 +96,7 @@ class DatabaseAnalyser {
         return obj;
     }
     async incrementalAnalysis(structure) {
-        logger.info(`Performing incremental analysis, DB=${(0, schemaInfoTools_1.dbNameLogCategory)(this.dbhan.database)}, engine=${this.driver.engine}`);
+        logger.info(this.getLogDbInfo(), 'DBGM-00127 Performing incremental analysis');
         this.structure = structure;
         const modifications = await this.getModifications();
         if (modifications == null) {
@@ -116,7 +119,7 @@ class DatabaseAnalyser {
         this.modifications = structureModifications;
         if (structureWithRowCounts)
             this.structure = structureWithRowCounts;
-        logger.info({ modifications: this.modifications }, 'DB modifications detected:');
+        logger.info({ ...this.getLogDbInfo(), modifications: this.modifications }, 'DBGM-00128 DB modifications detected');
         return this.addEngineField(this.mergeAnalyseResult(await this._runAnalysis()));
     }
     mergeAnalyseResult(newlyAnalysed) {
@@ -246,7 +249,7 @@ class DatabaseAnalyser {
             this.dbhan.feedback(obj);
         }
         if (obj && obj.analysingMessage) {
-            logger.debug(obj.analysingMessage);
+            logger.debug(this.getLogDbInfo(), obj.analysingMessage);
         }
     }
     async getModifications() {
@@ -311,11 +314,11 @@ class DatabaseAnalyser {
         }
         try {
             const res = await this.driver.query(this.dbhan, sql);
-            this.logger.debug({ rows: res.rows.length, template }, `Loaded analyser query`);
+            this.logger.debug({ ...this.getLogDbInfo(), rows: res.rows.length, template }, `DBGM-00129 Loaded analyser query`);
             return res;
         }
         catch (err) {
-            logger.error((0, stringTools_1.extractErrorLogData)(err, { template }), 'Error running analyser query');
+            logger.error((0, stringTools_1.extractErrorLogData)(err, { template, ...this.getLogDbInfo() }), 'DBGM-00130 Error running analyser query');
             return {
                 rows: [],
                 isError: true,

package/lib/SqlGenerator.js

@@ -20,7 +20,7 @@ class SqlGenerator {
         this.isTruncated = false;
         this.isUnhandledException = false;
         this.handleException = error => {
-            logger.error((0, stringTools_1.extractErrorLogData)(error), 'Unhandled error');
+            logger.error((0, stringTools_1.extractErrorLogData)(error), 'DBGM-00186 Unhandled error');
             this.isUnhandledException = true;
         };
         this.dbinfo = (0, structureTools_1.extendDatabaseInfo)(dbinfo);

package/lib/alterPlan.d.ts

@@ -114,6 +114,7 @@ export declare class AlterPlan {
     fillPreloadedRows(table: NamedObjectInfo, oldRows: any[], newRows: any[], key: string[], insertOnly: string[], autoIncrementColumn: string): void;
     setTableOption(table: TableInfo, optionName: string, optionValue: string): void;
     run(processor: AlterProcessor): void;
+    _hasOnlyCommentChange(op: AlterOperation): boolean;
     _getDependendColumnConstraints(column: ColumnInfo, dependencyDefinition: any): import("dbgate-types/dbinfo").PrimaryKeyInfo[];
     _addLogicalDependencies(): AlterOperation[];
     _transformToImplementedOps(): AlterOperation[];

package/lib/alterPlan.js

@@ -143,6 +143,12 @@ class AlterPlan {
             runAlterOperation(op, processor);
         }
     }
+    _hasOnlyCommentChange(op) {
+        if (op.operationType === 'changeColumn') {
+            return lodash_1.default.isEqual(lodash_1.default.omit(op.oldObject, ['columnComment', 'ordinal']), lodash_1.default.omit(op.newObject, ['columnComment', 'ordinal']));
+        }
+        return false;
+    }
     _getDependendColumnConstraints(column, dependencyDefinition) {
         const table = this.wholeOldDb.tables.find(x => x.pureName == column.pureName && x.schemaName == column.schemaName);
         if (!table)
@@ -184,28 +190,32 @@ class AlterPlan {
             ]) {
                 if (op.operationType == testedOperationType) {
                     const constraints = this._getDependendColumnConstraints(testedObject, testedDependencies);
+                    const ignoreContraints = this.dialect.safeCommentChanges && this._hasOnlyCommentChange(op);
                     // if (constraints.length > 0 && this.opts.noDropConstraint) {
                     //   return [];
                     // }
-                    const res = [
-                        ...constraints.map(oldObject => {
+                    const res = [];
+                    if (!ignoreContraints) {
+                        res.push(...constraints.map(oldObject => {
                             const opRes = {
                                 operationType: 'dropConstraint',
                                 oldObject,
                                 isRecreate: true,
                             };
                             return opRes;
-                        }),
-                        op,
-                        ...lodash_1.default.reverse([...constraints]).map(newObject => {
+                        }));
+                    }
+                    res.push(op);
+                    if (!ignoreContraints) {
+                        res.push(...lodash_1.default.reverse([...constraints]).map(newObject => {
                             const opRes = {
                                 operationType: 'createConstraint',
                                 newObject,
                             };
                             return opRes;
-                        }),
-                    ];
-                    if (constraints.length > 0) {
+                        }));
+                    }
+                    if (!ignoreContraints && constraints.length > 0) {
                         this.recreates.constraints += 1;
                     }
                     return res;

package/lib/createBulkInsertStreamBase.js

@@ -42,20 +42,20 @@ function createBulkInsertStreamBase(driver, stream, dbhan, name, options) {
                 writable.structure = structure;
             }
             if (structure && options.dropIfExists) {
-                logger.info(`Dropping table ${fullNameQuoted}`);
+                logger.info(`DBGM-00123 Dropping table ${fullNameQuoted}`);
                 await driver.script(dbhan, `DROP TABLE ${fullNameQuoted}`);
             }
             if (options.createIfNotExists && (!structure || options.dropIfExists)) {
                 const dmp = driver.createDumper();
                 const createdTableInfo = driver.adaptTableInfo((0, tableTransforms_1.prepareTableForImport)({ ...writable.structure, ...name }));
                 dmp.createTable(createdTableInfo);
-                logger.info({ sql: dmp.s }, `Creating table ${fullNameQuoted}`);
+                logger.info({ sql: dmp.s }, `DBGM-00124 Creating table ${fullNameQuoted}`);
                 await driver.script(dbhan, dmp.s);
                 structure = await driver.analyseSingleTable(dbhan, name);
                 writable.structure = structure;
             }
             if (!writable.structure) {
-                throw new Error(`Error importing table - ${fullNameQuoted} not found`);
+                throw new Error(`DBGM-00125 Error importing table - ${fullNameQuoted} not found`);
             }
             if (options.truncate) {
                 await driver.script(dbhan, `TRUNCATE TABLE ${fullNameQuoted}`);
@@ -70,7 +70,7 @@ function createBulkInsertStreamBase(driver, stream, dbhan, name, options) {
             }));
         }
         catch (err) {
-            logger.error((0, stringTools_1.extractErrorLogData)(err), 'Error during preparing bulk insert table, stopped');
+            logger.error((0, stringTools_1.extractErrorLogData)(err), 'DBGM-00184 Error during preparing bulk insert table, stopped');
             writable.destroy(err);
         }
     };
@@ -121,7 +121,7 @@ function createBulkInsertStreamBase(driver, stream, dbhan, name, options) {
             }
         }
         catch (err) {
-            logger.error((0, stringTools_1.extractErrorLogData)(err), 'Error during base bulk insert, insert stopped');
+            logger.error((0, stringTools_1.extractErrorLogData)(err), 'DBGM-00185 Error during base bulk insert, insert stopped');
             writable.destroy(err);
         }
     };

package/lib/diffTools.d.ts

@@ -19,6 +19,7 @@ export interface DbDiffOptions {
     noRenameColumn?: boolean;
     ignoreForeignKeyActions?: boolean;
     ignoreDataTypes?: boolean;
+    ignoreComments?: boolean;
 }
 export declare function generateTablePairingId(table: TableInfo): TableInfo;
 export declare function removeTablePairingId(table: TableInfo): TableInfo;

package/lib/diffTools.js

@@ -252,9 +252,11 @@ function testEqualColumns(a, b, checkName, checkDefault, opts = {}) {
         console.debug(`Column ${a.pureName}.${a.columnName}, ${b.pureName}.${b.columnName}: different zerofill: ${a.isZerofill}, ${b.isZerofill}`);
         return false;
     }
-    if ((a.columnComment || '') != (b.columnComment || '')) {
-        console.debug(`Column ${a.pureName}.${a.columnName}, ${b.pureName}.${b.columnName}: different comment: ${a.columnComment}, ${b.columnComment}`);
-        return false;
+    if (!opts.ignoreComments) {
+        if ((a.columnComment || '') != (b.columnComment || '')) {
+            console.debug(`Column ${a.pureName}.${a.columnName}, ${b.pureName}.${b.columnName}: different comment: ${a.columnComment}, ${b.columnComment}`);
+            return false;
+        }
     }
     if (!testEqualTypes(a, b, opts)) {
         return false;

package/lib/driverBase.d.ts

@@ -53,4 +53,9 @@ export declare const driverBase: {
     adaptTableInfo(table: any): any;
     listSchemas(pool: any): Promise<any>;
     writeQueryFromStream(dbhan: any, sql: any): Promise<any>;
+    getLogDbInfo(dbhan: any): {
+        database: any;
+        engine: any;
+        conid: any;
+    };
 };

package/lib/driverBase.js

@@ -96,7 +96,7 @@ exports.driverBase = {
         for (const sqlItem of (0, dbgate_query_splitter_1.splitQuery)(sql, this.getQuerySplitterOptions('script'))) {
             try {
                 if (options === null || options === void 0 ? void 0 : options.logScriptItems) {
-                    logger.info({ sql: (0, stringTools_1.getLimitedQuery)(sqlItem) }, 'Execute script item');
+                    logger.info({ sql: (0, stringTools_1.getLimitedQuery)(sqlItem) }, 'DBGM-00131 Execute script item');
                 }
                 await this.query(pool, sqlItem, { discardResult: true, ...options === null || options === void 0 ? void 0 : options.queryOptions });
             }
@@ -238,4 +238,11 @@ exports.driverBase = {
     async writeQueryFromStream(dbhan, sql) {
         return null;
     },
+    getLogDbInfo(dbhan) {
+        return {
+            database: dbhan ? dbhan.database : undefined,
+            engine: this.engine,
+            conid: dbhan ? dbhan.conid : undefined,
+        };
+    },
 };

package/lib/filterBehaviours.d.ts

@@ -5,6 +5,7 @@ export declare const logicalFilterBehaviour: FilterBehaviour;
 export declare const datetimeFilterBehaviour: FilterBehaviour;
 export declare const mongoFilterBehaviour: FilterBehaviour;
 export declare const evalFilterBehaviour: FilterBehaviour;
+export declare const firestoreFilterBehaviours: FilterBehaviour;
 export declare const standardFilterBehaviours: {
     [id: string]: FilterBehaviour;
 };

package/lib/filterBehaviours.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.standardFilterBehaviours = exports.evalFilterBehaviour = exports.mongoFilterBehaviour = exports.datetimeFilterBehaviour = exports.logicalFilterBehaviour = exports.stringFilterBehaviour = exports.numberFilterBehaviour = void 0;
+exports.standardFilterBehaviours = exports.firestoreFilterBehaviours = exports.evalFilterBehaviour = exports.mongoFilterBehaviour = exports.datetimeFilterBehaviour = exports.logicalFilterBehaviour = exports.stringFilterBehaviour = exports.numberFilterBehaviour = void 0;
 exports.numberFilterBehaviour = {
     supportEquals: true,
     supportNumberLikeComparison: true,
@@ -21,6 +21,7 @@ exports.stringFilterBehaviour = {
 exports.logicalFilterBehaviour = {
     supportBooleanValues: true,
     supportNullTesting: true,
+    supportBooleanOrNull: true,
     supportSqlCondition: true,
 };
 exports.datetimeFilterBehaviour = {
@@ -31,7 +32,8 @@ exports.datetimeFilterBehaviour = {
 };
 exports.mongoFilterBehaviour = {
     supportEquals: true,
-    supportArrayTesting: true,
+    supportEmptyArrayTesting: true,
+    supportNotEmptyArrayTesting: true,
     supportNumberLikeComparison: true,
     supportStringInclusion: true,
     supportBooleanValues: true,
@@ -48,11 +50,33 @@ exports.evalFilterBehaviour = {
     supportNullTesting: true,
     allowStringToken: true,
 };
+exports.firestoreFilterBehaviours = {
+    supportEquals: true,
+    supportEmpty: false,
+    supportNumberLikeComparison: true,
+    supportDatetimeComparison: false,
+    supportNullTesting: true,
+    supportBooleanValues: true,
+    supportEmptyArrayTesting: true,
+    supportStringInclusion: false,
+    supportDatetimeSymbols: false,
+    supportExistsTesting: false,
+    supportSqlCondition: false,
+    allowStringToken: true,
+    allowNumberToken: true,
+    allowHexString: true,
+    allowNumberDualTesting: false,
+    allowObjectIdTesting: false,
+    passBooleans: true,
+    passNumbers: true,
+    disableOr: true,
+};
 exports.standardFilterBehaviours = {
     numberFilterBehaviour: exports.numberFilterBehaviour,
     stringFilterBehaviour: exports.stringFilterBehaviour,
     logicalFilterBehaviour: exports.logicalFilterBehaviour,
     datetimeFilterBehaviour: exports.datetimeFilterBehaviour,
     mongoFilterBehaviour: exports.mongoFilterBehaviour,
+    firestoreFilterBehaviours: exports.firestoreFilterBehaviours,
     evalFilterBehaviour: exports.evalFilterBehaviour,
 };

package/lib/schemaInfoTools.d.ts

@@ -7,7 +7,6 @@ export declare function splitCompositeDbName(name: string): {
 };
 export declare function extractDbNameFromComposite(name: string): string;
 export declare function extractSchemaNameFromComposite(name: string): string;
-export declare function dbNameLogCategory(database: string): string;
 export declare function compositeDbNameIfNeeded(connnection: {
     useSeparateSchemas: boolean;
 }, database: string, schema: string): string;

package/lib/schemaInfoTools.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.compositeDbNameIfNeeded = exports.dbNameLogCategory = exports.extractSchemaNameFromComposite = exports.extractDbNameFromComposite = exports.splitCompositeDbName = exports.isCompositeDbName = exports.findDefaultSchema = void 0;
+exports.compositeDbNameIfNeeded = exports.extractSchemaNameFromComposite = exports.extractDbNameFromComposite = exports.splitCompositeDbName = exports.isCompositeDbName = exports.findDefaultSchema = void 0;
 function findDefaultSchema(schemaList, dialect, schemaInStorage = null) {
     var _a;
     if (!schemaList) {
@@ -39,16 +39,15 @@ function extractSchemaNameFromComposite(name) {
     return (_a = splitCompositeDbName(name)) === null || _a === void 0 ? void 0 : _a.schema;
 }
 exports.extractSchemaNameFromComposite = extractSchemaNameFromComposite;
-function dbNameLogCategory(database) {
-    if (isCompositeDbName(database)) {
-        return '~composite';
-    }
-    if (database) {
-        return '~simple';
-    }
-    return '~nodb';
-}
-exports.dbNameLogCategory = dbNameLogCategory;
+// export function getDbNameLogFace(database: string): string {
+//   if (isCompositeDbName(database)) {
+//     return '~composite';
+//   }
+//   if (database) {
+//     return '~simple';
+//   }
+//   return '~nodb';
+// }
 function compositeDbNameIfNeeded(connnection, database, schema) {
     if (connnection === null || connnection === void 0 ? void 0 : connnection.useSeparateSchemas) {
         return `${database}::${schema}`;

package/lib/stringTools.js

@@ -60,6 +60,35 @@ function parseCellValue(value, editorTypes) {
             };
         }
     }
+    if (editorTypes === null || editorTypes === void 0 ? void 0 : editorTypes.parseGeopointAsDollar) {
+        const m = value.match(/^([\d\.]+)\s*°\s*([NS]),\s*([\d\.]+)\s*°\s*([EW])$/i);
+        if (m) {
+            let latitude = parseFloat(m[1]);
+            const latDir = m[2].toUpperCase();
+            let longitude = parseFloat(m[3]);
+            const lonDir = m[4].toUpperCase();
+            if (latDir === 'S')
+                latitude = -latitude;
+            if (lonDir === 'W')
+                longitude = -longitude;
+            return {
+                $geoPoint: {
+                    latitude,
+                    longitude,
+                },
+            };
+        }
+    }
+    if (editorTypes === null || editorTypes === void 0 ? void 0 : editorTypes.parseFsDocumentRefAsDollar) {
+        const trimmedValue = value.replace(/\s/g, '');
+        if (trimmedValue.startsWith('$ref:')) {
+            return {
+                $fsDocumentRef: {
+                    documentPath: trimmedValue.slice(5),
+                },
+            };
+        }
+    }
     if (editorTypes === null || editorTypes === void 0 ? void 0 : editorTypes.parseJsonNull) {
         if (value == 'null')
             return null;
@@ -140,6 +169,7 @@ function stringifyJsonToGrid(value) {
     return { value: '(JSON)', gridStyle: 'nullCellStyle' };
 }
 function stringifyCellValue(value, intent, editorTypes, gridFormattingOptions, jsonParsedValue) {
+    var _a;
     if (editorTypes === null || editorTypes === void 0 ? void 0 : editorTypes.parseSqlNull) {
         if (value === null) {
             switch (intent) {
@@ -214,6 +244,29 @@ function stringifyCellValue(value, intent, editorTypes, gridFormattingOptions, j
             }
         }
     }
+    if (editorTypes === null || editorTypes === void 0 ? void 0 : editorTypes.parseGeopointAsDollar) {
+        if (value === null || value === void 0 ? void 0 : value.$geoPoint) {
+            const { latitude, longitude } = value.$geoPoint;
+            if ((0, isNumber_1.default)(latitude) && (0, isNumber_1.default)(longitude)) {
+                const latAbs = Math.abs(latitude);
+                const lonAbs = Math.abs(longitude);
+                const latDir = latitude >= 0 ? 'N' : 'S';
+                const lonDir = longitude >= 0 ? 'E' : 'W';
+                return {
+                    value: `${latAbs}° ${latDir}, ${lonAbs}° ${lonDir}`,
+                    gridStyle: 'valueCellStyle',
+                };
+            }
+        }
+    }
+    if (editorTypes === null || editorTypes === void 0 ? void 0 : editorTypes.parseFsDocumentRefAsDollar) {
+        if (value === null || value === void 0 ? void 0 : value.$fsDocumentRef) {
+            return {
+                value: `$ref: ${(_a = value.$fsDocumentRef.documentPath) !== null && _a !== void 0 ? _a : ''}`,
+                gridStyle: 'valueCellStyle',
+            };
+        }
+    }
     if ((0, isArray_1.default)(value)) {
         switch (intent) {
             case 'gridCellIntent':

package/package.json

@@ -1,5 +1,5 @@
 {
-  "version": "6.5.6",
+  "version": "6.6.1",
   "name": "dbgate-tools",
   "main": "lib/index.js",
   "typings": "lib/index.d.ts",
@@ -26,18 +26,18 @@
   ],
   "devDependencies": {
     "@types/node": "^13.7.0",
-    "dbgate-types": "^6.5.6",
+    "dbgate-types": "^6.6.1",
     "jest": "^28.1.3",
     "ts-jest": "^28.0.7",
     "typescript": "^4.4.3"
   },
   "dependencies": {
     "dbgate-query-splitter": "^4.11.5",
-    "dbgate-sqltree": "^6.5.6",
+    "dbgate-sqltree": "^6.6.1",
     "debug": "^4.3.4",
     "json-stable-stringify": "^1.0.1",
     "lodash": "^4.17.21",
-    "pinomin": "^1.0.4",
+    "pinomin": "^1.0.5",
     "toposort": "^2.0.2",
     "uuid": "^3.4.0"
   }