rocksdb-native 2.1.0 → 2.3.0

package/binding.c

@@ -84,6 +84,10 @@ typedef struct {
   js_ref_t *on_status;
 } rocksdb_native_write_batch_t;
 
+typedef struct {
+  rocksdb_snapshot_t handle;
+} rocksdb_native_snapshot_t;
+
 static void
 rocksdb_native__on_free (js_env_t *env, void *data, void *finalize_hint) {
   free(data);
@@ -146,7 +150,7 @@ rocksdb_native__on_open (rocksdb_open_t *handle, int status) {
     assert(err == 0);
   }
 
-  js_call_function(env, ctx, cb, 1, (js_value_t *[]){error}, NULL);
+  js_call_function_with_checkpoint(env, ctx, cb, 1, (js_value_t *[]){error}, NULL);
 
   err = js_close_handle_scope(env, scope);
   assert(err == 0);
@@ -241,7 +245,7 @@ rocksdb_native__on_close (rocksdb_close_t *handle, int status) {
   err = js_get_reference_value(env, req->on_close, &cb);
   assert(err == 0);
 
-  js_call_function(env, ctx, cb, 0, NULL, NULL);
+  js_call_function_with_checkpoint(env, ctx, cb, 0, NULL, NULL);
 
   err = js_close_handle_scope(env, scope);
   assert(err == 0);
@@ -395,7 +399,7 @@ rocksdb_native__on_iterator_open (rocksdb_iterator_t *handle, int status) {
     assert(err == 0);
   }
 
-  js_call_function(env, ctx, cb, 1, (js_value_t *[]){error}, NULL);
+  js_call_function_with_checkpoint(env, ctx, cb, 1, (js_value_t *[]){error}, NULL);
 
   err = js_close_handle_scope(env, scope);
   assert(err == 0);
@@ -405,13 +409,13 @@ static js_value_t *
 rocksdb_native_iterator_open (js_env_t *env, js_callback_info_t *info) {
   int err;
 
-  size_t argc = 7;
-  js_value_t *argv[7];
+  size_t argc = 8;
+  js_value_t *argv[8];
 
   err = js_get_callback_info(env, info, &argc, argv, NULL, NULL);
   assert(err == 0);
 
-  assert(argc == 7);
+  assert(argc == 8);
 
   rocksdb_native_t *db;
   err = js_get_arraybuffer_info(env, argv[0], (void **) &db, NULL);
@@ -439,7 +443,20 @@ rocksdb_native_iterator_open (js_env_t *env, js_callback_info_t *info) {
   err = js_get_value_bool(env, argv[6], &reverse);
   assert(err == 0);
 
-  err = rocksdb_iterator_open(&db->handle, &iterator->handle, range, reverse, rocksdb_native__on_iterator_open);
+  rocksdb_read_options_t options = {
+    .version = 0,
+  };
+
+  bool has_snapshot;
+  err = js_is_arraybuffer(env, argv[7], &has_snapshot);
+  assert(err == 0);
+
+  if (has_snapshot) {
+    err = js_get_arraybuffer_info(env, argv[7], (void **) &options.snapshot, NULL);
+    assert(err == 0);
+  }
+
+  err = rocksdb_iterator_open(&db->handle, &iterator->handle, range, reverse, &options, rocksdb_native__on_iterator_open);
   assert(err == 0);
 
   return NULL;
@@ -477,7 +494,7 @@ rocksdb_native__on_iterator_close (rocksdb_iterator_t *handle, int status) {
     assert(err == 0);
   }
 
-  js_call_function(env, ctx, cb, 1, (js_value_t *[]){error}, NULL);
+  js_call_function_with_checkpoint(env, ctx, cb, 1, (js_value_t *[]){error}, NULL);
 
   err = js_close_handle_scope(env, scope);
   assert(err == 0);
@@ -567,7 +584,7 @@ rocksdb_native__on_iterator_read (rocksdb_iterator_t *handle, int status) {
     }
   }
 
-  js_call_function(env, ctx, cb, 3, (js_value_t *[]){error, keys, values}, NULL);
+  js_call_function_with_checkpoint(env, ctx, cb, 3, (js_value_t *[]){error, keys, values}, NULL);
 
   err = js_close_handle_scope(env, scope);
   assert(err == 0);
@@ -719,7 +736,7 @@ rocksdb_native__on_read (rocksdb_read_batch_t *handle, int status) {
   err = js_get_reference_value(env, batch->on_status, &cb);
   assert(err == 0);
 
-  js_call_function(env, ctx, cb, 2, (js_value_t *[]){errors, values}, NULL);
+  js_call_function_with_checkpoint(env, ctx, cb, 2, (js_value_t *[]){errors, values}, NULL);
 
   err = js_close_handle_scope(env, scope);
   assert(err == 0);
@@ -729,13 +746,13 @@ static js_value_t *
 rocksdb_native_read (js_env_t *env, js_callback_info_t *info) {
   int err;
 
-  size_t argc = 4;
-  js_value_t *argv[4];
+  size_t argc = 5;
+  js_value_t *argv[5];
 
   err = js_get_callback_info(env, info, &argc, argv, NULL, NULL);
   assert(err == 0);
 
-  assert(argc == 4);
+  assert(argc == 5);
 
   rocksdb_native_t *db;
   err = js_get_arraybuffer_info(env, argv[0], (void **) &db, NULL);
@@ -749,7 +766,7 @@ rocksdb_native_read (js_env_t *env, js_callback_info_t *info) {
   err = js_get_array_length(env, argv[2], &len);
   assert(err == 0);
 
-  err = js_create_reference(env, argv[3], 1, &batch->on_status);
+  err = js_create_reference(env, argv[4], 1, &batch->on_status);
   assert(err == 0);
 
   for (uint32_t i = 0; i < len; i++) {
@@ -781,7 +798,20 @@ rocksdb_native_read (js_env_t *env, js_callback_info_t *info) {
     }
   }
 
-  err = rocksdb_read(&db->handle, &batch->handle, batch->reads, batch->errors, len, rocksdb_native__on_read);
+  rocksdb_read_options_t options = {
+    .version = 0,
+  };
+
+  bool has_snapshot;
+  err = js_is_arraybuffer(env, argv[3], &has_snapshot);
+  assert(err == 0);
+
+  if (has_snapshot) {
+    err = js_get_arraybuffer_info(env, argv[3], (void **) &options.snapshot, NULL);
+    assert(err == 0);
+  }
+
+  err = rocksdb_read(&db->handle, &batch->handle, batch->reads, batch->errors, len, &options, rocksdb_native__on_read);
   assert(err == 0);
 
   return NULL;
@@ -885,7 +915,7 @@ rocksdb_native__on_write (rocksdb_write_batch_t *handle, int status) {
   err = js_get_reference_value(env, batch->on_status, &cb);
   assert(err == 0);
 
-  js_call_function(env, ctx, cb, 1, (js_value_t *[]){error}, NULL);
+  js_call_function_with_checkpoint(env, ctx, cb, 1, (js_value_t *[]){error}, NULL);
 
   err = js_close_handle_scope(env, scope);
   assert(err == 0);
@@ -985,12 +1015,61 @@ rocksdb_native_write (js_env_t *env, js_callback_info_t *info) {
     }
   }
 
-  err = rocksdb_write(&db->handle, &batch->handle, batch->writes, len, rocksdb_native__on_write);
+  err = rocksdb_write(&db->handle, &batch->handle, batch->writes, len, NULL, rocksdb_native__on_write);
   assert(err == 0);
 
   return NULL;
 }
 
+static js_value_t *
+rocksdb_native_snapshot_create (js_env_t *env, js_callback_info_t *info) {
+  int err;
+
+  size_t argc = 1;
+  js_value_t *argv[1];
+
+  err = js_get_callback_info(env, info, &argc, argv, NULL, NULL);
+  assert(err == 0);
+
+  assert(argc == 1);
+
+  rocksdb_native_t *db;
+  err = js_get_arraybuffer_info(env, argv[0], (void **) &db, NULL);
+  assert(err == 0);
+
+  js_value_t *handle;
+
+  rocksdb_native_snapshot_t *snapshot;
+  err = js_create_arraybuffer(env, sizeof(rocksdb_native_snapshot_t), (void **) &snapshot, &handle);
+  assert(err == 0);
+
+  err = rocksdb_snapshot_create(&db->handle, &snapshot->handle);
+  assert(err == 0);
+
+  return handle;
+}
+
+static js_value_t *
+rocksdb_native_snapshot_destroy (js_env_t *env, js_callback_info_t *info) {
+  int err;
+
+  size_t argc = 1;
+  js_value_t *argv[1];
+
+  err = js_get_callback_info(env, info, &argc, argv, NULL, NULL);
+  assert(err == 0);
+
+  assert(argc == 1);
+
+  rocksdb_native_snapshot_t *snapshot;
+  err = js_get_arraybuffer_info(env, argv[0], (void **) &snapshot, NULL);
+  assert(err == 0);
+
+  rocksdb_snapshot_destroy(&snapshot->handle);
+
+  return NULL;
+}
+
 static js_value_t *
 rocksdb_native_exports (js_env_t *env, js_value_t *exports) {
   int err;
@@ -1021,6 +1100,9 @@ rocksdb_native_exports (js_env_t *env, js_value_t *exports) {
   V("writeInit", rocksdb_native_write_init)
   V("writeBuffer", rocksdb_native_write_buffer)
   V("write", rocksdb_native_write)
+
+  V("snapshotCreate", rocksdb_native_snapshot_create)
+  V("snapshotDestroy", rocksdb_native_snapshot_destroy)
 #undef V
 
 #define V(name, n) \

package/index.js

@@ -3,6 +3,7 @@ const ReadyResource = require('ready-resource')
 const binding = require('./binding')
 const { ReadBatch, WriteBatch } = require('./lib/batch')
 const Iterator = require('./lib/iterator')
+const Snapshot = require('./lib/snapshot')
 
 const RocksDB = module.exports = class RocksDB extends ReadyResource {
   constructor (path, {
@@ -39,6 +40,8 @@ const RocksDB = module.exports = class RocksDB extends ReadyResource {
     this.tableCacheIndexAndFilterBlocks = tableCacheIndexAndFilterBlocks
     this.tableFormatVersion = tableFormatVersion
 
+    this._snapshots = new Set()
+
     this._handle = binding.init()
   }
 
@@ -82,6 +85,8 @@ const RocksDB = module.exports = class RocksDB extends ReadyResource {
   }
 
   async _close () {
+    for (const snapshot of this._snapshots) snapshot.destroy()
+
     const req = { resolve: null, reject: null, handle: null }
 
     const promise = new Promise((resolve, reject) => {
@@ -101,6 +106,10 @@ const RocksDB = module.exports = class RocksDB extends ReadyResource {
     }
   }
 
+  snapshot (opts) {
+    return new Snapshot(this, opts)
+  }
+
   iterator (opts) {
     return new Iterator(this, opts)
   }
@@ -121,6 +130,31 @@ const RocksDB = module.exports = class RocksDB extends ReadyResource {
     return new WriteBatch(this, opts)
   }
 
+  async get (key, opts) {
+    const batch = this.read(opts)
+    const value = batch.get(key)
+    await batch.flush()
+    return value
+  }
+
+  async put (key, value, opts) {
+    const batch = this.write(opts)
+    batch.put(key, value)
+    await batch.flush()
+  }
+
+  async delete (key, opts) {
+    const batch = this.write(opts)
+    batch.delete(key)
+    await batch.flush()
+  }
+
+  async deleteRange (start, end, opts) {
+    const batch = this.write(opts)
+    batch.deleteRange(start, end)
+    await batch.flush()
+  }
+
   static _instances = new Set()
 }
 

package/lib/batch.js

@@ -107,6 +107,16 @@ class RocksDBBatch {
 }
 
 exports.ReadBatch = class RocksDBReadBatch extends RocksDBBatch {
+  constructor (db, opts = {}) {
+    const {
+      snapshot = null
+    } = opts
+
+    super(db, opts)
+
+    this._snapshot = snapshot
+  }
+
   async _init () {
     this._handle = binding.readInit(this)
     this._buffer = binding.readBuffer(this._handle, this._capacity)
@@ -121,7 +131,7 @@ exports.ReadBatch = class RocksDBReadBatch extends RocksDBBatch {
   async _flush () {
     await super._flush()
 
-    binding.read(this._db._handle, this._handle, this._operations, this._onread)
+    binding.read(this._db._handle, this._handle, this._operations, this._snapshot ? this._snapshot._handle : null, this._onread)
   }
 
   _onread (errs, values) {
@@ -148,14 +158,6 @@ exports.ReadBatch = class RocksDBReadBatch extends RocksDBBatch {
 
     return promise
   }
-
-  tryPut (key, value) {
-    if (this._request) throw new Error('Request already in progress')
-
-    this._operations.push(new RocksDBPut(this._encodeKey(key), this._encodeValue(value)))
-    this._promises.push(null)
-    this._resize()
-  }
 }
 
 exports.WriteBatch = class RocksDBWriteBatch extends RocksDBBatch {

package/lib/iterator.js

@@ -15,6 +15,7 @@ module.exports = class RocksDBIterator extends Readable {
       reverse = false,
       limit = Infinity,
       capacity = 8,
+      snapshot = null,
       encoding = null,
       keyEncoding = encoding,
       valueEncoding = encoding
@@ -35,6 +36,7 @@ module.exports = class RocksDBIterator extends Readable {
     this._reverse = reverse
     this._limit = limit
     this._capacity = capacity
+    this._snapshot = snapshot
 
     this._pendingOpen = null
     this._pendingRead = null
@@ -100,7 +102,7 @@ module.exports = class RocksDBIterator extends Readable {
 
     this._pendingOpen = cb
 
-    binding.iteratorOpen(this._db._handle, this._handle, this._gt, this._gte, this._lt, this._lte, this._reverse)
+    binding.iteratorOpen(this._db._handle, this._handle, this._gt, this._gte, this._lt, this._lte, this._reverse, this._snapshot ? this._snapshot._handle : null)
   }
 
   _read (cb) {

package/lib/snapshot.js

@@ -0,0 +1,21 @@
+const binding = require('../binding')
+
+module.exports = class RocksDBSnapshot {
+  constructor (db) {
+    this._db = db
+
+    this._handle = binding.snapshotCreate(db._handle)
+
+    this._db._snapshots.add(this)
+  }
+
+  destroy () {
+    if (this._handle === null) return
+
+    binding.snapshotDestroy(this._handle)
+
+    this._handle = null
+
+    this._db._snapshots.delete(this)
+  }
+}

package/package.json

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

package/vendor/librocksdb/include/rocksdb.h

@@ -10,6 +10,8 @@ extern "C" {
 #include <uv.h>
 
 typedef struct rocksdb_options_s rocksdb_options_t;
+typedef struct rocksdb_read_options_s rocksdb_read_options_t;
+typedef struct rocksdb_write_options_s rocksdb_write_options_t;
 typedef struct rocksdb_open_s rocksdb_open_t;
 typedef struct rocksdb_close_s rocksdb_close_t;
 typedef struct rocksdb_slice_s rocksdb_slice_t;
@@ -19,6 +21,7 @@ typedef struct rocksdb_read_s rocksdb_read_t;
 typedef struct rocksdb_read_batch_s rocksdb_read_batch_t;
 typedef struct rocksdb_write_s rocksdb_write_t;
 typedef struct rocksdb_write_batch_s rocksdb_write_batch_t;
+typedef struct rocksdb_snapshot_s rocksdb_snapshot_t;
 typedef struct rocksdb_s rocksdb_t;
 
 typedef void (*rocksdb_open_cb)(rocksdb_open_t *req, int status);
@@ -75,6 +78,19 @@ struct rocksdb_options_s {
   uint32_t table_format_version;
 };
 
+/** @version 0 */
+struct rocksdb_read_options_s {
+  int version;
+
+  /** @since 0 */
+  rocksdb_snapshot_t *snapshot;
+};
+
+/** @version 0 */
+struct rocksdb_write_options_s {
+  int version;
+};
+
 struct rocksdb_open_s {
   uv_work_t worker;
 
@@ -121,6 +137,8 @@ struct rocksdb_iterator_s {
 
   rocksdb_t *db;
 
+  rocksdb_read_options_t options;
+
   void *handle; // Opaque iterator pointer
 
   rocksdb_range_t range;
@@ -160,6 +178,8 @@ struct rocksdb_read_batch_s {
 
   rocksdb_t *db;
 
+  rocksdb_read_options_t options;
+
   size_t len;
 
   rocksdb_read_t *reads;
@@ -200,6 +220,8 @@ struct rocksdb_write_batch_s {
 
   rocksdb_t *db;
 
+  rocksdb_write_options_t options;
+
   size_t len;
 
   rocksdb_write_t *writes;
@@ -211,6 +233,12 @@ struct rocksdb_write_batch_s {
   void *data;
 };
 
+struct rocksdb_snapshot_s {
+  rocksdb_t *db;
+
+  const void *handle; // Opaque snapshot pointer
+};
+
 struct rocksdb_s {
   uv_loop_t *loop;
 
@@ -236,22 +264,28 @@ rocksdb_slice_t
 rocksdb_slice_empty (void);
 
 int
-rocksdb_iterator_open (rocksdb_t *db, rocksdb_iterator_t *iterator, rocksdb_range_t range, bool reverse, rocksdb_iterator_cb cb);
+rocksdb_iterator_open (rocksdb_t *db, rocksdb_iterator_t *iterator, rocksdb_range_t range, bool reverse, const rocksdb_read_options_t *options, rocksdb_iterator_cb cb);
 
 int
 rocksdb_iterator_close (rocksdb_iterator_t *iterator, rocksdb_iterator_cb cb);
 
 int
-rocksdb_iterator_refresh (rocksdb_iterator_t *iterator, rocksdb_range_t range, bool reverse, rocksdb_iterator_cb cb);
+rocksdb_iterator_refresh (rocksdb_iterator_t *iterator, rocksdb_range_t range, bool reverse, const rocksdb_read_options_t *options, rocksdb_iterator_cb cb);
 
 int
 rocksdb_iterator_read (rocksdb_iterator_t *iterator, rocksdb_slice_t *keys, rocksdb_slice_t *values, size_t capacity, rocksdb_iterator_cb cb);
 
 int
-rocksdb_read (rocksdb_t *db, rocksdb_read_batch_t *batch, rocksdb_read_t *reads, char **errors, size_t len, rocksdb_read_batch_cb cb);
+rocksdb_read (rocksdb_t *db, rocksdb_read_batch_t *batch, rocksdb_read_t *reads, char **errors, size_t len, const rocksdb_read_options_t *options, rocksdb_read_batch_cb cb);
+
+int
+rocksdb_write (rocksdb_t *db, rocksdb_write_batch_t *batch, rocksdb_write_t *writes, size_t len, const rocksdb_write_options_t *options, rocksdb_write_batch_cb cb);
 
 int
-rocksdb_write (rocksdb_t *db, rocksdb_write_batch_t *batch, rocksdb_write_t *writes, size_t len, rocksdb_write_batch_cb cb);
+rocksdb_snapshot_create (rocksdb_t *db, rocksdb_snapshot_t *snapshot);
+
+void
+rocksdb_snapshot_destroy (rocksdb_snapshot_t *snapshot);
 
 #ifdef __cplusplus
 }