RawSearch.md

redis-om / RawSearch

Class: RawSearch

Entry point to raw search which allows using raw RediSearch queries against Redis OM. Requires that RediSearch (and optionally RedisJSON) be installed.

template The type of Entity being sought.

Hierarchy

• AbstractSearch

  ↳ RawSearch

Table of contents

Accessors

• return

Methods

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

Accessors

return

• get return(): AbstractSearch

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

Returns

AbstractSearch

this

Inherited from

AbstractSearch.return

Methods

all

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

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<Entity[]>

An array of Entities matching the query.

Inherited from

AbstractSearch.all

---

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

---

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

---

count

▸ count(): Promise<number>

Returns the number of Entities that match this query.

Returns

Promise<number>

Inherited from

AbstractSearch.count

---

first

▸ first(): Promise<null | Entity>

Returns the first Entity that matches this query.

Returns

Promise<null | Entity>

Inherited from

AbstractSearch.first

---

firstId

▸ firstId(): Promise<null | string>

Returns the first entity ID that matches this query.

Returns

Promise<null | string>

Inherited from

AbstractSearch.firstId

---

firstKey

▸ firstKey(): Promise<null | string>

Returns the first key name that matches this query.

Returns

Promise<null | string>

Inherited from

AbstractSearch.firstKey

---

max

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

Finds the Entity with the maximal value for a field.

Parameters

Name	Type	Description
field	string	The field with the maximal value.

Returns

Promise<null | Entity>

The entity ID Entity with the maximal value

Inherited from

AbstractSearch.max

---

maxId

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

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

Parameters

Name	Type	Description
field	string	The field with the maximal value.

Returns

Promise<null | string>

The entity ID with the maximal value

Inherited from

AbstractSearch.maxId

---

maxKey

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

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

Parameters

Name	Type	Description
field	string	The field with the maximal value.

Returns

Promise<null | string>

The key name with the maximal value

Inherited from

AbstractSearch.maxKey

---

min

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

Finds the Entity with the minimal value for a field.

Parameters

Name	Type	Description
field	string	The field with the minimal value.

Returns

Promise<null | Entity>

The Entity with the minimal value

Inherited from

AbstractSearch.min

---

minId

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

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

Parameters

Name	Type	Description
field	string	The field with the minimal value.

Returns

Promise<null | string>

The entity ID with the minimal value

Inherited from

AbstractSearch.minId

---

minKey

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

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

Parameters

Name	Type	Description
field	string	The field with the minimal value.

Returns

Promise<null | string>

The key name with the minimal value

Inherited from

AbstractSearch.minKey

---

page

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

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<Entity[]>

An array of Entities matching the query.

Inherited from

AbstractSearch.page

---

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

---

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

---

returnAll

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

Alias for all.

Parameters

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

Returns

Promise<Entity[]>

Inherited from

AbstractSearch.returnAll

---

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

---

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

---

returnCount

▸ returnCount(): Promise<number>

Alias for count.

Returns

Promise<number>

Inherited from

AbstractSearch.returnCount

---

returnFirst

▸ returnFirst(): Promise<null | Entity>

Alias for first.

Returns

Promise<null | Entity>

Inherited from

AbstractSearch.returnFirst

---

returnFirstId

▸ returnFirstId(): Promise<null | string>

Alias for firstId.

Returns

Promise<null | string>

Inherited from

AbstractSearch.returnFirstId

---

returnFirstKey

▸ returnFirstKey(): Promise<null | string>

Alias for firstKey.

Returns

Promise<null | string>

Inherited from

AbstractSearch.returnFirstKey

---

returnMax

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

Alias for max.

Parameters

Name	Type
field	string

Returns

Promise<null | Entity>

Inherited from

AbstractSearch.returnMax

---

returnMaxId

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

Alias for maxId.

Parameters

Name	Type
field	string

Returns

Promise<null | string>

Inherited from

AbstractSearch.returnMaxId

---

returnMaxKey

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

Alias for maxKey.

Parameters

Name	Type
field	string

Returns

Promise<null | string>

Inherited from

AbstractSearch.returnMaxKey

---

returnMin

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

Alias for min.

Parameters

Name	Type
field	string

Returns

Promise<null | Entity>

Inherited from

AbstractSearch.returnMin

---

returnMinId

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

Alias for minId.

Parameters

Name	Type
field	string

Returns

Promise<null | string>

Inherited from

AbstractSearch.returnMinId

---

returnMinKey

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

Alias for minKey.

Parameters

Name	Type
field	string

Returns

Promise<null | string>

Inherited from

AbstractSearch.returnMinKey

---

returnPage

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

Alias for page.

Parameters

Name	Type
offset	number
count	number

Returns

Promise<Entity[]>

Inherited from

AbstractSearch.returnPage

---

returnPageOfIds

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

Alias for pageOfIds.

Parameters

Name	Type
offset	number
count	number

Returns

Promise<string[]>

Inherited from

AbstractSearch.returnPageOfIds

---

returnPageOfKeys

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

Alias for pageOfKeys.

Parameters

Name	Type
offset	number
count	number

Returns

Promise<string[]>

Inherited from

AbstractSearch.returnPageOfKeys

---

sortAsc

▸ sortAsc(field): AbstractSearch

Alias for sortAscending.

Parameters

Name	Type
field	string

Returns

AbstractSearch

Inherited from

AbstractSearch.sortAsc

---

sortAscending

▸ sortAscending(field): AbstractSearch

Applies an ascending sort to the query.

Parameters

Name	Type	Description
field	string	The field to sort by.

Returns

AbstractSearch

this

Inherited from

AbstractSearch.sortAscending

---

sortBy

▸ sortBy(fieldName, order?): AbstractSearch

Applies sorting for the query.

Parameters

Name	Type	Default value	Description
fieldName	string	undefined	-
order	"ASC" | "DESC"	'ASC'	The order of returned Entities Defaults to ASC (ascending) if not specified

Returns

AbstractSearch

this

Inherited from

AbstractSearch.sortBy

---

sortDesc

▸ sortDesc(field): AbstractSearch

Alias for sortDescending.

Parameters

Name	Type
field	string

Returns

AbstractSearch

Inherited from

AbstractSearch.sortDesc

---

sortDescending

▸ sortDescending(field): AbstractSearch

Applies a descending sort to the query.

Parameters

Name	Type	Description
field	string	The field to sort by.

Returns

AbstractSearch

this

Inherited from

AbstractSearch.sortDescending