rocksdb-native 3.0.1 → 3.1.0

package/index.js

@@ -1,4 +1,3 @@
-const { ReadBatch, WriteBatch } = require('./lib/batch')
 const ColumnFamily = require('./lib/column-family')
 const Iterator = require('./lib/iterator')
 const Snapshot = require('./lib/snapshot')
@@ -9,12 +8,16 @@ class RocksDB {
     const {
       columnFamily,
       state = new DBState(this, path, opts),
-      snapshot = null
+      snapshot = null,
+      keyEncoding = null,
+      valueEncoding = null
     } = opts
 
     this._state = state
     this._snapshot = snapshot
     this._columnFamily = state.getColumnFamily(columnFamily)
+    this._keyEncoding = keyEncoding
+    this._valueEncoding = valueEncoding
     this._index = this._state.addSession(this)
   }
 
@@ -36,7 +39,9 @@ class RocksDB {
 
   session({
     columnFamily = this._columnFamily,
-    snapshot = this._snapshot !== null
+    snapshot = this._snapshot !== null,
+    keyEncoding = this._keyEncoding,
+    valueEncoding = this._valueEncoding
   } = {}) {
     let snap = null
 
@@ -49,12 +54,14 @@ class RocksDB {
     return new RocksDB(null, {
       state: this._state,
       columnFamily,
-      snapshot: snap
+      snapshot: snap,
+      keyEncoding,
+      valueEncoding
     })
   }
 
-  columnFamily(name) {
-    return this.session({ columnFamily: name })
+  columnFamily(name, opts) {
+    return this.session({ ...opts, columnFamily: name })
   }
 
   snapshot() {
@@ -114,52 +121,36 @@ class RocksDB {
   }
 
   read(opts) {
-    return new ReadBatch(this, opts)
+    return this._state.createReadBatch(this, opts)
   }
 
   write(opts) {
-    return new WriteBatch(this, opts)
+    return this._state.createWriteBatch(this, opts)
   }
 
   async get(key, opts) {
-    const batch = this.read({ ...opts, capacity: 1 })
-    try {
-      const value = batch.get(key)
-      batch.tryFlush()
-      return await value
-    } finally {
-      batch.destroy()
-    }
+    const batch = this.read({ ...opts, capacity: 1, autoDestroy: true })
+    const value = batch.get(key)
+    batch.tryFlush()
+    return value
   }
 
   async put(key, value, opts) {
-    const batch = this.write({ ...opts, capacity: 1 })
-    try {
-      batch.tryPut(key, value)
-      await batch.flush()
-    } finally {
-      batch.destroy()
-    }
+    const batch = this.write({ ...opts, capacity: 1, autoDestroy: true })
+    batch.tryPut(key, value)
+    await batch.flush()
   }
 
   async delete(key, opts) {
-    const batch = this.write({ ...opts, capacity: 1 })
-    try {
-      batch.tryDelete(key)
-      await batch.flush()
-    } finally {
-      batch.destroy()
-    }
+    const batch = this.write({ ...opts, capacity: 1, autoDestroy: true })
+    batch.tryDelete(key)
+    await batch.flush()
   }
 
   async deleteRange(start, end, opts) {
-    const batch = this.write({ ...opts, capacity: 1 })
-    try {
-      batch.tryDeleteRange(start, end)
-      await batch.flush()
-    } finally {
-      batch.destroy()
-    }
+    const batch = this.write({ ...opts, capacity: 1, autoDestroy: true })
+    batch.tryDeleteRange(start, end)
+    await batch.flush()
   }
 }
 

package/lib/batch.js

@@ -6,26 +6,16 @@ const resolved = Promise.resolve()
 
 class RocksDBBatch {
   constructor(db, opts = {}) {
-    const {
-      columnFamily = db.defaultColumnFamily,
-      capacity = 8,
-      encoding = null,
-      keyEncoding = encoding,
-      valueEncoding = encoding
-    } = opts
+    const { capacity = 8, autoDestroy = false } = opts
 
     db._state.ref()
 
-    this._state = db._state
-    this._columnFamily = columnFamily
+    this._db = db
     this._destroyed = false
     this._capacity = capacity
     this._operations = []
     this._promises = []
 
-    this._keyEncoding = keyEncoding
-    this._valueEncoding = valueEncoding
-
     this._enqueuePromise = this._enqueuePromise.bind(this)
 
     this._request = null
@@ -33,8 +23,19 @@ class RocksDBBatch {
 
     this._handle = null
     this._buffer = null
+    this._autoDestroy = autoDestroy
+
+    if (db._state.opened === true) this.ready()
+  }
+
+  _reuse(db, opts = {}) {
+    const { autoDestroy = false } = opts
+
+    db._state.ref()
 
-    if (this._state.opened === true) this.ready()
+    this._db = db
+    this._destroyed = false
+    this._autoDestroy = autoDestroy
   }
 
   _onfinished() {
@@ -45,6 +46,7 @@ class RocksDBBatch {
     this._request = null
     this._resolve = null
 
+    if (this._autoDestroy === true) this.destroy()
     if (resolve !== null) resolve()
   }
 
@@ -61,7 +63,7 @@ class RocksDBBatch {
   async ready() {
     if (this._handle !== null) return
 
-    if (this._state.opened === false) await this._state.ready()
+    if (this._db._state.opened === false) await this._db._state.ready()
 
     this._init()
   }
@@ -72,7 +74,22 @@ class RocksDBBatch {
 
     this._destroyed = true
 
-    this._state.unref()
+    if (this._promises.length) this._abort()
+
+    this._db._state.unref()
+    this._onfree()
+  }
+
+  _onfree() {
+    this._db._state.freeBatch(this, false)
+    this._db = null
+  }
+
+  _abort() {
+    for (let i = 0; i < this._promises.length; i++) {
+      const promise = this._promises[i]
+      if (promise !== null) promise.reject(new Error('Batch is destroyed'))
+    }
   }
 
   flush() {
@@ -105,31 +122,25 @@ class RocksDBBatch {
   }
 
   _encodeKey(k) {
-    if (this._keyEncoding) return c.encode(this._keyEncoding, k)
+    if (this._db._keyEncoding) return c.encode(this._db._keyEncoding, k)
     if (typeof k === 'string') return Buffer.from(k)
     return k
   }
 
   _encodeValue(v) {
-    if (this._valueEncoding) return c.encode(this._valueEncoding, v)
+    if (this._db._valueEncoding) return c.encode(this._db._valueEncoding, v)
     if (v === null) return empty
     if (typeof v === 'string') return Buffer.from(v)
     return v
   }
 
   _decodeValue(b) {
-    if (this._valueEncoding) return c.decode(this._valueEncoding, b)
+    if (this._db._valueEncoding) return c.decode(this._db._valueEncoding, b)
     return b
   }
 }
 
 exports.ReadBatch = class RocksDBReadBatch extends RocksDBBatch {
-  constructor(db, opts) {
-    super(db, opts)
-
-    this._snapshot = db._snapshot
-  }
-
   _init() {
     this._handle = binding.readInit()
     this._buffer = binding.readBuffer(this._handle, this._capacity)
@@ -145,10 +156,10 @@ exports.ReadBatch = class RocksDBReadBatch extends RocksDBBatch {
     await super._flush()
 
     binding.read(
-      this._state.handle,
+      this._db._state.handle,
       this._handle,
       this._operations,
-      this._snapshot ? this._snapshot._handle : null,
+      this._db._snapshot ? this._db._snapshot._handle : null,
       this,
       this._onread
     )
@@ -179,7 +190,7 @@ exports.ReadBatch = class RocksDBReadBatch extends RocksDBBatch {
     const promise = new Promise(this._enqueuePromise)
 
     this._operations.push(
-      new RocksDBGet(this._encodeKey(key), this._columnFamily)
+      new RocksDBGet(this._encodeKey(key), this._db._columnFamily)
     )
 
     this._resize()
@@ -200,11 +211,15 @@ exports.WriteBatch = class RocksDBWriteBatch extends RocksDBBatch {
     }
   }
 
+  _onfree() {
+    this._db._state.freeBatch(this, true)
+  }
+
   async _flush() {
     await super._flush()
 
     binding.write(
-      this._state.handle,
+      this._db._state.handle,
       this._handle,
       this._operations,
       this,
@@ -233,7 +248,7 @@ exports.WriteBatch = class RocksDBWriteBatch extends RocksDBBatch {
       new RocksDBPut(
         this._encodeKey(key),
         this._encodeValue(value),
-        this._columnFamily
+        this._db._columnFamily
       )
     )
 
@@ -249,7 +264,7 @@ exports.WriteBatch = class RocksDBWriteBatch extends RocksDBBatch {
       new RocksDBPut(
         this._encodeKey(key),
         this._encodeValue(value),
-        this._columnFamily
+        this._db._columnFamily
       )
     )
 
@@ -264,7 +279,7 @@ exports.WriteBatch = class RocksDBWriteBatch extends RocksDBBatch {
     const promise = new Promise(this._enqueuePromise)
 
     this._operations.push(
-      new RocksDBDelete(this._encodeKey(key), this._columnFamily)
+      new RocksDBDelete(this._encodeKey(key), this._db._columnFamily)
     )
 
     this._resize()
@@ -276,7 +291,7 @@ exports.WriteBatch = class RocksDBWriteBatch extends RocksDBBatch {
     if (this._request) throw new Error('Request already in progress')
 
     this._operations.push(
-      new RocksDBDelete(this._encodeKey(key), this._columnFamily)
+      new RocksDBDelete(this._encodeKey(key), this._db._columnFamily)
     )
 
     this._promises.push(null)
@@ -293,7 +308,7 @@ exports.WriteBatch = class RocksDBWriteBatch extends RocksDBBatch {
       new RocksDBDeleteRange(
         this._encodeKey(start),
         this._encodeKey(end),
-        this._columnFamily
+        this._db._columnFamily
       )
     )
 
@@ -309,7 +324,7 @@ exports.WriteBatch = class RocksDBWriteBatch extends RocksDBBatch {
       new RocksDBDeleteRange(
         this._encodeKey(start),
         this._encodeKey(end),
-        this._columnFamily
+        this._db._columnFamily
       )
     )
 

package/lib/iterator.js

@@ -7,28 +7,20 @@ const empty = Buffer.alloc(0)
 module.exports = class RocksDBIterator extends Readable {
   constructor(db, opts = {}) {
     const {
-      columnFamily = db.defaultColumnFamily,
       gt = null,
       gte = null,
       lt = null,
       lte = null,
       reverse = false,
       limit = Infinity,
-      capacity = 8,
-      encoding = null,
-      keyEncoding = encoding,
-      valueEncoding = encoding
+      capacity = 8
     } = opts
 
     super()
 
     db._state.ref()
 
-    this._state = db._state
-    this._columnFamily = columnFamily
-
-    this._keyEncoding = keyEncoding
-    this._valueEncoding = valueEncoding
+    this._db = db
 
     this._gt = gt ? this._encodeKey(gt) : empty
     this._gte = gte ? this._encodeKey(gte) : empty
@@ -38,7 +30,6 @@ module.exports = class RocksDBIterator extends Readable {
     this._reverse = reverse
     this._limit = limit < 0 ? Infinity : limit
     this._capacity = capacity
-    this._snapshot = db._snapshot
 
     this._pendingOpen = null
     this._pendingRead = null
@@ -47,7 +38,7 @@ module.exports = class RocksDBIterator extends Readable {
     this._buffer = null
     this._handle = null
 
-    if (this._state.opened === true) this.ready()
+    if (this._db._state.opened === true) this.ready()
   }
 
   _onopen(err) {
@@ -80,7 +71,7 @@ module.exports = class RocksDBIterator extends Readable {
   _onclose(err) {
     const cb = this._pendingDestroy
     this._pendingDestroy = null
-    this._state.unref()
+    this._db._state.unref()
     cb(err)
   }
 
@@ -93,7 +84,7 @@ module.exports = class RocksDBIterator extends Readable {
   async ready() {
     if (this._handle !== null) return
 
-    if (this._state.opened === false) await this._state.ready()
+    if (this._db._state.opened === false) await this._db._state.ready()
 
     this._init()
   }
@@ -109,15 +100,15 @@ module.exports = class RocksDBIterator extends Readable {
     this._pendingOpen = cb
 
     binding.iteratorOpen(
-      this._state.handle,
+      this._db._state.handle,
       this._handle,
-      this._columnFamily._handle,
+      this._db._columnFamily._handle,
       this._gt,
       this._gte,
       this._lt,
       this._lte,
       this._reverse,
-      this._snapshot ? this._snapshot._handle : null,
+      this._db._snapshot ? this._db._snapshot._handle : null,
       this,
       this._onopen,
       this._onclose,
@@ -140,18 +131,21 @@ module.exports = class RocksDBIterator extends Readable {
   }
 
   _encodeKey(k) {
-    if (this._keyEncoding) return c.encode(this._keyEncoding, k)
+    if (this._db._keyEncoding !== null)
+      return c.encode(this._db._keyEncoding, k)
     if (typeof k === 'string') return Buffer.from(k)
     return k
   }
 
   _decodeKey(b) {
-    if (this._keyEncoding) return c.decode(this._keyEncoding, b)
+    if (this._db._keyEncoding !== null)
+      return c.decode(this._db._keyEncoding, b)
     return b
   }
 
   _decodeValue(b) {
-    if (this._valueEncoding) return c.decode(this._valueEncoding, b)
+    if (this._db._valueEncoding !== null)
+      return c.decode(this._db._valueEncoding, b)
     return b
   }
 }

package/lib/state.js

@@ -1,8 +1,11 @@
 const ReadyResource = require('ready-resource')
 const RefCounter = require('refcounter')
+const { ReadBatch, WriteBatch } = require('./batch')
 const ColumnFamily = require('./column-family')
 const binding = require('../binding')
 
+const MAX_BATCH_REUSE = 64
+
 module.exports = class DBState extends ReadyResource {
   constructor(db, path, opts) {
     super()
@@ -28,6 +31,8 @@ module.exports = class DBState extends ReadyResource {
     this._suspending = null
     this._resuming = null
     this._columnsFlushed = false
+    this._readBatches = []
+    this._writeBatches = []
 
     for (const col of columnFamilies) {
       this.columnFamilies.push(
@@ -47,9 +52,29 @@ module.exports = class DBState extends ReadyResource {
     )
   }
 
+  createReadBatch(db, opts) {
+    if (this._readBatches.length === 0) return new ReadBatch(db, opts)
+    const batch = this._readBatches.pop()
+    batch._reuse(db, opts)
+    return batch
+  }
+
+  createWriteBatch(db, opts) {
+    if (this._writeBatches.length === 0) return new WriteBatch(db, opts)
+    const batch = this._writeBatches.pop()
+    batch._reuse(db, opts)
+    return batch
+  }
+
+  freeBatch(batch, writable) {
+    const queue = writable ? this._writeBatches : this._readBatches
+    if (queue.length >= MAX_BATCH_REUSE) return
+    queue.push(batch)
+  }
+
   addSession(db) {
     this.sessionRefs.inc()
-    db._index = this.sessions.push(db) - 1
+    return this.sessions.push(db) - 1
   }
 
   removeSession(db) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "rocksdb-native",
-  "version": "3.0.1",
+  "version": "3.1.0",
   "description": "librocksdb bindings for JavaScript",
   "exports": {
     ".": "./index.js",