redis-om / Search

Class: Search<T>

Entry point to fluent search. This is the default Redis OM experience. Requires that RediSearch (and optionally RedisJSON) be installed.

Template

The type of Entity being sought.

Type parameters

Name	Type
T	extends Entity = Record<string, any>

Hierarchy

• AbstractSearch<T>

  ↳ Search

Table of contents

Accessors

• return

Methods

• all
• allIds
• allKeys
• and
• count
• first
• firstId
• firstKey
• max
• maxId
• maxKey
• min
• minId
• minKey
• or
• page
• pageOfIds
• pageOfKeys
• returnAll
• returnAllIds
• returnAllKeys
• returnCount
• returnFirst
• returnFirstId
• returnFirstKey
• returnMax
• returnMaxId
• returnMaxKey
• returnMin
• returnMinId
• returnMinKey
• returnPage
• returnPageOfIds
• returnPageOfKeys
• sortAsc
• sortAscending
• sortBy
• sortDesc
• sortDescending
• where

Accessors

return

• get return(): AbstractSearch<T>

Returns the current instance. Syntactic sugar to make your code more fluent.

Returns

AbstractSearch<T>

this

Inherited from

AbstractSearch.return

Defined in

lib/search/search.ts:329

Methods

all

▸ all(options?): Promise<T[]>

Returns all the Entities that match this query. This method makes multiple calls to Redis until all the Entities are returned. You can specify the batch size by setting the pageSize property on the options:

const entities = await repository.search().returnAll({ pageSize: 100 })

Parameters

Name	Type	Default value	Description
options	Object	undefined	Options for the call.
options.pageSize	number	10	Number of Entities returned per batch.

Returns

Promise<T[]>

An array of Entities matching the query.

Inherited from

AbstractSearch.all

Defined in

lib/search/search.ts:285

---

allIds

▸ allIds(options?): Promise<string[]>

Returns all the entity IDs that match this query. This method makes multiple calls to Redis until all the entity IDs are returned. You can specify the batch size by setting the pageSize property on the options:

const keys = await repository.search().returnAllIds({ pageSize: 100 })

Parameters

Name	Type	Default value	Description
options	Object	undefined	Options for the call.
options.pageSize	number	10	Number of entity IDs returned per batch.

Returns

Promise<string[]>

An array of entity IDs matching the query.

Inherited from

AbstractSearch.allIds

Defined in

lib/search/search.ts:303

---

allKeys

▸ allKeys(options?): Promise<string[]>

Returns all the key names in Redis that match this query. This method makes multiple calls to Redis until all the key names are returned. You can specify the batch size by setting the pageSize property on the options:

const keys = await repository.search().returnAllKeys({ pageSize: 100 })

Parameters

Name	Type	Default value	Description
options	Object	undefined	Options for the call.
options.pageSize	number	10	Number of key names returned per batch.

Returns

Promise<string[]>

An array of key names matching the query.

Inherited from

AbstractSearch.allKeys

Defined in

lib/search/search.ts:321

---

and

▸ and(field): WhereField<T>

Sets up a query matching a particular field as a logical AND.

Parameters

Name	Type	Description
field	Exclude<keyof T, keyof EntityInternal>	The field to filter on.

Returns

WhereField<T>

A subclass of WhereField matching the type of the field.

Defined in

lib/search/search.ts:566

▸ and(subSearchFn): Search<T>

Sets up a nested search as a logical AND.

Parameters

Name	Type	Description
subSearchFn	SubSearchFunction<T>	A function that takes a Search and returns another Search.

Returns

Search<T>

this.

Defined in

lib/search/search.ts:573

---

count

▸ count(): Promise<number>

Returns the number of Entities that match this query.

Returns

Promise<number>

Inherited from

AbstractSearch.count

Defined in

lib/search/search.ts:209

---

first

▸ first(): Promise<null | T>

Returns the first Entity that matches this query.

Returns

Promise<null | T>

Inherited from

AbstractSearch.first

Defined in

lib/search/search.ts:250

---

firstId

▸ firstId(): Promise<null | string>

Returns the first entity ID that matches this query.

Returns

Promise<null | string>

Inherited from

AbstractSearch.firstId

Defined in

lib/search/search.ts:258

---

firstKey

▸ firstKey(): Promise<null | string>

Returns the first key name that matches this query.

Returns

Promise<null | string>

Inherited from

AbstractSearch.firstKey

Defined in

lib/search/search.ts:266

---

max

▸ max(field): Promise<null | T>

Finds the Entity with the maximal value for a field.

Parameters

Name	Type	Description
field	Exclude<keyof T, keyof EntityInternal>	The field with the maximal value.

Returns

Promise<null | T>

The entity ID Entity with the maximal value

Inherited from

AbstractSearch.max

Defined in

lib/search/search.ts:183

---

maxId

▸ maxId(field): Promise<null | string>

Finds the entity ID with the maximal value for a field.

Parameters

Name	Type	Description
field	Exclude<keyof T, keyof EntityInternal>	The field with the maximal value.

Returns

Promise<null | string>

The entity ID with the maximal value

Inherited from

AbstractSearch.maxId

Defined in

lib/search/search.ts:192

---

maxKey

▸ maxKey(field): Promise<null | string>

Finds the key name in Redis with the maximal value for a field.

Parameters

Name	Type	Description
field	Exclude<keyof T, keyof EntityInternal>	The field with the maximal value.

Returns

Promise<null | string>

The key name with the maximal value

Inherited from

AbstractSearch.maxKey

Defined in

lib/search/search.ts:201

---

min

▸ min(field): Promise<null | T>

Finds the Entity with the minimal value for a field.

Parameters

Name	Type	Description
field	Exclude<keyof T, keyof EntityInternal>	The field with the minimal value.

Returns

Promise<null | T>

The Entity with the minimal value

Inherited from

AbstractSearch.min

Defined in

lib/search/search.ts:156

---

minId

▸ minId(field): Promise<null | string>

Finds the entity ID with the minimal value for a field.

Parameters

Name	Type	Description
field	Exclude<keyof T, keyof EntityInternal>	The field with the minimal value.

Returns

Promise<null | string>

The entity ID with the minimal value

Inherited from

AbstractSearch.minId

Defined in

lib/search/search.ts:165

---

minKey

▸ minKey(field): Promise<null | string>

Finds the key name in Redis with the minimal value for a field.

Parameters

Name	Type	Description
field	Exclude<keyof T, keyof EntityInternal>	The field with the minimal value.

Returns

Promise<null | string>

The key name with the minimal value

Inherited from

AbstractSearch.minKey

Defined in

lib/search/search.ts:174

---

or

▸ or(field): WhereField<T>

Sets up a query matching a particular field as a logical OR.

Parameters

Name	Type	Description
field	Exclude<keyof T, keyof EntityInternal>	The field to filter on.

Returns

WhereField<T>

A subclass of WhereField matching the type of the field.

Defined in

lib/search/search.ts:585

▸ or(subSearchFn): Search<T>

Sets up a nested search as a logical OR.

Parameters

Name	Type	Description
subSearchFn	SubSearchFunction<T>	A function that takes a Search and returns another Search.

Returns

Search<T>

this.

Defined in

lib/search/search.ts:592

---

page

▸ page(offset, count): Promise<T[]>

Returns a page of Entities that match this query.

Parameters

Name	Type	Description
offset	number	The offset for where to start returning Entities.
count	number	The number of Entities to return.

Returns

Promise<T[]>

An array of Entities matching the query.

Inherited from

AbstractSearch.page

Defined in

lib/search/search.ts:220

---

pageOfIds

▸ pageOfIds(offset, count): Promise<string[]>

Returns a page of entity IDs that match this query.

Parameters

Name	Type	Description
offset	number	The offset for where to start returning entity IDs.
count	number	The number of entity IDs to return.

Returns

Promise<string[]>

An array of strings matching the query.

Inherited from

AbstractSearch.pageOfIds

Defined in

lib/search/search.ts:231

---

pageOfKeys

▸ pageOfKeys(offset, count): Promise<string[]>

Returns a page of key names in Redis that match this query.

Parameters

Name	Type	Description
offset	number	The offset for where to start returning key names.
count	number	The number of key names to return.

Returns

Promise<string[]>

An array of strings matching the query.

Inherited from

AbstractSearch.pageOfKeys

Defined in

lib/search/search.ts:242

---

returnAll

▸ returnAll(options?): Promise<T[]>

Alias for all.

Parameters

Name	Type	Default value
options	Object	undefined
options.pageSize	number	10

Returns

Promise<T[]>

Inherited from

AbstractSearch.returnAll

Defined in

lib/search/search.ts:427

---

returnAllIds

▸ returnAllIds(options?): Promise<string[]>

Alias for allIds.

Parameters

Name	Type	Default value
options	Object	undefined
options.pageSize	number	10

Returns

Promise<string[]>

Inherited from

AbstractSearch.returnAllIds

Defined in

lib/search/search.ts:434

---

returnAllKeys

▸ returnAllKeys(options?): Promise<string[]>

Alias for allKeys.

Parameters

Name	Type	Default value
options	Object	undefined
options.pageSize	number	10

Returns

Promise<string[]>

Inherited from

AbstractSearch.returnAllKeys

Defined in

lib/search/search.ts:441

---

returnCount

▸ returnCount(): Promise<number>

Alias for count.

Returns

Promise<number>

Inherited from

AbstractSearch.returnCount

Defined in

lib/search/search.ts:378

---

returnFirst

▸ returnFirst(): Promise<null | T>

Alias for first.

Returns

Promise<null | T>

Inherited from

AbstractSearch.returnFirst

Defined in

lib/search/search.ts:406

---

returnFirstId

▸ returnFirstId(): Promise<null | string>

Alias for firstId.

Returns

Promise<null | string>

Inherited from

AbstractSearch.returnFirstId

Defined in

lib/search/search.ts:413

---

returnFirstKey

▸ returnFirstKey(): Promise<null | string>

Alias for firstKey.

Returns

Promise<null | string>

Inherited from

AbstractSearch.returnFirstKey

Defined in

lib/search/search.ts:420

---

returnMax

▸ returnMax(field): Promise<null | T>

Alias for max.

Parameters

Name	Type
field	Exclude<keyof T, keyof EntityInternal>

Returns

Promise<null | T>

Inherited from

AbstractSearch.returnMax

Defined in

lib/search/search.ts:357

---

returnMaxId

▸ returnMaxId(field): Promise<null | string>

Alias for maxId.

Parameters

Name	Type
field	Exclude<keyof T, keyof EntityInternal>

Returns

Promise<null | string>

Inherited from

AbstractSearch.returnMaxId

Defined in

lib/search/search.ts:364

---

returnMaxKey

▸ returnMaxKey(field): Promise<null | string>

Alias for maxKey.

Parameters

Name	Type
field	Exclude<keyof T, keyof EntityInternal>

Returns

Promise<null | string>

Inherited from

AbstractSearch.returnMaxKey

Defined in

lib/search/search.ts:371

---

returnMin

▸ returnMin(field): Promise<null | T>

Alias for min.

Parameters

Name	Type
field	Exclude<keyof T, keyof EntityInternal>

Returns

Promise<null | T>

Inherited from

AbstractSearch.returnMin

Defined in

lib/search/search.ts:336

---

returnMinId

▸ returnMinId(field): Promise<null | string>

Alias for minId.

Parameters

Name	Type
field	Exclude<keyof T, keyof EntityInternal>

Returns

Promise<null | string>

Inherited from

AbstractSearch.returnMinId

Defined in

lib/search/search.ts:343

---

returnMinKey

▸ returnMinKey(field): Promise<null | string>

Alias for minKey.

Parameters

Name	Type
field	Exclude<keyof T, keyof EntityInternal>

Returns

Promise<null | string>

Inherited from

AbstractSearch.returnMinKey

Defined in

lib/search/search.ts:350

---

returnPage

▸ returnPage(offset, count): Promise<T[]>

Alias for page.

Parameters

Name	Type
offset	number
count	number

Returns

Promise<T[]>

Inherited from

AbstractSearch.returnPage

Defined in

lib/search/search.ts:385

---

returnPageOfIds

▸ returnPageOfIds(offset, count): Promise<string[]>

Alias for pageOfIds.

Parameters

Name	Type
offset	number
count	number

Returns

Promise<string[]>

Inherited from

AbstractSearch.returnPageOfIds

Defined in

lib/search/search.ts:392

---

returnPageOfKeys

▸ returnPageOfKeys(offset, count): Promise<string[]>

Alias for pageOfKeys.

Parameters

Name	Type
offset	number
count	number

Returns

Promise<string[]>

Inherited from

AbstractSearch.returnPageOfKeys

Defined in

lib/search/search.ts:399

---

sortAsc

▸ sortAsc(field): AbstractSearch<T>

Alias for sortAscending.

Parameters

Name	Type
field	Exclude<keyof T, keyof EntityInternal>

Returns

AbstractSearch<T>

Inherited from

AbstractSearch.sortAsc

Defined in

lib/search/search.ts:92

---

sortAscending

▸ sortAscending(field): AbstractSearch<T>

Applies an ascending sort to the query.

Parameters

Name	Type	Description
field	Exclude<keyof T, keyof EntityInternal>	The field to sort by.

Returns

AbstractSearch<T>

this

Inherited from

AbstractSearch.sortAscending

Defined in

lib/search/search.ts:69

---

sortBy

▸ sortBy(fieldName, order?): AbstractSearch<T>

Applies sorting for the query.

Parameters

Name	Type	Default value	Description
fieldName	Exclude<keyof T, keyof EntityInternal>	undefined	The field to sort by.
order	"ASC" | "DESC"	"ASC"	The order of returned Entities Defaults to ASC (ascending) if not specified

Returns

AbstractSearch<T>

this

Inherited from

AbstractSearch.sortBy

Defined in

lib/search/search.ts:102

---

sortDesc

▸ sortDesc(field): AbstractSearch<T>

Alias for sortDescending.

Parameters

Name	Type
field	Exclude<keyof T, keyof EntityInternal>

Returns

AbstractSearch<T>

Inherited from

AbstractSearch.sortDesc

Defined in

lib/search/search.ts:76

---

sortDescending

▸ sortDescending(field): AbstractSearch<T>

Applies a descending sort to the query.

Parameters

Name	Type	Description
field	Exclude<keyof T, keyof EntityInternal>	The field to sort by.

Returns

AbstractSearch<T>

this

Inherited from

AbstractSearch.sortDescending

Defined in

lib/search/search.ts:85

---

where

▸ where(field): WhereField<T>

Sets up a query matching a particular field. If there are multiple calls to where, they are treated logically as AND.

Parameters

Name	Type	Description
field	Exclude<keyof T, keyof EntityInternal>	The field to filter on.

Returns

WhereField<T>

A subclass of WhereField matching the type of the field.

Defined in

lib/search/search.ts:546

▸ where(subSearchFn): Search<T>

Sets up a nested search. If there are multiple calls to where, they are treated logically as AND.

Parameters

Name	Type	Description
subSearchFn	SubSearchFunction<T>	A function that takes a Search and returns another Search.

Returns

Search<T>

this.

Defined in

lib/search/search.ts:554