Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

add MISSING FIELDS support to FT.CREATE #2776

Open
wants to merge 3 commits into
base: v5
Choose a base branch
from
+104 −34
Open

add MISSING FIELDS support to FT.CREATE #2776

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
4616699
add ISEMPTY field support to FT.CREATE
sjpotter Jun 6, 2024
9c91c5c
move from ISEMPTY to ISMISSING/ISNULL
sjpotter Jun 6, 2024
7cfa9e7
sync with changes leibele wanted for v4 release
sjpotter Aug 15, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
71 changes: 57 additions & 14 deletions packages/search/lib/commands/CREATE.spec.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -69,24 +69,43 @@ describe('FT.CREATE', () => {
['FT.CREATE', 'index', 'SCHEMA', 'field', 'TEXT', 'WITHSUFFIXTRIE']
);
});
it('with INDEXEMPTY', () => {
assert.deepEqual(
CREATE.transformArguments('index', {
field: {
type: SCHEMA_FIELD_TYPE.TEXT,
INDEXEMPTY: true
}
}),
['FT.CREATE', 'index', 'SCHEMA', 'field', 'TEXT', 'INDEXEMPTY']
);
});
});

it('NUMERIC', () => {
assert.deepEqual(
CREATE.transformArguments('index', {
field: SCHEMA_FIELD_TYPE.NUMERIC
}),
['FT.CREATE', 'index', 'SCHEMA', 'field', 'NUMERIC']
);
describe('NUMERIC', () => {
describe('transformArguments', () => {
it('no options', () => {
assert.deepEqual(
CREATE.transformArguments('index', {
field: SCHEMA_FIELD_TYPE.NUMERIC
}),
['FT.CREATE', 'index', 'SCHEMA', 'field', 'NUMERIC']
);
});
});
});

it('GEO', () => {
assert.deepEqual(
CREATE.transformArguments('index', {
field: SCHEMA_FIELD_TYPE.GEO
}),
['FT.CREATE', 'index', 'SCHEMA', 'field', 'GEO']
);
describe('GEO', () => {
describe('transformArguments', () => {
it('no options', () => {
assert.deepEqual(
CREATE.transformArguments('index', {
field: SCHEMA_FIELD_TYPE.GEO
}),
['FT.CREATE', 'index', 'SCHEMA', 'field', 'GEO']
);
});
});
});

describe('TAG', () => {
Expand Down Expand Up @@ -147,6 +166,18 @@ describe('FT.CREATE', () => {
['FT.CREATE', 'index', 'SCHEMA', 'field', 'TAG', 'WITHSUFFIXTRIE']
);
});

it('with INDEXEMPTY', () => {
assert.deepEqual(
CREATE.transformArguments('index', {
field: {
type: SCHEMA_FIELD_TYPE.TAG,
INDEXEMPTY: true
}
}),
['FT.CREATE', 'index', 'SCHEMA', 'field', 'TAG', 'INDEXEMPTY']
);
});
});

describe('VECTOR', () => {
Expand Down Expand Up @@ -282,6 +313,18 @@ describe('FT.CREATE', () => {
});
});

it('with INDEXMISSING', () => {
assert.deepEqual(
CREATE.transformArguments('index', {
field: {
type: SCHEMA_FIELD_TYPE.TEXT,
INDEXMISSING: true
}
}),
['FT.CREATE', 'index', 'SCHEMA', 'field', 'TEXT', 'INDEXMISSING']
);
});

it('with ON', () => {
assert.deepEqual(
CREATE.transformArguments('index', {}, {
Expand Down
67 changes: 47 additions & 20 deletions packages/search/lib/commands/CREATE.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,19 +18,36 @@ type SchemaField<
> = T | ({
type: T;
AS?: RedisArgument;
INDEXMISSING?: boolean;
} & E);

type CommonFieldArguments = {
SORTABLE?: boolean | 'UNF';
NOINDEX?: boolean;
};

type SchemaCommonField<
T extends SchemaFieldType,
E = Record<PropertyKey, unknown>
> = SchemaField<
T,
({
SORTABLE?: boolean | 'UNF';
NOINDEX?: boolean;
} & E)
T,
(CommonFieldArguments & E)
>;

function pushCommonFieldArguments(args: CommandArguments, fieldOptions: CommonFieldArguments) {
if (fieldOptions.SORTABLE) {
args.push('SORTABLE');

if (fieldOptions.SORTABLE === 'UNF') {
args.push('UNF');
}
}

if (fieldOptions.NOINDEX) {
args.push('NOINDEX');
}
}

export const SCHEMA_TEXT_FIELD_PHONETIC = {
DM_EN: 'dm:en',
DM_FR: 'dm:fr',
Expand All @@ -45,6 +62,7 @@ type SchemaTextField = SchemaCommonField<typeof SCHEMA_FIELD_TYPE['TEXT'], {
WEIGHT?: number;
PHONETIC?: SchemaTextFieldPhonetic;
WITHSUFFIXTRIE?: boolean;
INDEXEMPTY?: boolean;
}>;

type SchemaNumericField = SchemaCommonField<typeof SCHEMA_FIELD_TYPE['NUMERIC']>;
Expand All @@ -55,6 +73,7 @@ type SchemaTagField = SchemaCommonField<typeof SCHEMA_FIELD_TYPE['TAG'], {
SEPARATOR?: RedisArgument;
CASESENSITIVE?: boolean;
WITHSUFFIXTRIE?: boolean;
INDEXEMPTY?: boolean;
}>;

export const SCHEMA_VECTOR_FIELD_ALGORITHM = {
Expand Down Expand Up @@ -92,7 +111,7 @@ export const SCHEMA_GEO_SHAPE_COORD_SYSTEM = {

export type SchemaGeoShapeFieldCoordSystem = typeof SCHEMA_GEO_SHAPE_COORD_SYSTEM[keyof typeof SCHEMA_GEO_SHAPE_COORD_SYSTEM];

type SchemaGeoShapeField = SchemaField<typeof SCHEMA_FIELD_TYPE['GEOSHAPE'], {
type SchemaGeoShapeField = SchemaCommonField<typeof SCHEMA_FIELD_TYPE['GEOSHAPE'], {
COORD_SYSTEM?: SchemaGeoShapeFieldCoordSystem;
}>;

Expand Down Expand Up @@ -141,11 +160,18 @@ export function pushSchema(args: CommandArguments, schema: RediSearchSchema) {
args.push('WITHSUFFIXTRIE');
}

pushCommonFieldArguments(args, fieldOptions);

if (fieldOptions.INDEXEMPTY) {
args.push('INDEXEMPTY');
}

break;

// case SchemaFieldTypes.NUMERIC:
// case SchemaFieldTypes.GEO:
// break;
case SCHEMA_FIELD_TYPE.NUMERIC:
case SCHEMA_FIELD_TYPE.GEO:
pushCommonFieldArguments(args, fieldOptions);
break;

case SCHEMA_FIELD_TYPE.TAG:
if (fieldOptions.SEPARATOR) {
Expand All @@ -160,6 +186,12 @@ export function pushSchema(args: CommandArguments, schema: RediSearchSchema) {
args.push('WITHSUFFIXTRIE');
}

pushCommonFieldArguments(args, fieldOptions);

if (fieldOptions.INDEXEMPTY) {
args.push('INDEXEMPTY');
}

break;

case SCHEMA_FIELD_TYPE.VECTOR:
Expand Down Expand Up @@ -200,28 +232,23 @@ export function pushSchema(args: CommandArguments, schema: RediSearchSchema) {

break;
}

args[lengthIndex] = (args.length - lengthIndex - 1).toString();

continue; // vector fields do not contain SORTABLE and NOINDEX options
break;

case SCHEMA_FIELD_TYPE.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) {
args.push('SORTABLE');
pushCommonFieldArguments(args, fieldOptions);

if (fieldOptions.SORTABLE === 'UNF') {
args.push('UNF');
}
break; // geo shape fields do not contain SORTABLE and NOINDEX options
}

if (fieldOptions.NOINDEX) {
args.push('NOINDEX');
if (fieldOptions.INDEXMISSING) {
args.push('INDEXMISSING');
}
}
}
Expand Down