add geoshape support (#2788)

copied from what leibele did for v5
redis · Jul 10, 2024 · a1bee1c · a1bee1c
1 parent 7d43a97
commit a1bee1c
Show file tree

Hide file tree

Showing 2 changed files with 59 additions and 3 deletions.
diff --git a/packages/search/lib/commands/CREATE.spec.ts b/packages/search/lib/commands/CREATE.spec.ts
@@ -1,7 +1,7 @@
 import { strict as assert } from 'assert';
 import testUtils, { GLOBAL } from '../test-utils';
 import { transformArguments } from './CREATE';
-import { SchemaFieldTypes, SchemaTextFieldPhonetics, RedisSearchLanguages, VectorAlgorithms } from '.';
+import { SchemaFieldTypes, SchemaTextFieldPhonetics, RedisSearchLanguages, VectorAlgorithms, SCHEMA_GEO_SHAPE_COORD_SYSTEM } from '.';
 
 describe('CREATE', () => {
     describe('transformArguments', () => {
@@ -196,6 +196,42 @@ describe('CREATE', () => {
                 });
             });
 
+            describe('GEOSHAPE', () => {
+                describe('without options', () => {
+                    it('SCHEMA_FIELD_TYPE.GEOSHAPE', () => {
+                        assert.deepEqual(
+                            transformArguments('index', {
+                                field: SchemaFieldTypes.GEOSHAPE
+                            }),
+                            ['FT.CREATE', 'index', 'SCHEMA', 'field', 'GEOSHAPE']
+                        );
+                    });
+
+                    it('{ type: SCHEMA_FIELD_TYPE.GEOSHAPE }', () => {
+                        assert.deepEqual(
+                            transformArguments('index', {
+                                field: {
+                                    type: SchemaFieldTypes.GEOSHAPE
+                                }
+                            }),
+                            ['FT.CREATE', 'index', 'SCHEMA', 'field', 'GEOSHAPE']
+                        );
+                    });
+                });
+
+                it('with COORD_SYSTEM', () => {
+                    assert.deepEqual(
+                        transformArguments('index', {
+                            field: {
+                                type: SchemaFieldTypes.GEOSHAPE,
+                                COORD_SYSTEM: SCHEMA_GEO_SHAPE_COORD_SYSTEM.SPHERICAL
+                            }
+                        }),
+                        ['FT.CREATE', 'index', 'SCHEMA', 'field', 'GEOSHAPE', 'COORD_SYSTEM', 'SPHERICAL']
+                    );
+                });
+            });
+
             describe('with generic options', () => {
                 it('with AS', () => {
                     assert.deepEqual(

diff --git a/packages/search/lib/commands/index.ts b/packages/search/lib/commands/index.ts
@@ -185,7 +185,8 @@ export enum SchemaFieldTypes {
     NUMERIC = 'NUMERIC',
     GEO = 'GEO',
     TAG = 'TAG',
-    VECTOR = 'VECTOR'
+    VECTOR = 'VECTOR',
+    GEOSHAPE = 'GEOSHAPE'
 }
 
 type CreateSchemaField<
@@ -257,14 +258,26 @@ type CreateSchemaHNSWVectorField = CreateSchemaVectorField<VectorAlgorithms.HNSW
     EF_RUNTIME?: number;
 }>;
 
+export const SCHEMA_GEO_SHAPE_COORD_SYSTEM = {
+    SPHERICAL: 'SPHERICAL',
+    FLAT: 'FLAT'
+} as const;
+
+export type SchemaGeoShapeFieldCoordSystem = typeof SCHEMA_GEO_SHAPE_COORD_SYSTEM[keyof typeof SCHEMA_GEO_SHAPE_COORD_SYSTEM];
+
+type CreateSchemaGeoShapeField = CreateSchemaCommonField<SchemaFieldTypes.GEOSHAPE, {
+    COORD_SYSTEM?: SchemaGeoShapeFieldCoordSystem;
+}>;
+
 export interface RediSearchSchema {
     [field: string]:
         CreateSchemaTextField |
         CreateSchemaNumericField |
         CreateSchemaGeoField |
         CreateSchemaTagField |
         CreateSchemaFlatVectorField |
-        CreateSchemaHNSWVectorField;
+        CreateSchemaHNSWVectorField |
+        CreateSchemaGeoShapeField
 }
 
 export function pushSchema(args: RedisCommandArguments, schema: RediSearchSchema) {
@@ -361,6 +374,13 @@ export function pushSchema(args: RedisCommandArguments, schema: RediSearchSchema
                 });
 
                 continue; // vector fields do not contain SORTABLE and NOINDEX options
+
+            case SchemaFieldTypes.GEOSHAPE:
+                if (fieldOptions.COORD_SYSTEM !== undefined) {
+                    args.push('COORD_SYSTEM', fieldOptions.COORD_SYSTEM);
+                }
+
+                continue; // geo shape fields do not contain SORTABLE and NOINDEX options
         }
 
         if (fieldOptions.SORTABLE) {