@proto-kit/persistanceDocs


Documentation / @proto-kit/persistance / PrismaRedisDatabase

Class: PrismaRedisDatabase

Lifecycle of a SequencerModule

start(): Executed to execute any logic required to start the module

Extends

Implements

Constructors

new PrismaRedisDatabase()

new PrismaRedisDatabase(tracer): PrismaRedisDatabase

Parameters

tracer: Tracer

Returns

PrismaRedisDatabase

Overrides

SequencerModule.constructor

Defined in

packages/persistance/src/PrismaRedisDatabase.ts:48

Properties

currentConfig

protected currentConfig: undefined | PrismaRedisCombinedConfig

Store the config separately, so that we can apply additional checks when retrieving it via the getter

Inherited from

SequencerModule.currentConfig

Defined in

packages/common/dist/config/ConfigurableModule.d.ts:17


prisma

prisma: PrismaDatabaseConnection

Defined in

packages/persistance/src/PrismaRedisDatabase.ts:44


redis

redis: RedisConnectionModule

Defined in

packages/persistance/src/PrismaRedisDatabase.ts:46


presets

static presets: Presets<unknown>

Inherited from

SequencerModule.presets

Defined in

packages/sequencer/dist/sequencer/builder/SequencerModule.d.ts:8

Accessors

config

Get Signature

get config(): Config

Returns

Config

Set Signature

set config(config): void

Parameters

config: Config

Returns

void

Inherited from

SequencerModule.config

Defined in

packages/common/dist/config/ConfigurableModule.d.ts:18


currentMulti

Get Signature

get currentMulti(): RedisClientMultiCommandType<object, Record<string, never>, Record<string, never>>

Returns

RedisClientMultiCommandType<object, Record<string, never>, Record<string, never>>

bf

bf: object

bf.add

bf.add: __module

bf.ADD

bf.ADD: __module

bf.card

bf.card: __module

bf.CARD

bf.CARD: __module

bf.exists

bf.exists: __module

bf.EXISTS

bf.EXISTS: __module

bf.info

bf.info: __module

bf.INFO

bf.INFO: __module

bf.insert

bf.insert: __module

bf.INSERT

bf.INSERT: __module

bf.loadChunk

bf.loadChunk: __module

bf.LOADCHUNK

bf.LOADCHUNK: __module

bf.mAdd

bf.mAdd: __module

bf.MADD

bf.MADD: __module

bf.mExists

bf.mExists: __module

bf.MEXISTS

bf.MEXISTS: __module

bf.reserve

bf.reserve: __module

bf.RESERVE

bf.RESERVE: __module

bf.scanDump

bf.scanDump: __module

bf.SCANDUMP

bf.SCANDUMP: __module

cf

cf: object

cf.add

cf.add: __module

cf.ADD

cf.ADD: __module

cf.addNX

cf.addNX: __module

cf.ADDNX

cf.ADDNX: __module

cf.count

cf.count: __module

cf.COUNT

cf.COUNT: __module

cf.del

cf.del: __module

cf.DEL

cf.DEL: __module

cf.exists

cf.exists: __module

cf.EXISTS

cf.EXISTS: __module

cf.info

cf.info: __module

cf.INFO

cf.INFO: __module

cf.insert

cf.insert: __module

cf.INSERT

cf.INSERT: __module

cf.insertNX

cf.insertNX: __module

cf.INSERTNX

cf.INSERTNX: __module

cf.loadChunk

cf.loadChunk: __module

cf.LOADCHUNK

cf.LOADCHUNK: __module

cf.reserve

cf.reserve: __module

cf.RESERVE

cf.RESERVE: __module

cf.scanDump

cf.scanDump: __module

cf.SCANDUMP

cf.SCANDUMP: __module

cms

cms: object

cms.incrBy

cms.incrBy: __module

cms.INCRBY

cms.INCRBY: __module

cms.info

cms.info: __module

cms.INFO

cms.INFO: __module

cms.initByDim

cms.initByDim: __module

cms.INITBYDIM

cms.INITBYDIM: __module

cms.initByProb

cms.initByProb: __module

cms.INITBYPROB

cms.INITBYPROB: __module

cms.merge

cms.merge: __module

cms.MERGE

cms.MERGE: __module

cms.query

cms.query: __module

cms.QUERY

cms.QUERY: __module

ft

ft: object

ft._list

ft._list: __module

ft._LIST

ft._LIST: __module

ft.aggregate

ft.aggregate: __module

ft.AGGREGATE

ft.AGGREGATE: __module

ft.AGGREGATE_WITHCURSOR

ft.AGGREGATE_WITHCURSOR: __module

ft.aggregateWithCursor

ft.aggregateWithCursor: __module

ft.aliasAdd

ft.aliasAdd: __module

ft.ALIASADD

ft.ALIASADD: __module

ft.aliasDel

ft.aliasDel: __module

ft.ALIASDEL

ft.ALIASDEL: __module

ft.aliasUpdate

ft.aliasUpdate: __module

ft.ALIASUPDATE

ft.ALIASUPDATE: __module

ft.alter

ft.alter: __module

ft.ALTER

ft.ALTER: __module

ft.CONFIG_GET

ft.CONFIG_GET: __module

ft.CONFIG_SET

ft.CONFIG_SET: __module

ft.configGet

ft.configGet: __module

ft.configSet

ft.configSet: __module

ft.create

ft.create: __module

ft.CREATE

ft.CREATE: __module

ft.CURSOR_DEL

ft.CURSOR_DEL: __module

ft.CURSOR_READ

ft.CURSOR_READ: __module

ft.cursorDel

ft.cursorDel: __module

ft.cursorRead

ft.cursorRead: __module

ft.dictAdd

ft.dictAdd: __module

ft.DICTADD

ft.DICTADD: __module

ft.dictDel

ft.dictDel: __module

ft.DICTDEL

ft.DICTDEL: __module

ft.dictDump

ft.dictDump: __module

ft.DICTDUMP

ft.DICTDUMP: __module

ft.dropIndex

ft.dropIndex: __module

ft.DROPINDEX

ft.DROPINDEX: __module

ft.explain

ft.explain: __module

ft.EXPLAIN

ft.EXPLAIN: __module

ft.explainCli

ft.explainCli: __module

ft.EXPLAINCLI

ft.EXPLAINCLI: __module

ft.info

ft.info: __module

ft.INFO

ft.INFO: __module

ft.profileAggregate

ft.profileAggregate: __module

ft.PROFILEAGGREGATE

ft.PROFILEAGGREGATE: __module

ft.profileSearch

ft.profileSearch: __module

ft.PROFILESEARCH

ft.PROFILESEARCH: __module

ft.search

ft.search: __module

ft.SEARCH

ft.SEARCH: __module

ft.SEARCH_NOCONTENT

ft.SEARCH_NOCONTENT: __module

ft.searchNoContent

ft.searchNoContent: __module

ft.spellCheck

ft.spellCheck: __module

ft.SPELLCHECK

ft.SPELLCHECK: __module

ft.sugAdd

ft.sugAdd: __module

ft.SUGADD

ft.SUGADD: __module

ft.sugDel

ft.sugDel: __module

ft.SUGDEL

ft.SUGDEL: __module

ft.sugGet

ft.sugGet: __module

ft.SUGGET

ft.SUGGET: __module

ft.SUGGET_WITHPAYLOADS

ft.SUGGET_WITHPAYLOADS: __module

ft.SUGGET_WITHSCORES

ft.SUGGET_WITHSCORES: __module

ft.SUGGET_WITHSCORES_WITHPAYLOADS

ft.SUGGET_WITHSCORES_WITHPAYLOADS: __module

ft.sugGetWithPayloads

ft.sugGetWithPayloads: __module

ft.sugGetWithScores

ft.sugGetWithScores: __module

ft.sugGetWithScoresWithPayloads

ft.sugGetWithScoresWithPayloads: __module

ft.sugLen

ft.sugLen: __module

ft.SUGLEN

ft.SUGLEN: __module

ft.synDump

ft.synDump: __module

ft.SYNDUMP

ft.SYNDUMP: __module

ft.synUpdate

ft.synUpdate: __module

ft.SYNUPDATE

ft.SYNUPDATE: __module

ft.tagVals

ft.tagVals: __module

ft.TAGVALS

ft.TAGVALS: __module

graph

graph: object

graph.CONFIG_GET

graph.CONFIG_GET: __module

graph.CONFIG_SET

graph.CONFIG_SET: __module

graph.configGet

graph.configGet: __module

graph.configSet

graph.configSet: __module

graph.delete

graph.delete: __module

graph.DELETE

graph.DELETE: __module

graph.explain

graph.explain: __module

graph.EXPLAIN

graph.EXPLAIN: __module

graph.list

graph.list: __module

graph.LIST

graph.LIST: __module

graph.profile

graph.profile: __module

graph.PROFILE

graph.PROFILE: __module

graph.query

graph.query: __module

graph.QUERY

graph.QUERY: __module

graph.RO_QUERY

graph.RO_QUERY: __module

graph.roQuery

graph.roQuery: __module

graph.slowLog

graph.slowLog: __module

graph.SLOWLOG

graph.SLOWLOG: __module

json

json: object

json.arrAppend

json.arrAppend: __module

json.ARRAPPEND

json.ARRAPPEND: __module

json.arrIndex

json.arrIndex: __module

json.ARRINDEX

json.ARRINDEX: __module

json.arrInsert

json.arrInsert: __module

json.ARRINSERT

json.ARRINSERT: __module

json.arrLen

json.arrLen: __module

json.ARRLEN

json.ARRLEN: __module

json.arrPop

json.arrPop: __module

json.ARRPOP

json.ARRPOP: __module

json.arrTrim

json.arrTrim: __module

json.ARRTRIM

json.ARRTRIM: __module

json.DEBUG_MEMORY

json.DEBUG_MEMORY: __module

json.debugMemory

json.debugMemory: __module

json.del

json.del: __module

json.DEL

json.DEL: __module

json.forget

json.forget: __module

json.FORGET

json.FORGET: __module

json.get

json.get: __module

json.GET

json.GET: __module

json.merge

json.merge: __module

json.MERGE

json.MERGE: __module

json.mGet

json.mGet: __module

json.MGET

json.MGET: __module

json.mSet

json.mSet: __module

json.MSET

json.MSET: __module

json.numIncrBy

json.numIncrBy: __module

json.NUMINCRBY

json.NUMINCRBY: __module

json.numMultBy

json.numMultBy: __module

json.NUMMULTBY

json.NUMMULTBY: __module

json.objKeys

json.objKeys: __module

json.OBJKEYS

json.OBJKEYS: __module

json.objLen

json.objLen: __module

json.OBJLEN

json.OBJLEN: __module

json.resp

json.resp: __module

json.RESP

json.RESP: __module

json.set

json.set: __module

json.SET

json.SET: __module

json.strAppend

json.strAppend: __module

json.STRAPPEND

json.STRAPPEND: __module

json.strLen

json.strLen: __module

json.STRLEN

json.STRLEN: __module

json.type

json.type: __module

json.TYPE

json.TYPE: __module

tDigest

tDigest: object

tDigest.add

tDigest.add: __module

tDigest.ADD

tDigest.ADD: __module

tDigest.byRank

tDigest.byRank: __module

tDigest.BYRANK

tDigest.BYRANK: __module

tDigest.byRevRank

tDigest.byRevRank: __module

tDigest.BYREVRANK

tDigest.BYREVRANK: __module

tDigest.cdf

tDigest.cdf: __module

tDigest.CDF

tDigest.CDF: __module

tDigest.create

tDigest.create: __module

tDigest.CREATE

tDigest.CREATE: __module

tDigest.info

tDigest.info: __module

tDigest.INFO

tDigest.INFO: __module

tDigest.max

tDigest.max: __module

tDigest.MAX

tDigest.MAX: __module

tDigest.merge

tDigest.merge: __module

tDigest.MERGE

tDigest.MERGE: __module

tDigest.min

tDigest.min: __module

tDigest.MIN

tDigest.MIN: __module

tDigest.quantile

tDigest.quantile: __module

tDigest.QUANTILE

tDigest.QUANTILE: __module

tDigest.rank

tDigest.rank: __module

tDigest.RANK

tDigest.RANK: __module

tDigest.reset

tDigest.reset: __module

tDigest.RESET

tDigest.RESET: __module

tDigest.revRank

tDigest.revRank: __module

tDigest.REVRANK

tDigest.REVRANK: __module

tDigest.TRIMMED_MEAN

tDigest.TRIMMED_MEAN: __module

tDigest.trimmedMean

tDigest.trimmedMean: __module

topK

topK: object

topK.add

topK.add: __module

topK.ADD

topK.ADD: __module

topK.count

topK.count: __module

topK.COUNT

topK.COUNT: __module

topK.incrBy

topK.incrBy: __module

topK.INCRBY

topK.INCRBY: __module

topK.info

topK.info: __module

topK.INFO

topK.INFO: __module

topK.list

topK.list: __module

topK.LIST

topK.LIST: __module

topK.LIST_WITHCOUNT

topK.LIST_WITHCOUNT: __module

topK.listWithCount

topK.listWithCount: __module

topK.query

topK.query: __module

topK.QUERY

topK.QUERY: __module

topK.reserve

topK.reserve: __module

topK.RESERVE

topK.RESERVE: __module

ts

ts: object

ts.add

ts.add: __module

ts.ADD

ts.ADD: __module

ts.alter

ts.alter: __module

ts.ALTER

ts.ALTER: __module

ts.create

ts.create: __module

ts.CREATE

ts.CREATE: __module

ts.createRule

ts.createRule: __module

ts.CREATERULE

ts.CREATERULE: __module

ts.decrBy

ts.decrBy: __module

ts.DECRBY

ts.DECRBY: __module

ts.del

ts.del: __module

ts.DEL

ts.DEL: __module

ts.deleteRule

ts.deleteRule: __module

ts.DELETERULE

ts.DELETERULE: __module

ts.get

ts.get: __module

ts.GET

ts.GET: __module

ts.incrBy

ts.incrBy: __module

ts.INCRBY

ts.INCRBY: __module

ts.info

ts.info: __module

ts.INFO

ts.INFO: __module

ts.INFO_DEBUG

ts.INFO_DEBUG: __module

ts.infoDebug

ts.infoDebug: __module

ts.mAdd

ts.mAdd: __module

ts.MADD

ts.MADD: __module

ts.mGet

ts.mGet: __module

ts.MGET

ts.MGET: __module

ts.MGET_WITHLABELS

ts.MGET_WITHLABELS: __module

ts.mGetWithLabels

ts.mGetWithLabels: __module

ts.mRange

ts.mRange: __module

ts.MRANGE

ts.MRANGE: __module

ts.MRANGE_WITHLABELS

ts.MRANGE_WITHLABELS: __module

ts.mRangeWithLabels

ts.mRangeWithLabels: __module

ts.mRevRange

ts.mRevRange: __module

ts.MREVRANGE

ts.MREVRANGE: __module

ts.MREVRANGE_WITHLABELS

ts.MREVRANGE_WITHLABELS: __module

ts.mRevRangeWithLabels

ts.mRevRangeWithLabels: __module

ts.queryIndex

ts.queryIndex: __module

ts.QUERYINDEX

ts.QUERYINDEX: __module

ts.range

ts.range: __module

ts.RANGE

ts.RANGE: __module

ts.revRange

ts.revRange: __module

ts.REVRANGE

ts.REVRANGE: __module

Implementation of

RedisConnection.currentMulti

Defined in

packages/persistance/src/PrismaRedisDatabase.ts:62


prismaClient

Get Signature

get prismaClient(): PrismaClient<PrismaClientOptions, never, DefaultArgs>

Returns

PrismaClient<PrismaClientOptions, never, DefaultArgs>

Implementation of

PrismaConnection.prismaClient

Defined in

packages/persistance/src/PrismaRedisDatabase.ts:54


redisClient

Get Signature

get redisClient(): RedisClientType

Returns

RedisClientType

Implementation of

RedisConnection.redisClient

Defined in

packages/persistance/src/PrismaRedisDatabase.ts:58

Methods

close()

close(): Promise<void>

Returns

Promise<void>

Implementation of

Database.close

Defined in

packages/persistance/src/PrismaRedisDatabase.ts:92


create()

create(childContainerProvider): void

Parameters

childContainerProvider: ChildContainerProvider

Returns

void

Overrides

SequencerModule.create

Defined in

packages/persistance/src/PrismaRedisDatabase.ts:66


executeInTransaction()

executeInTransaction(f): Promise<void>

Parameters

f

Returns

Promise<void>

Implementation of

Database.executeInTransaction

Defined in

packages/persistance/src/PrismaRedisDatabase.ts:102


pruneDatabase()

pruneDatabase(): Promise<void>

Prunes all data from the database connection. Note: This function should only be called immediately at startup, everything else will lead to unexpected behaviour and errors

Returns

Promise<void>

Implementation of

Prunable.pruneDatabase

Defined in

packages/persistance/src/PrismaRedisDatabase.ts:97


start()

start(): Promise<void>

Start the module and all it’s functionality. The returned Promise has to resolve after initialization, since it will block in the sequencer init. That means that you mustn’t await server.start() for example.

Returns

Promise<void>

Overrides

SequencerModule.start

Defined in

packages/persistance/src/PrismaRedisDatabase.ts:79


dependencies()

static dependencies(): StorageDependencyMinimumDependencies<PrismaRedisDatabase>

Returns

StorageDependencyMinimumDependencies<PrismaRedisDatabase>

Defined in

packages/persistance/src/PrismaRedisDatabase.ts:72