Class TieredDatastore

A datastore that can combine multiple stores. Puts and deletes will write through to all datastores. Has and get will try each store sequentially. Query will always try the last one first.

Hierarchy (View Summary)

BaseDatastore
- TieredDatastore

Index

Constructors

constructor

Methods

_all _allKeys batch delete deleteMany get getMany has put putMany query queryKeys

Constructors

constructor

new TieredDatastore(
stores: Datastore<{}, {}, {}, {}, {}, {}, {}, {}, {}, {}>[],
): TieredDatastore
Parameters
- stores: Datastore<{}, {}, {}, {}, {}, {}, {}, {}, {}, {}>[]
Returns TieredDatastore
Overrides BaseDatastore.constructor
- Defined in tiered.ts:19

Methods

_all

_all(q: Query, options?: AbortOptions): AwaitIterable<Pair>
Extending classes should override query or implement this method
Parameters
- q: Query
- Optionaloptions: AbortOptions
Returns AwaitIterable<Pair>
Inherited from BaseDatastore._all
- Defined in base.ts:73

_allKeys

_allKeys(q: KeyQuery, options?: AbortOptions): AwaitIterable<Key>
Extending classes should override queryKeys or implement this method
Parameters
- q: KeyQuery
- Optionaloptions: AbortOptions
Returns AwaitIterable<Key>
Inherited from BaseDatastore._allKeys
- Defined in base.ts:81

batch

batch(): Batch
This will return an object with which you can chain multiple operations together, with them only being executed on calling commit.

Returns Batch
Example
```
const b = store.batch()

for (let i = 0; i < 100; i++) {
  b.put(new Key(`hello${i}`), new TextEncoder('utf8').encode(`hello world ${i}`))
}

await b.commit()
console.log('put 100 values')
```
Overrides BaseDatastore.batch
- Defined in tiered.ts:86

delete

delete(key: Key, options?: AbortOptions): Promise<void>
Remove the record for the passed key
Parameters
- key: Key
- Optionaloptions: AbortOptions
Returns Promise<void>
Example
```
await store.delete(new Key('awesome'))
console.log('deleted awesome content :(')
```
Overrides BaseDatastore.delete
- Defined in tiered.ts:64

deleteMany

deleteMany(
source: AwaitIterable<Key>,
options?: AbortOptions,
): AsyncIterable<Key>
Remove values for the passed keys
Parameters
- source: AwaitIterable<Key>
- options: AbortOptions = {}
Returns AsyncIterable<Key>
Example
```
const source = [new Key('awesome')]

for await (const key of store.deleteMany(source)) {
  console.log(`deleted content with key ${key}`)
}
```
Overrides BaseDatastore.deleteMany
- Defined in tiered.ts:79

get

get(key: Key, options?: AbortOptions): Promise<Uint8Array<ArrayBufferLike>>
Retrieve the value stored under the given key
Parameters
- key: Key
- Optionaloptions: AbortOptions
Returns Promise<Uint8Array<ArrayBufferLike>>
Example
```
const value = await store.get(new Key('awesome'))
console.log('got content: %s', value.toString('utf8'))
// => got content: datastore
```
Overrides BaseDatastore.get
- Defined in tiered.ts:35

getMany

getMany(source: AwaitIterable<Key>, options?: AbortOptions): AwaitIterable<Pair>
Retrieve values for the passed keys
Parameters
- source: AwaitIterable<Key>
- options: AbortOptions = {}
Returns AwaitIterable<Pair>
Example
```
for await (const { key, value } of store.getMany([new Key('awesome')])) {
  console.log(`got "${key}" = "${new TextDecoder('utf8').decode(value)}"`')
  // => got "/awesome" = "datastore"
}
```
Inherited from BaseDatastore.getMany
- Defined in base.ts:32

has

has(key: Key, options?: AbortOptions): Promise<boolean>
Check for the existence of a value for the passed key
Parameters
- key: Key
- Optionaloptions: AbortOptions
Returns Promise<boolean>
Example
```
const exists = await store.has(new Key('awesome'))

if (exists) {
 console.log('it is there')
} else {
 console.log('it is not there')
}
```
Overrides BaseDatastore.has
- Defined in tiered.ts:54

put

put(key: Key, value: Uint8Array, options?: AbortOptions): Promise<Key>
Store the passed value under the passed key
Parameters
- key: Key
- value: Uint8Array
- Optionaloptions: AbortOptions
Returns Promise<Key>
Example
```
await store.put([{ key: new Key('awesome'), value: new Uint8Array([0, 1, 2, 3]) }])
```
Overrides BaseDatastore.put
- Defined in tiered.ts:25

putMany

putMany(source: AwaitIterable<Pair>, options?: AbortOptions): AsyncIterable<Key>
Store the given key/value pairs
Parameters
- source: AwaitIterable<Pair>
- options: AbortOptions = {}
Returns AsyncIterable<Key>
Example
```
const source = [{ key: new Key('awesome'), value: new Uint8Array([0, 1, 2, 3]) }]

for await (const { key, value } of store.putMany(source)) {
  console.info(`put content for key ${key}`)
}
```
Overrides BaseDatastore.putMany
- Defined in tiered.ts:72

query

query(q: Query, options?: AbortOptions): AwaitIterable<Pair>
Query the datastore.
Parameters
- q: Query
- Optionaloptions: AbortOptions
Returns AwaitIterable<Pair>
Example
```
// retrieve __all__ key/value pairs from the store
let list = []
for await (const { key, value } of store.query({})) {
  list.push(value)
}
console.log('ALL THE VALUES', list)
```
Overrides BaseDatastore.query
- Defined in tiered.ts:104

queryKeys

queryKeys(q: KeyQuery, options?: AbortOptions): AwaitIterable<Key>
Query the datastore.
Parameters
- q: KeyQuery
- Optionaloptions: AbortOptions
Returns AwaitIterable<Key>
Example
```
// retrieve __all__ keys from the store
let list = []
for await (const key of store.queryKeys({})) {
  list.push(key)
}
console.log('ALL THE KEYS', key)
```
Overrides BaseDatastore.queryKeys
- Defined in tiered.ts:108

Class TieredDatastore

Hierarchy (View Summary)

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns TieredDatastore

Methods

_all

Parameters

Returns AwaitIterable<Pair>

_allKeys

Parameters

Returns AwaitIterable<Key>

batch

Returns Batch

Example

delete

Parameters

Returns Promise<void>

Example

deleteMany

Parameters

Returns AsyncIterable<Key>

Example

get

Parameters

Returns Promise<Uint8Array<ArrayBufferLike>>

Example

getMany

Parameters

Returns AwaitIterable<Pair>

Example

has

Parameters

Returns Promise<boolean>

Example

put

Parameters

Returns Promise<Key>

Example

putMany

Parameters

Returns AsyncIterable<Key>

Example

query

Parameters

Returns AwaitIterable<Pair>

Example

queryKeys

Parameters

Returns AwaitIterable<Key>

Example

Settings

On This Page