Add geometry column building (#4776)

knex · Oct 27, 2021 · 50cfa5f · 50cfa5f
1 parent 994cbcb
commit 50cfa5f
Show file tree

Hide file tree

Showing 5 changed files with 151 additions and 1 deletion.
diff --git a/lib/schema/columncompiler.js b/lib/schema/columncompiler.js
@@ -142,6 +142,9 @@ ColumnCompiler.prototype.date = 'date';
 ColumnCompiler.prototype.datetime = 'datetime';
 ColumnCompiler.prototype.time = 'time';
 ColumnCompiler.prototype.timestamp = 'timestamp';
+ColumnCompiler.prototype.geometry = 'geometry';
+ColumnCompiler.prototype.geography = 'geography';
+ColumnCompiler.prototype.point = 'point';
 ColumnCompiler.prototype.enu = 'varchar';
 ColumnCompiler.prototype.bit = ColumnCompiler.prototype.json = 'text';
 ColumnCompiler.prototype.uuid = 'char(36)';

diff --git a/lib/schema/tablebuilder.js b/lib/schema/tablebuilder.js
@@ -218,6 +218,11 @@ const columnTypes = [
   'time',
   'year',
 
+  // Geometry
+  'geometry',
+  'geography',
+  'point',
+
   // String
   'char',
   'varchar',

diff --git a/scripts/docker-compose.yml b/scripts/docker-compose.yml
@@ -2,7 +2,7 @@ version: '3'
 
 services:
   mssql:
-    image: mcr.microsoft.com/mssql/server:2017-latest
+    image: mcr.microsoft.com/mssql/server:2019-latest
     ports:
       - '21433:1433'
     environment:

diff --git a/test/integration2/schema/geometry-columns.spec.js b/test/integration2/schema/geometry-columns.spec.js
@@ -0,0 +1,139 @@
+const { expect } = require('chai');
+const { getAllDbs, getKnexForDb } = require('../util/knex-instance-provider');
+const {
+  isPostgreSQL,
+  isCockroachDB,
+  isPgBased,
+  isSQLite,
+  isMssql,
+} = require('../../util/db-helpers');
+
+describe('Schema', () => {
+  describe('geometry columns', () => {
+    getAllDbs().forEach((db) => {
+      describe(db, () => {
+        let knex;
+        const tblName = 'table_with_geo';
+
+        beforeEach(async () => {
+          knex = getKnexForDb(db);
+          await knex.schema.dropTableIfExists(tblName);
+        });
+
+        after(async () => {
+          return knex.destroy();
+        });
+
+        it('Creates POINT column for supported databases', async function () {
+          if (isCockroachDB(knex) || isMssql(knex)) {
+            return this.skip();
+          }
+
+          await knex.schema.createTable(tblName, (table) => {
+            table.point('pointColumn');
+          });
+
+          if (isPostgreSQL(knex)) {
+            await knex(tblName).insert({
+              pointColumn: '2, 3',
+            });
+
+            const result = await knex(tblName).select('*');
+            expect(result).to.eql([
+              {
+                pointColumn: {
+                  x: 2,
+                  y: 3,
+                },
+              },
+            ]);
+          }
+        });
+
+        it('Creates GEOMETRY column for supported databases', async function () {
+          if (isPgBased(knex)) {
+            return this.skip();
+          }
+
+          await knex.schema.createTable(tblName, (table) => {
+            table.geometry('geometryColumn');
+          });
+
+          if (isPostgreSQL(knex)) {
+            await knex(tblName).insert({
+              geometryColumn: '2, 3',
+            });
+
+            const result = await knex(tblName).select('*');
+            expect(result).to.eql([
+              {
+                geometryColumn: {
+                  x: 2,
+                  y: 3,
+                },
+              },
+            ]);
+          }
+
+          if (isSQLite(knex)) {
+            await knex(tblName).insert({
+              geometryColumn: '2, 3',
+            });
+
+            const result = await knex(tblName).select('*');
+            expect(result).to.eql([
+              {
+                geometryColumn: '2, 3',
+              },
+            ]);
+          }
+
+          if (isMssql(knex)) {
+            await knex(tblName).insert({
+              geometryColumn: knex.raw('geometry::Point(1, 10, 0)'),
+            });
+
+            const result = await knex(tblName).select('*');
+            const geoData = result[0].geometryColumn;
+            expect(geoData.length).to.equal(22);
+          }
+        });
+
+        it('Creates GEOGRAPHY column for supported databases', async function () {
+          if (!isSQLite(knex) && !isMssql(knex)) {
+            return this.skip();
+          }
+
+          await knex.schema.createTable(tblName, (table) => {
+            table.geography('geoColumn');
+          });
+
+          if (isSQLite(knex)) {
+            await knex(tblName).insert({
+              geoColumn: '2, 3',
+            });
+
+            const result = await knex(tblName).select('*');
+            expect(result).to.eql([
+              {
+                geoColumn: '2, 3',
+              },
+            ]);
+          }
+
+          if (isMssql(knex)) {
+            await knex(tblName).insert({
+              geoColumn: knex.raw(
+                "geography::STGeomFromText('LINESTRING(-122.360 47.656, -122.343 47.656 )', 4326)"
+              ),
+            });
+
+            const result = await knex(tblName).select('*');
+            const geoData = result[0].geoColumn;
+            expect(geoData.length).to.equal(38);
+          }
+        });
+      });
+    });
+  });
+});
diff --git a/types/index.d.ts b/types/index.d.ts
@@ -2023,6 +2023,9 @@ export declare namespace Knex {
       useTimestampType?: boolean,
       makeDefaultNow?: boolean
     ): void;
+    geometry(columnName: string): ColumnBuilder;
+    geography(columnName: string): ColumnBuilder;
+    point(columnName: string): ColumnBuilder;
     binary(columnName: string, length?: number): ColumnBuilder;
     enum(
       columnName: string,