redis-om / StringArrayFieldDefinition
A field representing an array of strings.
-
↳
StringArrayFieldDefinition
• Optional alias: string
The default field name in Redis is the key name defined in the SchemaDefinition. Overrides the Redis key name if set.
lib/schema/definition/base-field-definition.ts:12
• Optional caseSensitive: boolean
Is the original case of this field indexed with Redis OM. Defaults to false.
CaseSensitiveFieldDefinition.caseSensitive
lib/schema/definition/casesensitive-field-definition.ts:7
• Optional indexed: boolean
Is this field indexed and thus searchable with Redis OM. Defaults to the schema indexedDefault value, currently true.
lib/schema/definition/base-field-definition.ts:18
• Optional normalized: boolean
Is this (sortable) field normalized when indexed. Defaults to true.
NormalizedFieldDefinition.normalized
lib/schema/definition/normalized-field-definition.ts:7
• Optional separator: string
Due to how RediSearch works, strings and arrays are sometimes stored the same in Redis, as a
simple string. This is the separator used to split those strings when it is an array. If your
StringField contains this separator, this can cause problems. You can change it here to avoid
those problems. Defaults to |.
SeparableFieldDefinition.separator
lib/schema/definition/separable-field-definition.ts:9
• Optional sortable: boolean
Enables sorting by this field.
SortableFieldDefinition.sortable
lib/schema/definition/sortable-field-definition.ts:4
• type: "string[]"
Yep. It's a string array.