Mirroristas/orbitdb
2
0
Fork 0
mirror of https://github.com/orbitdb/orbitdb.git synced 2025-03-30 15:08:28 +00:00
Code Issues Packages Projects Releases Wiki Activity

add note about pinning

Browse Source
This commit is contained in:
shamb0t 2019-11-28 13:57:53 +00:00
parent afb742109d
commit 9c18dfc161
1 changed files with 8 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
GUIDE.md
View File

@ -325,6 +325,14 @@ ipfs.on('ready', async () => {
})
```
**NOTE ON PERSISTENCY**
OrbitDB does not automatically pin content added to IPFS. This means that if garbage collection is triggered, any unpinned content will be erased. To pin the entry, pass the optional `{ pin: true }` in the arguments:
```js
await db.put('name', 'hello', { pin: true })
```
For adding entries to other databases, see:
- [log.add()](https://github.com/orbitdb/orbit-db/blob/master/API.md#addevent)
- [feed.add()](https://github.com/orbitdb/orbit-db/blob/master/API.md#adddata)