add missing fields support to schema (v4) (#2789)

redis · Jul 17, 2024 · 0e7e2e6 · 0e7e2e6
1 parent 64fca37
commit 0e7e2e6
Show file tree

Hide file tree

Showing 2 changed files with 62 additions and 3 deletions.
diff --git a/packages/search/lib/commands/CREATE.spec.ts b/packages/search/lib/commands/CREATE.spec.ts
@@ -441,6 +441,36 @@ describe('CREATE', () => {
                 );
             });
         });
+
+        describe('Missing Values', () => {
+            it('with INDEXEMPTY', () => {
+                assert.deepEqual(
+                    transformArguments('index', {
+                        field: {
+                            type: SchemaFieldTypes.TEXT,
+                            MISSING_VALUES: {
+                                INDEXEMPTY: true
+                            }
+                        }
+                    }),
+                    ['FT.CREATE', 'index', 'SCHEMA', 'field', 'TEXT', 'INDEXEMPTY']
+                );
+            });
+
+            it('with INDEXMISSING', () => {
+                assert.deepEqual(
+                    transformArguments('index', {
+                        field: {
+                            type: SchemaFieldTypes.TEXT,
+                            MISSING_VALUES: {
+                                INDEXMISSING: true
+                            }
+                        }
+                    }),
+                    ['FT.CREATE', 'index', 'SCHEMA', 'field', 'TEXT', 'INDEXMISSING']
+                );
+            });
+        });
     });
 
     testUtils.testWithClient('client.ft.create', async client => {

diff --git a/packages/search/lib/commands/index.ts b/packages/search/lib/commands/index.ts
@@ -189,12 +189,32 @@ export enum SchemaFieldTypes {
     GEOSHAPE = 'GEOSHAPE'
 }
 
+export interface MissingValues {
+    INDEXEMPTY?: boolean;
+    INDEXMISSING?: boolean;
+}
+
+function pushMissingValues(args: RedisCommandArguments, missingValues?: MissingValues) {
+    if (!missingValues) {
+        return;
+    }
+
+    if (missingValues.INDEXEMPTY) {
+        args.push("INDEXEMPTY");
+    }
+
+    if (missingValues.INDEXMISSING) {
+        args.push("INDEXMISSING");
+    }
+}
+
 type CreateSchemaField<
     T extends SchemaFieldTypes,
     E = Record<PropertyKey, unknown>
 > = T | ({
     type: T;
     AS?: string;
+    MISSING_VALUES?: MissingValues;
 } & E);
 
 type CreateSchemaCommonField<
@@ -313,11 +333,14 @@ export function pushSchema(args: RedisCommandArguments, schema: RediSearchSchema
                     args.push('WITHSUFFIXTRIE');
                 }
 
+                pushMissingValues(args, fieldOptions.MISSING_VALUES);
+
                 break;
 
-            // case SchemaFieldTypes.NUMERIC:
-            // case SchemaFieldTypes.GEO:
-            //     break;
+            case SchemaFieldTypes.NUMERIC:
+            case SchemaFieldTypes.GEO:
+                pushMissingValues(args, fieldOptions.MISSING_VALUES);
+                break;
 
             case SchemaFieldTypes.TAG:
                 if (fieldOptions.SEPARATOR) {
@@ -332,6 +355,8 @@ export function pushSchema(args: RedisCommandArguments, schema: RediSearchSchema
                     args.push('WITHSUFFIXTRIE');
                 }
 
+                pushMissingValues(args, fieldOptions.MISSING_VALUES);
+
                 break;
 
             case SchemaFieldTypes.VECTOR:
@@ -373,13 +398,17 @@ export function pushSchema(args: RedisCommandArguments, schema: RediSearchSchema
                     }
                 });
 
+                pushMissingValues(args, fieldOptions.MISSING_VALUES);
+
                 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);
                 }
 
+                pushMissingValues(args, fieldOptions.MISSING_VALUES);
+
                 continue; // geo shape fields do not contain SORTABLE and NOINDEX options
         }