# orbit-db-docstore

> Document Store for orbit-db

Latest version **2.0.0** (published 2023-01-18) · MIT license · 0 weekly downloads

> **Deprecated.** This package is deprecated.

## Install

```sh
npm install orbit-db-docstore
pnpm add orbit-db-docstore
yarn add orbit-db-docstore
bun add orbit-db-docstore
```

## Health

**Score 10/100 (F)** — status: deprecated.

Negative: deprecated.

## Facts

| | |
|---|---|
| Version | 2.0.0 |
| Published | 2023-01-18 |
| First published | 2016-09-27 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | ESM + CommonJS |
| Dependencies | 1 |
| Unpacked size | 14.5 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 40 |
| Author | shamb0t |
| Maintainers | haad, shamb0t, hajamark |
| Keywords | orbitdb, orbit-db, docstore |

## Links

- npm: https://www.npmjs.com/package/orbit-db-docstore
- Repository: https://github.com/orbitdb/orbit-db-docstore
- Homepage: https://github.com/orbitdb/orbit-db-docstore#readme
- Issues: https://github.com/orbitdb/orbit-db-docstore/issues
- npm.io page: https://npm.io/package/orbit-db-docstore

## Dependencies (1)

- [p-map](https://npm.io/package/p-map.md) ~1.1.1

## Recent versions

- 2.0.0 (latest) — 2023-01-18
- 2.0.1-6efa658.0 (next) — 2023-01-18
- 1.12.1-f21101c.0 — 2023-01-11
- 1.12.0 — 2020-09-16
- 1.11.0 — 2020-09-11
- 1.10.0 — 2020-09-06
- 1.9.1 — 2020-08-18
- 1.9.0 — 2020-05-12
- 1.8.0 — 2020-03-07
- 1.7.0 — 2019-12-05
- 1.6.0 — 2019-10-03
- 1.6.0-rc3 — 2019-08-30
- 1.6.0-rc2 — 2019-08-30
- 1.6.0-rc1 — 2019-08-30
- 1.5.1 — 2019-05-06
- … 22 more at https://npm.io/package/orbit-db-docstore/versions

## README

# orbit-db-docstore

[![npm](https://img.shields.io/npm/v/orbit-db-docstore.svg)](https://www.npmjs.com/package/orbit-db-docstore)
[![Gitter](https://img.shields.io/gitter/room/nwjs/nw.js.svg)](https://gitter.im/orbitdb/Lobby) [![Matrix](https://img.shields.io/badge/matrix-%23orbitdb%3Apermaweb.io-blue.svg)](https://riot.permaweb.io/#/room/#orbitdb:permaweb.io) 


> Document Store for orbit-db

Database for storing indexed documents. Stores documents by `_id` field by default but you can also specify a custom field to index by.

*This is a core data store in [orbit-db](https://github.com/orbitdb/orbit-db)*

## Table of Contents

- [Install](#install)
- [Usage](#usage)
- [API](#api)
    - [docstore(name, options)](#docstorename-options)
- [License](#license)

## Install

This project uses [npm](https://npmjs.com) and [nodejs](https://nodejs.org)

```
npm install orbit-db-docstore
```

## Usage

```javascript
import * as IPFS from 'ipfs'
import OrbitDB from 'orbit-db'

const ipfs = new IPFS()
const orbitdb = await OrbitDB.createInstance(ipfs)
const docstore = await orbitdb.docstore('db name')

docstore.put({ _id: 'hello world', doc: 'all the things' })
  .then(() => docstore.put({ _id: 'sup world', doc: 'other things' }))
  .then(() => docstore.get('hello'))
  .then((value) => console.log(value))
  // [{ _id: 'hello world', doc: 'all the things'}]

```

You can specify the field to index by in the options:

```javascript
const docstore = await orbitdb.docstore('db name', { indexBy: 'doc' })

docstore.put({ _id: 'hello world', doc: 'some things' })
  .then(() => docstore.put({ _id: 'hello universe', doc: 'all the things' }))
  .then(() => docstore.get('all'))
  .then((value) => console.log(value))
  // [{ _id: 'hello universe', doc: 'all the things'}]

```

You can also use a mapper to query the documents

```javascript
const docstore = await orbitdb.docstore('db name')

docstore.put({ _id: 'hello world', doc: 'some things', views: 10 })
  .then(() => docstore.put({ _id: 'hello universe', doc: 'all the things', views: 100 }))
  .then(() => docstore.put({ _id: 'sup world', doc: 'other things', views: 5 }))
  .then(() => docstore.query((e)=> e.views > 5))
  .then((value) => console.log(value))
  // [{ _id: 'hello world', doc: 'some things', views: 10}, { _id: 'hello universe', doc: 'all the things', views: 100}]
```

## API

*See [orbit-db API documentation](https://github.com/orbitdb/orbit-db/blob/master/API.md) for full details*

### docstore(name, options)

  Package:
  [orbit-db-docstore](https://github.com/orbitdb/orbit-db-docstore)

  ```javascript
  const db = await orbitdb.docstore('orbit.users.shamb0t.profile')
  ```

  By default, documents are indexed by field '_id'. You can also specify the field to index by:

  ```javascript
  const db = await orbitdb.docstore('orbit.users.shamb0t.profile', { indexBy: 'name' })
  ```

  - **put(doc)**
    ```javascript
    db.put({ _id: 'QmAwesomeIpfsHash', name: 'shamb0t', followers: 500 }).then((hash) => ...)
    ```

  - **get(key)**
    ```javascript
    const profile = db.get('shamb0t')
      .map((e) => e.payload.value)
    // [{ _id: 'shamb0t', name: 'shamb0t', followers: 500 }]
    ```

  - **query(mapper)**
    ```javascript
    const all = db.query((doc) => doc.followers >= 500)
    // [{ _id: 'shamb0t', name: 'shamb0t', followers: 500 }]
    ```

  - **del(key)**
    ```javascript
    db.del('shamb0t').then((removed) => ...)
    ```

  - **events**

    ```javascript
    db.events.on('data', (dbname, event) => ... )
    ```

    See [events](https://github.com/haadcode/orbit-db/blob/master/API.md#events) for full description.

## Contributing

If you think this could be better, please [open an issue](https://github.com/orbitdb/orbit-db-docstore/issues/new)!

Please note that all interactions in @orbitdb fall under our [Code of Conduct](CODE_OF_CONDUCT.md).

## License

[MIT](LICENSE) ©️ 2015-2018 shamb0t, Haja Networks Oy

---
_Source: https://npm.io/package/orbit-db-docstore · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._