datastore-core
Version:
Wrapper implementation for interface-datastore
122 lines (78 loc) • 3.86 kB
Markdown
# datastore-core
[](https://ipfs.tech)
[](https://discuss.ipfs.tech)
[](https://codecov.io/gh/ipfs/js-stores)
[](https://github.com/ipfs/js-stores/actions/workflows/js-test-and-release.yml?query=branch%3Amain)
> Wrapper implementation for interface-datastore
# About
<!--
!
Everything in this README between "# About" and "# Install" is automatically
generated and will be overwritten the next time the doc generator is run.
To make changes to this section, please update the @packageDocumentation section
of src/index.js or src/index.ts
To experiment with formatting, please run "npm run docs" from the root of this
repo and examine the changes made.
-->
Various Datastore implementations are available.
## Implementations
- Mount: [`src/mount`](./src/mount.ts)
- Keytransform: [`src/keytransform`](./src/keytransform.ts)
- Sharding: [`src/sharding`](./src/sharding.ts)
- Tiered: [`src/tiered`](./src/tirered.ts)
- Namespace: [`src/namespace`](./src/namespace.ts)
- BlackHole: [`src/black-hole`](./src/black-hole.ts)
## Example - BaseDatastore
An base store is made available to make implementing your own datastore easier:
```javascript
import { BaseDatastore } from 'datastore-core'
class MyDatastore extends BaseDatastore {
constructor () {
super()
}
async put (key, val) {
// your implementation here
}
async get (key) {
// your implementation here
}
// etc...
}
```
See the [MemoryDatastore](./src/memory.js) for an example of how it is used.
## Example - Wrapping Stores
```js
import { Key } from 'interface-datastore'
import {
MemoryStore,
MountStore
} from 'datastore-core'
const store = new MountStore({prefix: new Key('/a'), datastore: new MemoryStore()})
```
## Example - BlackHoleDatastore
A datastore that does not store any data.
```js
import { BlackHoleDatastore } from 'datastore-core/black-hole'
const store = new BlackHoleDatastore()
```
# Install
```console
$ npm i datastore-core
```
## Browser `<script>` tag
Loading this module through a script tag will make its exports available as `DatastoreCore` in the global namespace.
```html
<script src="https://unpkg.com/datastore-core/dist/index.min.js"></script>
```
# API Docs
- <https://ipfs.github.io/js-stores/modules/datastore_core.html>
# License
Licensed under either of
- Apache 2.0, ([LICENSE-APACHE](https://github.com/ipfs/js-stores/blob/main/packages/datastore-core/LICENSE-APACHE) / <http://www.apache.org/licenses/LICENSE-2.0>)
- MIT ([LICENSE-MIT](https://github.com/ipfs/js-stores/blob/main/packages/datastore-core/LICENSE-MIT) / <http://opensource.org/licenses/MIT>)
# Contribute
Contributions welcome! Please check out [the issues](https://github.com/ipfs/js-stores/issues).
Also see our [contributing document](https://github.com/ipfs/community/blob/master/CONTRIBUTING_JS.md) for more information on how we work, and about contributing in general.
Please be aware that all interactions related to this repo are subject to the IPFS [Code of Conduct](https://github.com/ipfs/community/blob/master/code-of-conduct.md).
Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.
[](https://github.com/ipfs/community/blob/master/CONTRIBUTING.md)