feat: transform geography binary data to wkt

common/volatilePackages.js

@@ -19,6 +19,7 @@ const volatilePackages = [
   'activedirectory2',
   'axios',
   'ssh2',
+  'wkx',
 ];
 
 module.exports = volatilePackages;

plugins/dbgate-plugin-postgres/package.json

@@ -30,6 +30,7 @@
     "prepublishOnly": "yarn build"
   },
   "devDependencies": {
+    "wkx": "^0.5.0",
     "dbgate-plugin-tools": "^1.0.7",
     "webpack": "^5.91.0",
     "webpack-cli": "^5.1.4"

plugins/dbgate-plugin-postgres/src/backend/drivers.js

@@ -3,6 +3,7 @@ const stream = require('stream');
 
 const driverBases = require('../frontend/drivers');
 const Analyser = require('./Analyser');
+const wkx = require('wkx');
 const pg = require('pg');
 const pgCopyStreams = require('pg-copy-streams');
 const {
@@ -21,10 +22,38 @@ pg.types.setTypeParser(1082, 'text', val => val); // date
 pg.types.setTypeParser(1114, 'text', val => val); // timestamp without timezone
 pg.types.setTypeParser(1184, 'text', val => val); // timestamp
 
-function extractPostgresColumns(result) {
+function extractGeographyDate(value) {
+  try {
+    const buffer = Buffer.from(value, 'hex');
+    const parsed = wkx.Geometry.parse(buffer).toWkt();
+
+    return parsed;
+  } catch (_err) {
+    return value;
+  }
+}
+
+function transformRow(row, columnsToTransform) {
+  if (!columnsToTransform?.length) return row;
+
+  for (const col of columnsToTransform) {
+    const { columnName, dataTypeName } = col;
+    if (dataTypeName == 'geography') {
+      row[columnName] = extractGeographyDate(row[columnName]);
+    }
+  }
+
+  return row;
+}
+
+function extractPostgresColumns(result, dbhan) {
   if (!result || !result.fields) return [];
+
+  const { typeIdToName = {} } = dbhan;
   const res = result.fields.map(fld => ({
     columnName: fld.name,
+    dataTypeId: fld.dataTypeID,
+    dataTypeName: typeIdToName[fld.dataTypeID],
   }));
   makeUniqueColumnNames(res);
   return res;
@@ -105,6 +134,18 @@ const drivers = driverBases.map(driverBase => ({
       database,
     };
 
+    const datatypes = await this.query(
+      dbhan,
+      `SELECT oid AS datatypeid, typname AS datatypename FROM pg_type WHERE typname in ('geography')`
+    );
+
+    const typeIdToName = datatypes.rows.reduce((acc, cur) => {
+      acc[cur.datatypeid] = cur.datatypename;
+      return acc;
+    }, {});
+
+    dbhan['typeIdToName'] = typeIdToName;
+
     if (isReadOnly) {
       await this.query(dbhan, 'SET SESSION CHARACTERISTICS AS TRANSACTION READ ONLY');
     }
@@ -122,7 +163,7 @@ const drivers = driverBases.map(driverBase => ({
       };
     }
     const res = await dbhan.client.query({ text: sql, rowMode: 'array' });
-    const columns = extractPostgresColumns(res);
+    const columns = extractPostgresColumns(res, dbhan);
     return { rows: (res.rows || []).map(row => zipDataRow(row, columns)), columns };
   },
   stream(dbhan, sql, options) {
@@ -132,17 +173,26 @@ const drivers = driverBases.map(driverBase => ({
     });
 
     let wasHeader = false;
+    let columnsToTransform = null;
 
     query.on('row', row => {
       if (!wasHeader) {
-        columns = extractPostgresColumns(query._result);
+        columns = extractPostgresColumns(query._result, dbhan);
         if (columns && columns.length > 0) {
           options.recordset(columns);
         }
         wasHeader = true;
       }
 
-      options.row(zipDataRow(row, columns));
+      if (!columnsToTransform) {
+        const transormableTypeNames = Object.values(dbhan.typeIdToName ?? {});
+        columnsToTransform = columns.filter(x => transormableTypeNames.includes(x.dataTypeName));
+      }
+
+      const zippedRow = zipDataRow(row, columns);
+      const transformedRow = transformRow(zippedRow, columnsToTransform);
+
+      options.row(transformedRow);
     });
 
     query.on('end', () => {
@@ -157,7 +207,7 @@ const drivers = driverBases.map(driverBase => ({
       }
 
       if (!wasHeader) {
-        columns = extractPostgresColumns(query._result);
+        columns = extractPostgresColumns(query._result, dbhan);
         if (columns && columns.length > 0) {
           options.recordset(columns);
         }
@@ -234,6 +284,8 @@ const drivers = driverBases.map(driverBase => ({
     let wasHeader = false;
     let columns = null;
 
+    let columnsToTransform = null;
+
     const pass = new stream.PassThrough({
       objectMode: true,
       highWaterMark: 100,
@@ -241,7 +293,7 @@ const drivers = driverBases.map(driverBase => ({
 
     query.on('row', row => {
       if (!wasHeader) {
-        columns = extractPostgresColumns(query._result);
+        columns = extractPostgresColumns(query._result, dbhan);
         pass.write({
           __isStreamHeader: true,
           ...(structure || { columns }),
@@ -249,12 +301,20 @@ const drivers = driverBases.map(driverBase => ({
         wasHeader = true;
       }
 
-      pass.write(zipDataRow(row, columns));
+      if (!columnsToTransform) {
+        const transormableTypeNames = Object.values(dbhan.typeIdToName ?? {});
+        columnsToTransform = columns.filter(x => transormableTypeNames.includes(x.dataTypeName));
+      }
+
+      const zippedRow = zipDataRow(row, columns);
+      const transformedRow = transformRow(zippedRow, columnsToTransform);
+
+      options.row(transformedRow);
     });
 
     query.on('end', () => {
       if (!wasHeader) {
-        columns = extractPostgresColumns(query._result);
+        columns = extractPostgresColumns(query._result, dbhan);
         pass.write({
           __isStreamHeader: true,
           ...(structure || { columns }),

yarn.lock

@@ -12161,6 +12161,13 @@ wildcard@^2.0.0:
   resolved "https://registry.yarnpkg.com/wildcard/-/wildcard-2.0.1.tgz#5ab10d02487198954836b6349f74fff961e10f67"
   integrity sha512-CC1bOL87PIWSBhDcTrdeLo6eGT7mCFtrg0uIJtqJUFyK+eJnzl8A1niH56uu7KMa5XFrtiV+AQuHO3n7DsHnLQ==
 
+wkx@^0.5.0:
+  version "0.5.0"
+  resolved "https://registry.yarnpkg.com/wkx/-/wkx-0.5.0.tgz#c6c37019acf40e517cc6b94657a25a3d4aa33e8c"
+  integrity sha512-Xng/d4Ichh8uN4l0FToV/258EjMGU9MGcA0HV2d9B/ZpZB3lqQm7nkOdZdm5GhKtLLhAE7PiVQwN4eN+2YJJUg==
+  dependencies:
+    "@types/node" "*"
+
 wmf@~1.0.1:
   version "1.0.2"
   resolved "https://registry.yarnpkg.com/wmf/-/wmf-1.0.2.tgz#7d19d621071a08c2bdc6b7e688a9c435298cc2da"