Class TieredBlockstore

A blockstore that can combine multiple stores. Puts and deletes will write through to all blockstores. Has and get will try each store sequentially. getAll will use every store but also deduplicate any yielded pairs.

Hierarchy (View Summary)

BaseBlockstore
- TieredBlockstore

Index

Constructors

constructor

Methods

delete deleteMany get getAll getMany has put putMany

Constructors

constructor

new TieredBlockstore(
stores: Blockstore<{}, {}, {}, {}, {}, {}, {}, {}>[],
): TieredBlockstore
Parameters
- stores: Blockstore<{}, {}, {}, {}, {}, {}, {}, {}>[]
Returns TieredBlockstore
Overrides BaseBlockstore.constructor
- Defined in tiered.ts:21

Methods

delete

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

deleteMany

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

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

get

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

getAll

getAll(options?: AbortOptions): AwaitGenerator<Pair>
Extending classes should override query or implement this method
Parameters
- Optionaloptions: AbortOptions
Returns AwaitGenerator<Pair>
Overrides BaseBlockstore.getAll
- Defined in tiered.ts:85

getMany

getMany(
source: AwaitIterable<CID<unknown, number, number, Version>>,
options?: AbortOptions,
): AwaitGenerator<Pair>
Retrieve values for the passed keys
Parameters
- source: AwaitIterable<CID<unknown, number, number, Version>>
- Optionaloptions: AbortOptions
Returns AwaitGenerator<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 BaseBlockstore.getMany
- Defined in base.ts:25

has

has(key: CID, options?: AbortOptions): Promise<boolean>
Check for the existence of a value for the passed key
Parameters
- key: CID
- 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 BaseBlockstore.has
- Defined in tiered.ts:53

put

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

putMany

putMany(
source: AwaitIterable<InputPair>,
options?: AbortOptions,
): AwaitGenerator<CID<unknown, number, number, Version>>
Store the given key/value pairs
Parameters
- source: AwaitIterable<InputPair>
- options: AbortOptions = {}
Returns AwaitGenerator<CID<unknown, number, number, Version>>
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 BaseBlockstore.putMany
- Defined in tiered.ts:71

Class TieredBlockstore

Hierarchy (View Summary)

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns TieredBlockstore

Methods

delete

Parameters

Returns Promise<void>

Example

deleteMany

Parameters

Returns AwaitGenerator<CID<unknown, number, number, Version>>

Example

get

Parameters

Returns AwaitGenerator<Uint8Array<ArrayBufferLike>>

Example

getAll

Parameters

Returns AwaitGenerator<Pair>

getMany

Parameters

Returns AwaitGenerator<Pair>

Example

has

Parameters

Returns Promise<boolean>

Example

put

Parameters

Returns Promise<CID<unknown, number, number, Version>>

Example

putMany

Parameters

Returns AwaitGenerator<CID<unknown, number, number, Version>>

Example

Settings

On This Page