Class: RedisAdapter

Defined in: src/nosql/adapters/RedisAdapter.ts:36

Redis adapter for entityTS NoSQL and key-value/document caching.

Implements INoSqlAdapter for JSON document storage with built-in in-memory fallback, plus direct Redis key-value, hash, and set operations.

Implements

• INoSqlAdapter

Constructors

Constructor

new RedisAdapter(options?): RedisAdapter

Defined in: src/nosql/adapters/RedisAdapter.ts:44

Parameters

Parameter	Type
options	RedisAdapterOptions

Returns

RedisAdapter

Methods

connect()

connect(): Promise<void>

Defined in: src/nosql/adapters/RedisAdapter.ts:48

Returns

Promise<void>

Implementation of

INoSqlAdapter.connect

---

disconnect()

disconnect(): Promise<void>

Defined in: src/nosql/adapters/RedisAdapter.ts:53

Returns

Promise<void>

Implementation of

INoSqlAdapter.disconnect

---

ping()

ping(): Promise<boolean>

Defined in: src/nosql/adapters/RedisAdapter.ts:58

Returns

Promise<boolean>

Implementation of

INoSqlAdapter.ping

---

get()

get(key): Promise<string | null>

Defined in: src/nosql/adapters/RedisAdapter.ts:64

Parameters

Parameter	Type
key	string

Returns

Promise<string | null>

---

set()

set(key, value, ttlSeconds?): Promise<void>

Defined in: src/nosql/adapters/RedisAdapter.ts:68

Parameters

Parameter	Type
key	string
value	string
ttlSeconds?	number

Returns

Promise<void>

---

del()

del(key): Promise<boolean>

Defined in: src/nosql/adapters/RedisAdapter.ts:75

Parameters

Parameter	Type
key	string

Returns

Promise<boolean>

---

hget()

hget(hash, field): Promise<string | null>

Defined in: src/nosql/adapters/RedisAdapter.ts:79

Parameters

Parameter	Type
hash	string
field	string

Returns

Promise<string | null>

---

hset()

hset(hash, field, value): Promise<void>

Defined in: src/nosql/adapters/RedisAdapter.ts:84

Parameters

Parameter	Type
hash	string
field	string
value	string

Returns

Promise<void>

---

hgetall()

hgetall(hash): Promise<Record<string, string>>

Defined in: src/nosql/adapters/RedisAdapter.ts:93

Parameters

Parameter	Type
hash	string

Returns

Promise<Record<string, string>>

---

insertOne()

insertOne<T>(collection, doc, options?): Promise<InsertOneResult>

Defined in: src/nosql/adapters/RedisAdapter.ts:101

Type Parameters

Type Parameter	Default type
T	unknown

Parameters

Parameter	Type
collection	string
doc	T
options?	InsertOptions

Returns

Promise<InsertOneResult>

Implementation of

INoSqlAdapter.insertOne

---

insertMany()

insertMany<T>(collection, docs, options?): Promise<InsertManyResult>

Defined in: src/nosql/adapters/RedisAdapter.ts:109

Type Parameters

Type Parameter	Default type
T	unknown

Parameters

Parameter	Type
collection	string
docs	T[]
options?	InsertOptions

Returns

Promise<InsertManyResult>

Implementation of

INoSqlAdapter.insertMany

---

find()

find<T>(collection, filter?, options?): Promise<T[]>

Defined in: src/nosql/adapters/RedisAdapter.ts:117

Type Parameters

Type Parameter	Default type
T	unknown

Parameters

Parameter	Type
collection	string
filter?	NoSqlFilter
options?	FindOptions

Returns

Promise<T[]>

Implementation of

INoSqlAdapter.find

---

findOne()

findOne<T>(collection, filter?, options?): Promise<T | null>

Defined in: src/nosql/adapters/RedisAdapter.ts:125

Type Parameters

Type Parameter	Default type
T	unknown

Parameters

Parameter	Type
collection	string
filter?	NoSqlFilter
options?	Omit<FindOptions, "limit">

Returns

Promise<T | null>

Implementation of

INoSqlAdapter.findOne

---

updateOne()

updateOne(collection, filter, update, options?): Promise<UpdateResult>

Defined in: src/nosql/adapters/RedisAdapter.ts:133

Parameters

Parameter	Type
collection	string
filter	NoSqlFilter
update	NoSqlUpdate
options?	UpdateOptions

Returns

Promise<UpdateResult>

Implementation of

INoSqlAdapter.updateOne

---

updateMany()

updateMany(collection, filter, update, options?): Promise<UpdateResult>

Defined in: src/nosql/adapters/RedisAdapter.ts:142

Parameters

Parameter	Type
collection	string
filter	NoSqlFilter
update	NoSqlUpdate
options?	UpdateOptions

Returns

Promise<UpdateResult>

Implementation of

INoSqlAdapter.updateMany

---

deleteOne()

deleteOne(collection, filter, options?): Promise<DeleteResult>

Defined in: src/nosql/adapters/RedisAdapter.ts:151

Parameters

Parameter	Type
collection	string
filter	NoSqlFilter
options?	DeleteOptions

Returns

Promise<DeleteResult>

Implementation of

INoSqlAdapter.deleteOne

---

deleteMany()

deleteMany(collection, filter, options?): Promise<DeleteResult>

Defined in: src/nosql/adapters/RedisAdapter.ts:159

Parameters

Parameter	Type
collection	string
filter	NoSqlFilter
options?	DeleteOptions

Returns

Promise<DeleteResult>

Implementation of

INoSqlAdapter.deleteMany

---

countDocuments()

countDocuments(collection, filter?, options?): Promise<number>

Defined in: src/nosql/adapters/RedisAdapter.ts:167

Parameters

Parameter	Type
collection	string
filter?	NoSqlFilter
options?	CountOptions

Returns

Promise<number>

Implementation of

INoSqlAdapter.countDocuments

---

aggregate()

aggregate<T>(collection, pipeline, options?): Promise<T[]>

Defined in: src/nosql/adapters/RedisAdapter.ts:175

Type Parameters

Type Parameter	Default type
T	unknown

Parameters

Parameter	Type
collection	string
pipeline	AggregationStage[]
options?	AggregateOptions

Returns

Promise<T[]>

Implementation of

INoSqlAdapter.aggregate

---

beginTransaction()

beginTransaction(): Promise<NoSqlTransaction>

Defined in: src/nosql/adapters/RedisAdapter.ts:183

Returns

Promise<NoSqlTransaction>

Implementation of

INoSqlAdapter.beginTransaction

---

createIndex()

createIndex(collection, keys, options?): Promise<string>

Defined in: src/nosql/adapters/RedisAdapter.ts:187

Parameters

Parameter	Type
collection	string
keys	Record<string, 1 | -1 | "text" | "2dsphere" | string>
options?	{ unique?: boolean; name?: string; }
options.unique?	boolean
options.name?	string

Returns

Promise<string>

Implementation of

INoSqlAdapter.createIndex

---

getCollection()

getCollection<T>(name): T

Defined in: src/nosql/adapters/RedisAdapter.ts:195

Type Parameters

Type Parameter	Default type
T	any

Parameters

Parameter	Type
name	string

Returns

T

Implementation of

INoSqlAdapter.getCollection

Properties

provider

readonly provider: NoSqlProvider = 'redis'

Defined in: src/nosql/adapters/RedisAdapter.ts:37

Implementation of

INoSqlAdapter.provider

---

options

readonly options: RedisAdapterOptions

Defined in: src/nosql/adapters/RedisAdapter.ts:42