Class S3Datastore

A datastore backed by AWS S3

Hierarchy (View Summary)

BaseDatastore
- S3Datastore

Index

Constructors

constructor

new S3Datastore(s3: S3, bucket: string, init?: S3DatastoreInit): S3Datastore
Parameters
- s3: S3
- bucket: string
- Optionalinit: S3DatastoreInit
Returns S3Datastore
Overrides BaseDatastore.constructor
- Defined in datastore-s3/src/index.ts:79

Properties

createIfMissing

createIfMissing: boolean

`Optional`path

path?: string

Methods

_all

_all(q: Query, options?: AbortOptions): AwaitGenerator<Pair>
Extending classes should override query or implement this method
Parameters
- q: Query
- Optionaloptions: AbortOptions
Returns AwaitGenerator<Pair>
Overrides BaseDatastore._all
- Defined in datastore-s3/src/index.ts:266

_allKeys

_allKeys(q: KeyQuery, options?: AbortOptions): AwaitGenerator<Key>
Extending classes should override queryKeys or implement this method
Parameters
- q: KeyQuery
- Optionaloptions: AbortOptions
Returns AwaitGenerator<Key>
Overrides BaseDatastore._allKeys
- Defined in datastore-s3/src/index.ts:284

_getFullKey

_getFullKey(key: Key): string
Returns the full key which includes the path to the ipfs store
Parameters
- key: Key
Returns string
- Defined in datastore-s3/src/index.ts:99

_listKeys

_listKeys(
params: { Prefix?: string; StartAfter?: string },
options?: AbortOptions,
): AsyncIterable<Key>
Recursively fetches all keys from s3
Parameters
- params: { Prefix?: string; StartAfter?: string }
- Optionaloptions: AbortOptions
Returns AsyncIterable<Key>
- Defined in datastore-s3/src/index.ts:224

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')
```
Inherited from BaseDatastore.batch
- Defined in datastore-core/dist/src/base.d.ts:11

delete

delete(key: Key, options?: AbortOptions): Promise<void>
Delete the record under the given key
Parameters
- key: Key
- Optionaloptions: AbortOptions
Returns Promise<void>
Overrides BaseDatastore.delete
- Defined in datastore-s3/src/index.ts:205

deleteMany

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

for await (const key of store.deleteMany(source)) {
  console.log(`deleted content with key ${key}`)
}
```
Inherited from BaseDatastore.deleteMany
- Defined in datastore-core/dist/src/base.d.ts:10

get

get(key: Key, options?: AbortOptions): Promise<Uint8Array<ArrayBufferLike>>
Read from s3
Parameters
- key: Key
- Optionaloptions: AbortOptions
Returns Promise<Uint8Array<ArrayBufferLike>>
Overrides BaseDatastore.get
- Defined in datastore-s3/src/index.ts:129

getMany

getMany(
source: AwaitIterable<Key>,
options?: AbortOptions,
): AwaitGenerator<Pair>
Retrieve values for the passed keys
Parameters
- source: AwaitIterable<Key>
- 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 BaseDatastore.getMany
- Defined in datastore-core/dist/src/base.d.ts:9

has

has(key: Key, options?: AbortOptions): Promise<boolean>
Check for the existence of the given key
Parameters
- key: Key
- Optionaloptions: AbortOptions
Returns Promise<boolean>
Overrides BaseDatastore.has
- Defined in datastore-s3/src/index.ts:174

open

open(options?: AbortOptions): Promise<void>
This will check the s3 bucket to ensure access and existence
Parameters
- Optionaloptions: AbortOptions
Returns Promise<void>
- Defined in datastore-s3/src/index.ts:302

put

put(key: Key, val: Uint8Array, options?: AbortOptions): Promise<Key>
Store the given value under the key.
Parameters
- key: Key
- val: Uint8Array
- Optionaloptions: AbortOptions
Returns Promise<Key>
Overrides BaseDatastore.put
- Defined in datastore-s3/src/index.ts:107

putMany

putMany(
source: AwaitIterable<Pair>,
options?: AbortOptions,
): AwaitGenerator<Key>
Store the given key/value pairs
Parameters
- source: AwaitIterable<Pair>
- Optionaloptions: AbortOptions
Returns AwaitGenerator<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}`)
}
```
Inherited from BaseDatastore.putMany
- Defined in datastore-core/dist/src/base.d.ts:8

query

query(q: Query, options?: AbortOptions): AwaitGenerator<Pair>
Query the datastore.
Parameters
- q: Query
- Optionaloptions: AbortOptions
Returns AwaitGenerator<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)
```
Inherited from BaseDatastore.query
- Defined in datastore-core/dist/src/base.d.ts:20

queryKeys

queryKeys(q: KeyQuery, options?: AbortOptions): AwaitGenerator<Key>
Query the datastore.
Parameters
- q: KeyQuery
- Optionaloptions: AbortOptions
Returns AwaitGenerator<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)
```
Inherited from BaseDatastore.queryKeys
- Defined in datastore-core/dist/src/base.d.ts:21

Class S3Datastore

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns S3Datastore

Properties

createIfMissing

Optionalpath

Methods

_all

Parameters

Returns AwaitGenerator<Pair>

_allKeys

Parameters

Returns AwaitGenerator<Key>

_getFullKey

Parameters

Returns string

_listKeys

Parameters

Returns AsyncIterable<Key>

batch

Returns Batch

Example

delete

Parameters

Returns Promise<void>

deleteMany

Parameters

Returns AwaitGenerator<Key>

Example

get

Parameters

Returns Promise<Uint8Array<ArrayBufferLike>>

getMany

Parameters

Returns AwaitGenerator<Pair>

Example

has

Parameters

Returns Promise<boolean>

open

Parameters

Returns Promise<void>

put

Parameters

Returns Promise<Key>

putMany

Parameters

Returns AwaitGenerator<Key>

Example

query

Parameters

Returns AwaitGenerator<Pair>

Example

queryKeys

Parameters

Returns AwaitGenerator<Key>

Example

Settings

On This Page

`Optional`path