Class EntityStorage<Entity>

Defines the storage handler class for different entities.

Type Parameters

Entity

Hierarchy

EntityIndexStorage<Entity, Entity>
- EntityStorage
  - Utils.PendingWorkStorage
  - PendingWorkStorage

Constructors

constructor

new EntityStorage<Entity>(options: EntityStorageOptions<Entity>, StorageClass?: typeof LevelStorage): EntityStorage<Entity>
Type Parameters
- Entity
Parameters
- options: EntityStorageOptions<Entity>
- StorageClass: typeof LevelStorage = LevelStorage
Returns EntityStorage<Entity>
Overrides EntityIndexStorage.constructor
- Defined in packages/core/src/storage/entityStorage.ts:54

Properties

`Protected` StorageClass

StorageClass: typeof LevelStorage = LevelStorage

`Protected` atomicOpMutex

atomicOpMutex: Mutex

`Protected` byIndex

byIndex: Record<string, EntityIndexStorage<Entity, Entity>> = {}

`Protected` count

count: number = 0

`Protected` noopMutex

noopMutex: Promise<(() => void)> = ...

`Protected` options

options: EntityStorageOptions<Entity>

`Protected` self

self: typeof EntityIndexStorage

`Protected` storage

storage: LevelStorage<string | Entity> = ...

`Static` AddressLength

AddressLength: number = EntityIndexStorage.AddressLength

`Static` EthereumAddressLength

EthereumAddressLength: number = EntityIndexStorage.EthereumAddressLength

`Static` TimestampLength

TimestampLength: number = EntityIndexStorage.TimestampLength

`Static` VariableLength

VariableLength: number = EntityIndexStorage.VariableLength

`Static` keyValueDelimiter

keyValueDelimiter: string = '|'

Methods

backup

backup(): Promise<void>
Returns Promise<void>
Inherited from EntityIndexStorage.backup
- Defined in packages/core/src/storage/entityIndexStorage.ts:650

exists

exists(key: string, options?: EntityIndexStorageInvokeOptions): Promise<boolean>
Parameters
- key: string
- Optional options: EntityIndexStorageInvokeOptions
Returns Promise<boolean>
Inherited from EntityIndexStorage.exists
- Defined in packages/core/src/storage/entityIndexStorage.ts:364

`Protected` filterItem

filterItem(item: undefined | StorageEntry<string, Entity>): Promise<boolean>
Parameters
- item: undefined | StorageEntry<string, Entity>
Returns Promise<boolean>
Inherited from EntityIndexStorage.filterItem
- Defined in packages/core/src/storage/entityIndexStorage.ts:618

get

get(key: string | Stringifable[], options?: EntityIndexStorageInvokeOptions): Promise<undefined | Entity>
Parameters
- key: string | Stringifable[]
- Optional options: EntityIndexStorageInvokeOptions
Returns Promise<undefined | Entity>
Inherited from EntityIndexStorage.get
- Defined in packages/core/src/storage/entityIndexStorage.ts:299

getAll

getAll(options?: EntityIndexStorageGetStreamOptions<Entity>): Promise<StorageStream<string, Entity>>
Parameters
- Optional options: EntityIndexStorageGetStreamOptions<Entity>
Returns Promise<StorageStream<string, Entity>>
Inherited from EntityIndexStorage.getAll
- Defined in packages/core/src/storage/entityIndexStorage.ts:112

getAllFromTo

getAllFromTo(start?: Stringifable[], end?: Stringifable[], options?: EntityIndexStorageGetStreamOptions<Entity>): Promise<StorageStream<string, Entity>>
Parameters
- Optional start: Stringifable[]
- Optional end: Stringifable[]
- options: EntityIndexStorageGetStreamOptions<Entity> = ...
Returns Promise<StorageStream<string, Entity>>
Inherited from EntityIndexStorage.getAllFromTo
- Defined in packages/core/src/storage/entityIndexStorage.ts:156

getAllKeys

getAllKeys(options?: EntityIndexStorageGetStreamOptions<Entity>): Promise<StorageKeyStream<string>>
Parameters
- Optional options: EntityIndexStorageGetStreamOptions<Entity>
Returns Promise<StorageKeyStream<string>>
Inherited from EntityIndexStorage.getAllKeys
- Defined in packages/core/src/storage/entityIndexStorage.ts:118

getAllKeysFromTo

getAllKeysFromTo(start?: Stringifable[], end?: Stringifable[], options?: EntityIndexStorageGetStreamOptions<Entity>): Promise<StorageKeyStream<string>>
Parameters
- Optional start: Stringifable[]
- Optional end: Stringifable[]
- Optional options: EntityIndexStorageGetStreamOptions<Entity>
Returns Promise<StorageKeyStream<string>>
Inherited from EntityIndexStorage.getAllKeysFromTo
- Defined in packages/core/src/storage/entityIndexStorage.ts:185

`Protected` getAllSubkeysStartingFrom

getAllSubkeysStartingFrom(entity: Entity, chunk?: number, prevSubkeys?: string[]): string[]
Parameters
- entity: Entity
- chunk: number = 0
- prevSubkeys: string[] = []
Returns string[]
Inherited from EntityIndexStorage.getAllSubkeysStartingFrom
- Defined in packages/core/src/storage/entityIndexStorage.ts:439

getAllValues

getAllValues(options?: EntityIndexStorageGetStreamOptions<Entity>): Promise<StorageValueStream<Entity>>
Parameters
- Optional options: EntityIndexStorageGetStreamOptions<Entity>
Returns Promise<StorageValueStream<Entity>>
Inherited from EntityIndexStorage.getAllValues
- Defined in packages/core/src/storage/entityIndexStorage.ts:125

getAllValuesFromTo

getAllValuesFromTo(start?: Stringifable[], end?: Stringifable[], options?: EntityIndexStorageGetStreamOptions<Entity>): Promise<StorageValueStream<Entity>>
Parameters
- Optional start: Stringifable[]
- Optional end: Stringifable[]
- Optional options: EntityIndexStorageGetStreamOptions<Entity>
Returns Promise<StorageValueStream<Entity>>
Inherited from EntityIndexStorage.getAllValuesFromTo
- Defined in packages/core/src/storage/entityIndexStorage.ts:194

`Protected` getAtomicOpMutex

getAtomicOpMutex(atomic?: boolean): Promise<(() => void)>
Parameters
- atomic: boolean = false
Returns Promise<(() => void)>
Overrides EntityIndexStorage.getAtomicOpMutex
- Defined in packages/core/src/storage/entityStorage.ts:210

getBatch

getBatch(): StorageBatch<string, string | Entity>
Returns StorageBatch<string, string | Entity>
Inherited from EntityIndexStorage.getBatch
- Defined in packages/core/src/storage/entityIndexStorage.ts:108

getCount

getCount(options?: EntityIndexStorageInvokeOptions): Promise<number>
Parameters
- Optional options: EntityIndexStorageInvokeOptions
Returns Promise<number>
Inherited from EntityIndexStorage.getCount
- Defined in packages/core/src/storage/entityIndexStorage.ts:96

`Protected` getCountDelta

getCountDelta(items: string[], isDelete: boolean, fixedCount?: number): Promise<number>
Parameters
- items: string[]
- isDelete: boolean
- Optional fixedCount: number
Returns Promise<number>
Inherited from EntityIndexStorage.getCountDelta
- Defined in packages/core/src/storage/entityIndexStorage.ts:636

`Protected` getEntityGroups

getEntityGroups(entities: Entity[], op: EntityUpdateOp): Promise<{
toRemove: Entity[];
toUpdate: Entity[];
}>
Parameters
- entities: Entity[]
- op: EntityUpdateOp
Returns Promise<{
toRemove: Entity[];
toUpdate: Entity[];
}>
- Defined in packages/core/src/storage/entityStorage.ts:170

getFirstItemFromTo

getFirstItemFromTo(start?: Stringifable[], end?: Stringifable[], options?: EntityIndexStorageInvokeOptions): Promise<undefined | StorageEntry<string, Entity>>
Parameters
- Optional start: Stringifable[]
- Optional end: Stringifable[]
- Optional options: EntityIndexStorageInvokeOptions
Returns Promise<undefined | StorageEntry<string, Entity>>
Inherited from EntityIndexStorage.getFirstItemFromTo
- Defined in packages/core/src/storage/entityIndexStorage.ts:203

getFirstKey

getFirstKey(options?: EntityIndexStorageInvokeOptions): Promise<undefined | string>
Parameters
- Optional options: EntityIndexStorageInvokeOptions
Returns Promise<undefined | string>
Inherited from EntityIndexStorage.getFirstKey
- Defined in packages/core/src/storage/entityIndexStorage.ts:132

getFirstKeyFromTo

getFirstKeyFromTo(start?: Stringifable[], end?: Stringifable[], options?: EntityIndexStorageInvokeOptions): Promise<undefined | string>
Parameters
- Optional start: Stringifable[]
- Optional end: Stringifable[]
- Optional options: EntityIndexStorageInvokeOptions
Returns Promise<undefined | string>
Inherited from EntityIndexStorage.getFirstKeyFromTo
- Defined in packages/core/src/storage/entityIndexStorage.ts:233

getFirstValue

getFirstValue(options?: EntityIndexStorageInvokeOptions): Promise<undefined | Entity>
Parameters
- Optional options: EntityIndexStorageInvokeOptions
Returns Promise<undefined | Entity>
Inherited from EntityIndexStorage.getFirstValue
- Defined in packages/core/src/storage/entityIndexStorage.ts:144

getFirstValueFromTo

getFirstValueFromTo(start?: Stringifable[], end?: Stringifable[], options?: EntityIndexStorageInvokeOptions): Promise<undefined | Entity>
Parameters
- Optional start: Stringifable[]
- Optional end: Stringifable[]
- Optional options: EntityIndexStorageInvokeOptions
Returns Promise<undefined | Entity>
Inherited from EntityIndexStorage.getFirstValueFromTo
- Defined in packages/core/src/storage/entityIndexStorage.ts:242

`Protected` getKeyChunk

getKeyChunk(key: Stringifable, chunk?: number): undefined | string
Parameters
- key: Stringifable
- chunk: number = 0
Returns undefined | string
Inherited from EntityIndexStorage.getKeyChunk
- Defined in packages/core/src/storage/entityIndexStorage.ts:481

getKeys

getKeys(entity: Entity): string[]
Parameters
- entity: Entity
Returns string[]
Inherited from EntityIndexStorage.getKeys
- Defined in packages/core/src/storage/entityIndexStorage.ts:435

getLastItemFromTo

getLastItemFromTo(start?: Stringifable[], end?: Stringifable[], options?: EntityIndexStorageInvokeOptions): Promise<undefined | StorageEntry<string, Entity>>
Parameters
- Optional start: Stringifable[]
- Optional end: Stringifable[]
- Optional options: EntityIndexStorageInvokeOptions
Returns Promise<undefined | StorageEntry<string, Entity>>
Inherited from EntityIndexStorage.getLastItemFromTo
- Defined in packages/core/src/storage/entityIndexStorage.ts:251

getLastKey

getLastKey(options?: EntityIndexStorageInvokeOptions): Promise<undefined | string>
Parameters
- Optional options: EntityIndexStorageInvokeOptions
Returns Promise<undefined | string>
Inherited from EntityIndexStorage.getLastKey
- Defined in packages/core/src/storage/entityIndexStorage.ts:138

getLastKeyFromTo

getLastKeyFromTo(start?: Stringifable[], end?: Stringifable[], options?: EntityIndexStorageInvokeOptions): Promise<undefined | string>
Parameters
- Optional start: Stringifable[]
- Optional end: Stringifable[]
- Optional options: EntityIndexStorageInvokeOptions
Returns Promise<undefined | string>
Inherited from EntityIndexStorage.getLastKeyFromTo
- Defined in packages/core/src/storage/entityIndexStorage.ts:281

getLastValue

getLastValue(options?: EntityIndexStorageInvokeOptions): Promise<undefined | Entity>
Parameters
- Optional options: EntityIndexStorageInvokeOptions
Returns Promise<undefined | Entity>
Inherited from EntityIndexStorage.getLastValue
- Defined in packages/core/src/storage/entityIndexStorage.ts:150

getLastValueFromTo

getLastValueFromTo(start?: Stringifable[], end?: Stringifable[], options?: EntityIndexStorageInvokeOptions): Promise<undefined | Entity>
Parameters
- Optional start: Stringifable[]
- Optional end: Stringifable[]
- Optional options: EntityIndexStorageInvokeOptions
Returns Promise<undefined | Entity>
Inherited from EntityIndexStorage.getLastValueFromTo
- Defined in packages/core/src/storage/entityIndexStorage.ts:290

getMany

getMany(keys: string[] | Stringifable[][], options?: EntityIndexStorageInvokeOptions): Promise<Entity[]>
Parameters
- keys: string[] | Stringifable[][]
- Optional options: EntityIndexStorageInvokeOptions
Returns Promise<Entity[]>
Inherited from EntityIndexStorage.getMany
- Defined in packages/core/src/storage/entityIndexStorage.ts:334

`Protected` getValue

getValue(entity: Entity): string | Entity
Parameters
- entity: Entity
Returns string | Entity
Inherited from EntityIndexStorage.getValue
- Defined in packages/core/src/storage/entityIndexStorage.ts:517

init

init(): Promise<void>
Returns Promise<void>
Inherited from EntityIndexStorage.init
- Defined in packages/core/src/storage/entityIndexStorage.ts:80

`Protected` mapItem

mapItem(options: undefined | EntityIndexStorageInvokeOptions, item: StorageEntry<string, string | Entity>): Promise<undefined | StorageEntry<string, Entity>>
Parameters
- options: undefined | EntityIndexStorageInvokeOptions
- item: StorageEntry<string, string | Entity>
Returns Promise<undefined | StorageEntry<string, Entity>>
Inherited from EntityIndexStorage.mapItem
- Defined in packages/core/src/storage/entityIndexStorage.ts:555

`Protected` mapItemToKey

mapItemToKey(item: StorageEntry<string, Entity>): string
Parameters
- item: StorageEntry<string, Entity>
Returns string
Inherited from EntityIndexStorage.mapItemToKey
- Defined in packages/core/src/storage/entityIndexStorage.ts:624

`Protected` mapItemToValue

mapItemToValue(item: StorageEntry<string, Entity>): Entity
Parameters
- item: StorageEntry<string, Entity>
Returns Entity
Inherited from EntityIndexStorage.mapItemToValue
- Defined in packages/core/src/storage/entityIndexStorage.ts:628

`Protected` mapItems

mapItems(stream: StorageStream<string, string | Entity>, options: StorageCommonOptions): StorageStream<string, Entity>
Parameters
- stream: StorageStream<string, string | Entity>
- options: StorageCommonOptions
Returns StorageStream<string, Entity>
Inherited from EntityIndexStorage.mapItems
- Defined in packages/core/src/storage/entityIndexStorage.ts:546

`Protected` mapKeyChunks

mapKeyChunks(chunks?: Stringifable[], isEnd?: boolean): undefined | string[]
Parameters
- Optional chunks: Stringifable[]
- isEnd: boolean = false
Returns undefined | string[]
Inherited from EntityIndexStorage.mapKeyChunks
- Defined in packages/core/src/storage/entityIndexStorage.ts:529

`Protected` mapManyItem

mapManyItem(options: undefined | EntityIndexStorageGetStreamOptions<Entity>, items: StorageEntry<string, string | Entity>[]): Promise<StorageEntry<string, Entity>[]>
Parameters
- options: undefined | EntityIndexStorageGetStreamOptions<Entity>
- items: StorageEntry<string, string | Entity>[]
Returns Promise<StorageEntry<string, Entity>[]>
Inherited from EntityIndexStorage.mapManyItem
- Defined in packages/core/src/storage/entityIndexStorage.ts:589

remove

remove(entities: Entity | Entity[]): Promise<void>
Parameters
- entities: Entity | Entity[]
Returns Promise<void>
Overrides EntityIndexStorage.remove
- Defined in packages/core/src/storage/entityStorage.ts:135

restore

restore(): Promise<boolean>
Returns Promise<boolean>
Inherited from EntityIndexStorage.restore
- Defined in packages/core/src/storage/entityIndexStorage.ts:654

save

save(entities: Entity | Entity[]): Promise<void>
Parameters
- entities: Entity | Entity[]
Returns Promise<void>
Overrides EntityIndexStorage.save
- Defined in packages/core/src/storage/entityStorage.ts:99

useIndex

useIndex(indexName?: string): EntityIndexStorage<Entity, Entity>
Parameters
- Optional indexName: string
Returns EntityIndexStorage<Entity, Entity>
- Defined in packages/core/src/storage/entityStorage.ts:88

Class EntityStorage<Entity>

Type Parameters

Entity

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Type Parameters

Entity

Parameters

options: EntityStorageOptions<Entity>

StorageClass: typeof LevelStorage = LevelStorage

Returns EntityStorage<Entity>

Properties

Protected StorageClass

Protected atomicOpMutex

Protected byIndex

Protected count

Protected noopMutex

Protected options

Protected self

Protected storage

Static AddressLength

Static EthereumAddressLength

Static TimestampLength

Static VariableLength

Static keyValueDelimiter

Methods

backup

Returns Promise<void>

exists

Parameters

key: string

Optional options: EntityIndexStorageInvokeOptions

Returns Promise<boolean>

Protected filterItem

Parameters

item: undefined | StorageEntry<string, Entity>

Returns Promise<boolean>

get

Parameters

key: string | Stringifable[]

Optional options: EntityIndexStorageInvokeOptions

Returns Promise<undefined | Entity>

getAll

Parameters

Optional options: EntityIndexStorageGetStreamOptions<Entity>

Returns Promise<StorageStream<string, Entity>>

getAllFromTo

Parameters

Optional start: Stringifable[]

Optional end: Stringifable[]

options: EntityIndexStorageGetStreamOptions<Entity> = ...

Returns Promise<StorageStream<string, Entity>>

getAllKeys

Parameters

Optional options: EntityIndexStorageGetStreamOptions<Entity>

Returns Promise<StorageKeyStream<string>>

getAllKeysFromTo

Parameters

Optional start: Stringifable[]

Optional end: Stringifable[]

Optional options: EntityIndexStorageGetStreamOptions<Entity>

Returns Promise<StorageKeyStream<string>>

Protected getAllSubkeysStartingFrom

Parameters

entity: Entity

chunk: number = 0

prevSubkeys: string[] = []

Returns string[]

getAllValues

Parameters

Optional options: EntityIndexStorageGetStreamOptions<Entity>

Returns Promise<StorageValueStream<Entity>>

getAllValuesFromTo

Parameters

Optional start: Stringifable[]

`Protected` StorageClass

`Protected` atomicOpMutex

`Protected` byIndex

`Protected` count

`Protected` noopMutex

`Protected` options

`Protected` self

`Protected` storage

`Static` AddressLength

`Static` EthereumAddressLength

`Static` TimestampLength

`Static` VariableLength

`Static` keyValueDelimiter

`Optional` options: EntityIndexStorageInvokeOptions

`Protected` filterItem

`Optional` options: EntityIndexStorageInvokeOptions

`Optional` options: EntityIndexStorageGetStreamOptions<Entity>

`Optional` start: Stringifable[]

`Optional` end: Stringifable[]

`Optional` options: EntityIndexStorageGetStreamOptions<Entity>

`Optional` start: Stringifable[]

`Optional` end: Stringifable[]

`Optional` options: EntityIndexStorageGetStreamOptions<Entity>

`Protected` getAllSubkeysStartingFrom

`Optional` options: EntityIndexStorageGetStreamOptions<Entity>

`Optional` start: Stringifable[]

`Optional` end: Stringifable[]

`Optional` options: EntityIndexStorageGetStreamOptions<Entity>

`Protected` getAtomicOpMutex

`Optional` options: EntityIndexStorageInvokeOptions

`Protected` getCountDelta

`Optional` fixedCount: number

`Protected` getEntityGroups

Returns Promise<{
toRemove: Entity[];
toUpdate: Entity[];
}>

`Optional` start: Stringifable[]

`Optional` end: Stringifable[]

`Optional` options: EntityIndexStorageInvokeOptions

`Optional` options: EntityIndexStorageInvokeOptions

`Optional` start: Stringifable[]

`Optional` end: Stringifable[]

`Optional` options: EntityIndexStorageInvokeOptions

`Optional` options: EntityIndexStorageInvokeOptions

`Optional` start: Stringifable[]

`Optional` end: Stringifable[]

`Optional` options: EntityIndexStorageInvokeOptions

`Protected` getKeyChunk

`Optional` start: Stringifable[]

`Optional` end: Stringifable[]

`Optional` options: EntityIndexStorageInvokeOptions

`Optional` options: EntityIndexStorageInvokeOptions