added gist constraints on index creation

Author: ackava

src/decorators/IIndex.ts

@@ -15,7 +15,6 @@ export default interface IIndexDef<T = any> {
     unique?: boolean;
     include?: ((x:T) => any)[];
     indexType?: string;
-    spatial?: boolean;
     filter?: (x: T) => boolean;
 }
 
@@ -26,6 +25,5 @@ export interface IIndex{
     unique?: boolean;
     include?: string[];
     indexType?: string;
-    spatial?: boolean;
     filter?: ((x: any) => boolean) | string;
 }

src/decorators/ISqlType.ts

@@ -72,3 +72,12 @@ export type ISqlType =
     /** Geography - for SQL Server and other Geography compatible databases*/
     "Geography"
     ;
+
+
+export const isSpatialType = (type: ISqlType) => {
+    switch(type) {
+        case "Geography":
+            return true;
+    }
+    return false;
+};

src/migrations/postgres/PostgresAutomaticMigrations.ts

@@ -3,6 +3,7 @@ import ICheckConstraint from "../../decorators/ICheckConstraint.js";
 import { IColumn } from "../../decorators/IColumn.js";
 import { IForeignKeyConstraint } from "../../decorators/IForeignKeyConstraint.js";
 import { IIndex } from "../../decorators/IIndex.js";
+import { isSpatialType } from "../../decorators/ISqlType.js";
 import EntityType from "../../entity-query/EntityType.js";
 import type EntityContext from "../../model/EntityContext.js";
 import PostgresMigrations from "./PostgresMigrations.js";
@@ -108,6 +109,7 @@ export default class PostgresAutomaticMigrations extends PostgresMigrations {
             : type.name;
         const indexName =  index.name;
         const columns = [];
+        let spatial = false;
         for (const column of index.columns) {
             const columnName = column.name;
             let operatorClass = "";
@@ -124,11 +126,14 @@ export default class PostgresAutomaticMigrations extends PostgresMigrations {
                         break;
                 }
             }
-            columns.push(`${columnName} ${operatorClass} ${ index.spatial ? "" : (column.descending ? "DESC" : "ASC")}`);
+            const c = type.getColumn(column.name);
+            const isColumnSpatial = isSpatialType(c.dataType);
+            spatial ||= isColumnSpatial;
+            columns.push(`${columnName} ${operatorClass} ${ isColumnSpatial ? "" : (column.descending ? "DESC" : "ASC")}`);
         }
         let query = `CREATE ${index.unique ? "UNIQUE" : ""} INDEX IF NOT EXISTS ${indexName} ON ${name}`;
 
-        if (index.spatial) {
+        if (spatial) {
             query += " USING GIST ";
         }
 

src/migrations/postgres/PostgresMigrations.ts

@@ -79,6 +79,7 @@ export default abstract class PostgresMigrations extends Migrations {
 
     async enableGeoSpatialTypes(): Promise<void> {
         await this.connection.executeQuery(`CREATE EXTENSION IF NOT EXISTS postgis;`);
+        await this.connection.executeQuery(`CREATE EXTENSION IF NOT EXISTS btree_gist;`);
     }
 
     protected getColumnDefinition(iterator: IColumn) {

src/migrations/sql-server/SqlServerAutomaticMigrations.ts

@@ -3,6 +3,7 @@ import ICheckConstraint from "../../decorators/ICheckConstraint.js";
 import { IColumn } from "../../decorators/IColumn.js";
 import { IForeignKeyConstraint } from "../../decorators/IForeignKeyConstraint.js";
 import { IIndex } from "../../decorators/IIndex.js";
+import { isSpatialType } from "../../decorators/ISqlType.js";
 import { BaseConnection } from "../../drivers/base/BaseDriver.js";
 import ExistingSchema from "../../drivers/base/ExistingSchema.js";
 import { SqlServerLiteral } from "../../drivers/sql-server/SqlServerLiteral.js";
@@ -122,12 +123,16 @@ export default class SqlServerAutomaticMigrations extends SqlServerMigrations {
             : type.name;
         const indexName =  index.name;
         const columns = [];
+        let spatial = true;
         for (const column of index.columns) {
             const columnName = column.name;
-            columns.push(`${columnName} ${ index.spatial ? "" : (column.descending ? "DESC" : "ASC")}`);
+            const c = type.getColumn(column.name);
+            const isColumnSpatial = isSpatialType(c.dataType);
+            spatial &&= isColumnSpatial;
+            columns.push(`${columnName} ${ isSpatialType(c.dataType) ? "" : (column.descending ? "DESC" : "ASC")}`);
         }
 
-        const indexType = index.spatial ? " SPATIAL " : "";
+        const indexType = spatial ? " SPATIAL " : "";
 
         let query = `IF NOT EXISTS(SELECT * FROM sys.indexes WHERE name = '${indexName}' AND object_id = OBJECT_ID('${name}'))
         BEGIN   

src/tests/model/ShoppingContext.ts

@@ -64,10 +64,10 @@ export class CachedItem {
 })
 @Index({
     name: "IX_Users_Geo",
-    columns: [{
-        name:(x) => x.location, descending: false
-    }],
-    spatial: true
+    columns: [
+        { name:(x) => x.location, descending: false },
+        { name:(x) => x.userName, descending: false },
+    ],
 })
 export class User {