Class MapTripleStore<Id, V>

Map-based TripleStore.

Type Parameters

Hierarchy

BaseTripleStore<Id, V>
- MapTripleStore

Implements

TripleStore<Id, V>
AsyncIterable<[EntityAttrKey<Id>, V]>

Index

Constructors

constructor

new MapTripleStore<Id, V>(data?, index?, batchSize?): MapTripleStore<Id, V>
Type Parameters
- Id
- V
Parameters
- data: MaybeAsyncMapBatch<EntityAttrKey<Id>, V> & RangeQueryable<EntityAttrKey<Id>, V> = ...
  Map of data entries.
- index: MaybeAsyncMapBatch<AttrIndexKey<Id>, Id> & RangeQueryable<AttrIndexKey<Id>, Id> = ...
  Map of field value index.
- batchSize: number = 50
  Max size of a request batch.
Returns MapTripleStore<Id, V>
Overrides BaseTripleStore.constructor
- Defined in collections/src/triplestore/mapstore.ts:15

Properties

`Protected` `Readonly` batchSize

batchSize: number = 50

Max size of a request batch.

`Protected` `Readonly` data

data: MaybeAsyncMapBatch<EntityAttrKey<Id>, V> & RangeQueryable<EntityAttrKey<Id>, V> = ...

Map of data entries.

`Protected` `Readonly` index

index: MaybeAsyncMapBatch<AttrIndexKey<Id>, Id> & RangeQueryable<AttrIndexKey<Id>, Id> = ...

Map of field value index.

Accessors

[rangeQueryable]

get [rangeQueryable](): true
Marker to indicate that this object is a RangeQueryable.

Returns true
Implementation of TripleStore.[rangeQueryable]
Inherited from BaseTripleStore.[rangeQueryable]
- Defined in collections/src/triplestore/base.ts:88

[toStringTag]

get [toStringTag](): string
Returns string
Overrides BaseTripleStore.[toStringTag]
- Defined in collections/src/triplestore/mapstore.ts:178

Methods

[asyncIterator]

[asyncIterator](): AsyncIterator<[EntityAttrKey<Id>, V], any, undefined>
Returns AsyncIterator<[EntityAttrKey<Id>, V], any, undefined>
Implementation of AsyncIterable.[asyncIterator]
Inherited from BaseTripleStore.[asyncIterator]
- Defined in collections/src/triplestore/base.ts:84

delete

delete(key, options?): Promise<void>
Deletes an entry by key from the map. Returns MaybePromise<unknown> to be compatible with ES Map.
Parameters
- key: EntityAttrKey<Id>
- Optional options: AbortOptions
Returns Promise<void>
Implementation of TripleStore.delete
Inherited from BaseTripleStore.delete
- Defined in collections/src/triplestore/base.ts:56

deleteMany

deleteMany(keys, options?): MaybeAsyncIterableIterator<undefined | Error>
Deletes the values with given keys.
Parameters
- keys: Iterable<EntityAttrKey<Id>>
- Optional options: AbortOptions
Returns MaybeAsyncIterableIterator<undefined | Error>
Implementation of TripleStore.deleteMany
Inherited from BaseTripleStore.deleteMany
- Defined in collections/src/triplestore/base.ts:78

entries

entries(options?): AsyncIterableIterator<[EntityAttrKey<Id>, V]>
Queries key-value pairs by given criteria.
Parameters
- Optional options: RangeQueryOptions<EntityAttrSearchKey<Id>>
Returns AsyncIterableIterator<[EntityAttrKey<Id>, V]>
Implementation of TripleStore.entries
Overrides BaseTripleStore.entries
- Defined in collections/src/triplestore/mapstore.ts:30

entriesByAttr

entriesByAttr(options?): AsyncIterableIterator<[EntityAttrKey<Id>, V]>
Iterates entries by given attribute key range.
Parameters
- Optional options: RangeQueryOptions<AttrSearchKey>
Returns AsyncIterableIterator<[EntityAttrKey<Id>, V]>
Implementation of TripleStore.entriesByAttr
Overrides BaseTripleStore.entriesByAttr
- Defined in collections/src/triplestore/mapstore.ts:76

findMany

findMany(keys, options?): IterableIterator<AsyncIterableIterator<[EntityAttrKey<Id>, V]>>
Finds matching entries for given list of entity-attribute search keys.
Parameters
- keys: Iterable<EntityAttrSearchKey<Id>>
- Optional options: AbortOptions
Returns IterableIterator<AsyncIterableIterator<[EntityAttrKey<Id>, V]>>
Implementation of TripleStore.findMany
Overrides BaseTripleStore.findMany
- Defined in collections/src/triplestore/mapstore.ts:92

findManyByAttr

findManyByAttr(keys, options?): IterableIterator<MaybeAsyncIterableIterator<[EntityAttrKey<Id>, V]>>
Finds matching entries for given list of attribute-value search keys.
Parameters
- keys: Iterable<AttrSearchKey>
- Optional options: AbortOptions
Returns IterableIterator<MaybeAsyncIterableIterator<[EntityAttrKey<Id>, V]>>
Implementation of TripleStore.findManyByAttr
Overrides BaseTripleStore.findManyByAttr
- Defined in collections/src/triplestore/mapstore.ts:100

get

get(key, options?): Promise<undefined | V>
Gets a value by key from the map.
Parameters
- key: EntityAttrKey<Id>
- Optional options: AbortOptions
Returns Promise<undefined | V>
Implementation of TripleStore.get
Inherited from BaseTripleStore.get
- Defined in collections/src/triplestore/base.ts:47

`Private` getEntriesMany

getEntriesMany(keys, options?): AsyncIterableIterator<[EntityAttrKey<Id>, V]>
Parameters
- keys: EntityAttrKey<Id>[]
- Optional options: AbortOptions
Returns AsyncIterableIterator<[EntityAttrKey<Id>, V]>
- Defined in collections/src/triplestore/mapstore.ts:182

getMany

getMany(keys, options?): MaybeAsyncIterableIterator<undefined | V>
Gets the list of data identified by given keys.
Parameters
- keys: Iterable<EntityAttrKey<Id>>
- Optional options: AbortOptions
Returns MaybeAsyncIterableIterator<undefined | V>
Implementation of TripleStore.getMany
Overrides BaseTripleStore.getMany
- Defined in collections/src/triplestore/mapstore.ts:108

has

has(key, options?): Promise<boolean>
Returns whether a key exists in the map.
Parameters
- key: EntityAttrKey<Id>
- Optional options: AbortOptions
Returns Promise<boolean>
Implementation of TripleStore.has
Inherited from BaseTripleStore.has
- Defined in collections/src/triplestore/base.ts:51

hasMany

hasMany(keys, options?): AsyncIterableIterator<boolean>
Checks if given keys exist in the set.
Parameters
- keys: Iterable<EntityAttrKey<Id>>
- Optional options: AbortOptions
Returns AsyncIterableIterator<boolean>
Implementation of TripleStore.hasMany
Inherited from BaseTripleStore.hasMany
- Defined in collections/src/triplestore/base.ts:68

keys

keys(options?): AsyncIterableIterator<EntityAttrKey<Id>>
Queries keys by given criteria.
Parameters
- Optional options: RangeQueryOptions<EntityAttrSearchKey<Id>>
Returns AsyncIterableIterator<EntityAttrKey<Id>>
Implementation of TripleStore.keys
Inherited from BaseTripleStore.keys
- Defined in collections/src/triplestore/base.ts:31

keysByAttr

keysByAttr(options?): AsyncIterableIterator<EntityAttrKey<Id>>
Iterates keys by given attribute key range.
Parameters
- Optional options: RangeQueryOptions<AttrSearchKey>
Returns AsyncIterableIterator<EntityAttrKey<Id>>
Implementation of TripleStore.keysByAttr
Overrides BaseTripleStore.keysByAttr
- Defined in collections/src/triplestore/mapstore.ts:55

set

set(key, value, options?): Promise<void>
Sets an entry in the map. Returns MaybePromise<unknown> to be compatible with ES Map.
Parameters
- key: EntityAttrKey<Id>
- value: V
- Optional options: AbortOptions
Returns Promise<void>
Implementation of TripleStore.set
Inherited from BaseTripleStore.set
- Defined in collections/src/triplestore/base.ts:62

setMany

setMany(entries, options?): MaybeAsyncIterableIterator<undefined | Error>
Sets given list of entries.
Parameters
- entries: Iterable<readonly [EntityAttrKey<Id>, V]>
- Optional options: AbortOptions
Returns MaybeAsyncIterableIterator<undefined | Error>
Implementation of TripleStore.setMany
Inherited from BaseTripleStore.setMany
- Defined in collections/src/triplestore/base.ts:72

updateMany

updateMany(entries, options?): AsyncIterableIterator<undefined | CodedError<EntityAttrKey<Id>, unknown>>
Sets or deletes given list of entries.
Parameters
- entries: Iterable<readonly [EntityAttrKey<Id>, undefined | V]>
- Optional options: AbortOptions
Returns AsyncIterableIterator<undefined | CodedError<EntityAttrKey<Id>, unknown>>
Implementation of TripleStore.updateMany
Overrides BaseTripleStore.updateMany
- Defined in collections/src/triplestore/mapstore.ts:114

values

values(options?): AsyncIterableIterator<V>
Queries values by given criteria.
Parameters
- Optional options: RangeQueryOptions<EntityAttrSearchKey<Id>>
Returns AsyncIterableIterator<V>
Implementation of TripleStore.values
Inherited from BaseTripleStore.values
- Defined in collections/src/triplestore/base.ts:35

valuesByAttr

valuesByAttr(options?): AsyncIterableIterator<V>
Iterates values by given attribute key range.
Parameters
- Optional options: RangeQueryOptions<AttrSearchKey>
Returns AsyncIterableIterator<V>
Implementation of TripleStore.valuesByAttr
Inherited from BaseTripleStore.valuesByAttr
- Defined in collections/src/triplestore/base.ts:43

Class MapTripleStore<Id, V>

Type Parameters

Id

V

Hierarchy

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

Id

V

Parameters

data: MaybeAsyncMapBatch<EntityAttrKey<Id>, V> & RangeQueryable<EntityAttrKey<Id>, V> = ...

index: MaybeAsyncMapBatch<AttrIndexKey<Id>, Id> & RangeQueryable<AttrIndexKey<Id>, Id> = ...

batchSize: number = 50

Returns MapTripleStore<Id, V>

Properties

Protected Readonly batchSize

Protected Readonly data

Protected Readonly index

Accessors

[rangeQueryable]

Returns true

[toStringTag]

Returns string

Methods

[asyncIterator]

Returns AsyncIterator<[EntityAttrKey<Id>, V], any, undefined>

delete

Parameters

key: EntityAttrKey<Id>

Optional options: AbortOptions

Returns Promise<void>

deleteMany

Parameters

keys: Iterable<EntityAttrKey<Id>>

Optional options: AbortOptions

Returns MaybeAsyncIterableIterator<undefined | Error>

entries

Parameters

Optional options: RangeQueryOptions<EntityAttrSearchKey<Id>>

Returns AsyncIterableIterator<[EntityAttrKey<Id>, V]>

entriesByAttr

Parameters

Optional options: RangeQueryOptions<AttrSearchKey>

Returns AsyncIterableIterator<[EntityAttrKey<Id>, V]>

findMany

Parameters

keys: Iterable<EntityAttrSearchKey<Id>>

Optional options: AbortOptions

Returns IterableIterator<AsyncIterableIterator<[EntityAttrKey<Id>, V]>>

findManyByAttr

Parameters

keys: Iterable<AttrSearchKey>

Optional options: AbortOptions

Returns IterableIterator<MaybeAsyncIterableIterator<[EntityAttrKey<Id>, V]>>

get

Parameters

key: EntityAttrKey<Id>

Optional options: AbortOptions

Returns Promise<undefined | V>

Private getEntriesMany

Parameters

keys: EntityAttrKey<Id>[]

Optional options: AbortOptions

Returns AsyncIterableIterator<[EntityAttrKey<Id>, V]>

getMany

Parameters

keys: Iterable<EntityAttrKey<Id>>

Optional options: AbortOptions

Returns MaybeAsyncIterableIterator<undefined | V>

has

Parameters

key: EntityAttrKey<Id>

Optional options: AbortOptions

`Protected` `Readonly` batchSize

`Protected` `Readonly` data

`Protected` `Readonly` index

`Optional` options: AbortOptions

`Optional` options: AbortOptions

`Optional` options: RangeQueryOptions<EntityAttrSearchKey<Id>>

`Optional` options: RangeQueryOptions<AttrSearchKey>

`Optional` options: AbortOptions

`Optional` options: AbortOptions

`Optional` options: AbortOptions

`Private` getEntriesMany

`Optional` options: AbortOptions

`Optional` options: AbortOptions

`Optional` options: AbortOptions

`Optional` options: AbortOptions

`Optional` options: RangeQueryOptions<EntityAttrSearchKey<Id>>

`Optional` options: RangeQueryOptions<AttrSearchKey>

`Optional` options: AbortOptions

`Optional` options: AbortOptions

`Optional` options: AbortOptions

`Optional` options: RangeQueryOptions<EntityAttrSearchKey<Id>>

`Optional` options: RangeQueryOptions<AttrSearchKey>