hypercore-storage 1.13.0 → 1.14.1

package/README.md

@@ -85,7 +85,7 @@ Return a bitfield page.
 
 #### `await rx.getUserData(key)`
 
-Return a user stored buffer.
+Return a user stored buffer. `key` is a string.
 
 #### `rx.tryFlush()`
 
@@ -155,11 +155,11 @@ Delete bitfield pages between two indexes.
 
 #### `tx.putUserData(key, value)`
 
-Put a user provided buffer at a user provided key.
+Put a user provided buffer at a user provided `key`. `key` is a string.
 
 #### `tx.deleteUserData(key)`
 
-Delete a user provided key.
+Delete a user provided `key`. `key` is a string.
 
 #### `await tx.flush()`
 
@@ -179,7 +179,17 @@ Create a stream of all bitfield pages.
 
 #### `stream = core.createUserDataStream(opts)`
 
-Create a stream of all user data.
+Create a stream of all user data. `opts` is a query object with the following possible properties:
+
+```
+{
+  gt: 'only return keys > than this', // Not currently supported
+  gte: 'only return keys >= than this',
+  lt: 'only return keys < than this',
+  lte: 'only return keys <= than this', // Not currently supported
+  reverse: false // reverse results. Not currently supported
+}
+```
 
 #### `await core.close()`
 

package/index.js

@@ -347,6 +347,47 @@ class HypercoreStorage {
 
     return this.db.close()
   }
+
+  static async export (ptr, db, { batches = false } = {}) {
+    const rx = new CoreRX(ptr, db, EMPTY)
+
+    const core = {
+      head: null,
+      auth: null,
+      sessions: [],
+      data: null
+    }
+
+    const sessionsPromise = rx.getSessions()
+    const headPromise = rx.getHead()
+    const authPromise = rx.getAuth()
+
+    rx.tryFlush()
+
+    const [sessions, head, auth] = await Promise.all([
+      sessionsPromise,
+      headPromise,
+      authPromise
+    ])
+
+    core.head = head
+    core.auth = { ...auth, keyPair: null }
+    if (sessions) core.sessions = sessions.map(s => s.name)
+
+    const data = []
+
+    data.push(exportData(ptr, db))
+
+    if (batches) {
+      for (const { dataPointer } of sessions) {
+        data.push(exportData({ dataPointer, dependencies: [] }, db))
+      }
+    }
+
+    core.data = await Promise.all(data)
+
+    return core
+  }
 }
 
 class CorestoreStorage {
@@ -356,6 +397,7 @@ class CorestoreStorage {
     this.bootstrap = storage !== null
     this.path = storage !== null ? storage : path.join(db.path, '..')
     this.readOnly = !!opts.readOnly
+    this.allowBackup = !!opts.allowBackup
 
     // tmp sync fix for simplicty since not super deployed yet
     if (this.bootstrap && !this.readOnly) tmpFixStorage(this.path)
@@ -462,7 +504,7 @@ class CorestoreStorage {
 
       await this.db.ready()
 
-      if (this.bootstrap && !this.readOnly) {
+      if (this.bootstrap && !this.readOnly && !this.allowBackup) {
         const corestoreFile = path.join(this.path, 'CORESTORE')
 
         if (!(await DeviceFile.resume(corestoreFile, { id: this.id }))) {
@@ -772,6 +814,36 @@ class CorestoreStorage {
     return this._resumeFromPointers(EMPTY, discoveryKey, false, core)
   }
 
+  async export (discoveryKey, opts) {
+    const rx = new CorestoreRX(this.db, EMPTY)
+    const corePromise = rx.getCore(discoveryKey)
+
+    rx.tryFlush()
+    const core = await corePromise
+    if (core === null) return null
+
+    let { dataPointer, corePointer } = core
+
+    const ptr = { corePointer, dataPointer, dependencies: [] }
+
+    while (true) {
+      const rx = new CoreRX({ dataPointer, corePointer: 0, dependencies: [] }, this.db, EMPTY)
+      const dependencyPromise = rx.getDependency()
+      rx.tryFlush()
+      const dependency = await dependencyPromise
+      if (!dependency) break
+      ptr.dependencies.push(dependency)
+      dataPointer = dependency.dataPointer
+    }
+
+    const session = this.db.session()
+    try {
+      return await HypercoreStorage.export(ptr, session, opts)
+    } finally {
+      await session.close()
+    }
+  }
+
   async _resumeFromPointers (view, discoveryKey, create, { version, corePointer, dataPointer }) {
     const core = { corePointer, dataPointer, dependencies: [] }
 
@@ -926,3 +998,26 @@ function tmpFixStorage (p) {
     fs.renameSync(path.join(p, f), path.join(p, 'db', f))
   }
 }
+
+async function exportData (ptr, db, opts) {
+  // just need dataPointer
+  const reads = [
+    toArray(createBlockStream(ptr, db, EMPTY, opts)),
+    toArray(createTreeNodeStream(ptr, db, EMPTY, opts)),
+    toArray(createBitfieldStream(ptr, db, EMPTY, opts))
+  ]
+
+  const [blocks, tree, bitfield] = await Promise.all(reads)
+
+  return {
+    blocks,
+    tree,
+    bitfield
+  }
+}
+
+async function toArray (stream) {
+  const all = []
+  for await (const e of stream) all.push(e)
+  return all
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "hypercore-storage",
-  "version": "1.13.0",
+  "version": "1.14.1",
   "main": "index.js",
   "files": [
     "index.js",