@harperfast/rocksdb-js 1.2.0 → 1.3.0

package/README.md

@@ -106,11 +106,26 @@ Sets global database settings.
     Defaults to 32MB. Set to `0` (zero) disables block cache for future opened databases. Existing
     block cache for any opened databases is resized immediately. Negative values throw an error.
   - `compactOnClose: boolean` When `true`, compacts the database on close. Defaults to `false`.
+  - `writeBufferManagerAllowStall: boolean` When `true`, writes are stalled once the manager's
+    `buffer_size` is exceeded, providing a hard cap on memtable memory. When `false`, memtables are
+    allowed to grow past the limit and flushes are simply scheduled more aggressively. Off by
+    default to favor write throughput over hard memory bounding. Defaults to `false`.
+  - `writeBufferManagerCostToCache: boolean` When `true`, memtable memory is "charged" against the
+    shared block cache so the block cache and write buffers draw from a single pool. During write
+    bursts the cache shrinks to make room for memtables; once memtables flush, the cache can grow
+    back into the reclaimed space. Defaults to `false`.
+  - `writeBufferManagerSize: number` Total memtable memory limit (bytes) shared across every
+    database opened in this process. When set, RocksDB uses a single `WriteBufferManager` so write
+    buffers are bounded process-wide rather than per database. A value of `0` disables the manager.
+    Defaults to `0`.
 
 ```typescript
 RocksDatabase.config({
 	blockCacheSize: 100 * 1024 * 1024, // 100MB
 	compactOnClose: true,
+	writeBufferManagerAllowStall: false,
+	writeBufferManagerCostToCache: false,
+	writeBufferManagerSize: 64 * 1024 * 1024, // 64MB
 });
 ```
 
@@ -1421,6 +1436,24 @@ To run the tests without code coverage, run:
 pnpm test
 ```
 
+#### Native C++ unit tests (GoogleTest)
+
+Build and run standalone native tests (RocksDB + binding `core/` helpers, no Node in the test
+binary):
+
+```bash
+pnpm test:native
+```
+
+Coverage report for native tests (macOS/Linux; requires `lcov`):
+
+```bash
+pnpm coverage:native
+# open coverage/native/html/index.html
+```
+
+Note: Code coverage is not supported on Windows. Tests are run without coverage.
+
 To run a specific test suite, for example `"ranges"`, run:
 
 ```bash

package/dist/index.cjs

@@ -595,8 +595,6 @@ const VALUE_BUFFER = createFixedBuffer(64 * 1024);
 const ITERATOR_STATE_BUFFER = Buffer.allocUnsafeSlow(8);
 const ITERATOR_STATE = new Uint32Array(ITERATOR_STATE_BUFFER.buffer, ITERATOR_STATE_BUFFER.byteOffset, 2);
 const MAX_KEY_SIZE = 1024 * 1024;
-const RESET_BUFFER_MODE = 1024;
-const REUSE_BUFFER_MODE = 512;
 const SAVE_BUFFER_SIZE = 8192;
 /**
 * A store wraps the `NativeDatabase` binding and database settings so that a
@@ -658,6 +656,24 @@ var Store = class {
 	*/
 	maxKeySize;
 	/**
+	* The maximum number of memtables that can be queued per column family
+	* before writes stall. Higher values absorb write bursts while flushes catch
+	* up, at the cost of memory.
+	*/
+	maxWriteBufferNumber;
+	/**
+	* The bytes of recent memtable history to retain in memory for transaction
+	* conflict checking. `-1` derives the value from
+	* `maxWriteBufferNumber * writeBufferSize`.
+	*/
+	maxWriteBufferSizeToMaintain;
+	/**
+	* The total memtable budget in bytes across all column families. When the
+	* sum of memtables reaches this size, RocksDB flushes the largest one. `0`
+	* disables the global trigger so per-CF `writeBufferSize` drives flushing.
+	*/
+	dbWriteBufferSize;
+	/**
 	* The name of the store (e.g. the column family). Defaults to `'default'`.
 	*/
 	name;
@@ -667,7 +683,8 @@ var Store = class {
 	noBlockCache;
 	/**
 	* The number of threads to use for parallel operations. This is a RocksDB
-	* option.
+	* option. When undefined, the native layer picks
+	* `max(1, hardware_concurrency() / 2)`.
 	*/
 	parallelismThreads;
 	/**
@@ -725,6 +742,11 @@ var Store = class {
 	*/
 	transactionLogsPath;
 	/**
+	* The per-column-family memtable size in bytes at which the memtable is
+	* sealed and flushed.
+	*/
+	writeBufferSize;
+	/**
 	* The function used to encode keys using the shared `keyBuffer`.
 	*/
 	writeKey;
@@ -739,6 +761,7 @@ var Store = class {
 		if (options !== void 0 && options !== null && typeof options !== "object") throw new TypeError("Database options must be an object");
 		const { keyEncoding, readKey, writeKey } = initKeyEncoder(options?.keyEncoding, options?.keyEncoder);
 		this.db = new NativeDatabase();
+		this.dbWriteBufferSize = options?.dbWriteBufferSize;
 		this.decoder = options?.decoder ?? null;
 		this.disableWAL = options?.disableWAL ?? false;
 		this.enableStats = options?.enableStats ?? false;
@@ -749,9 +772,11 @@ var Store = class {
 		this.keyBuffer = KEY_BUFFER;
 		this.keyEncoding = keyEncoding;
 		this.maxKeySize = options?.maxKeySize ?? MAX_KEY_SIZE;
+		this.maxWriteBufferNumber = options?.maxWriteBufferNumber;
+		this.maxWriteBufferSizeToMaintain = options?.maxWriteBufferSizeToMaintain;
 		this.name = options?.name ?? "default";
 		this.noBlockCache = options?.noBlockCache;
-		this.parallelismThreads = options?.parallelismThreads ?? 1;
+		this.parallelismThreads = options?.parallelismThreads;
 		this.path = path;
 		this.pessimistic = options?.pessimistic ?? false;
 		this.readOnly = options?.readOnly ?? false;
@@ -763,6 +788,7 @@ var Store = class {
 		this.transactionLogMaxSize = options?.transactionLogMaxSize;
 		this.transactionLogRetention = options?.transactionLogRetention;
 		this.transactionLogsPath = options?.transactionLogsPath;
+		this.writeBufferSize = options?.writeBufferSize;
 		this.writeKey = writeKey;
 	}
 	/**
@@ -858,7 +884,7 @@ var Store = class {
 	encodeValue(value) {
 		if (value && value["binary-data"]) return value["binary-data"];
 		if (typeof this.encoder?.encode === "function") {
-			if (this.encoder.copyBuffers) return this.encoder.encode(value, REUSE_BUFFER_MODE | RESET_BUFFER_MODE);
+			if (this.encoder.copyBuffers) return this.encoder.encode(value, 1536);
 			const valueBuffer = this.encoder.encode(value);
 			if (typeof valueBuffer === "string") return Buffer.from(valueBuffer);
 			return valueBuffer;
@@ -1024,8 +1050,11 @@ var Store = class {
 	open() {
 		if (this.db.opened) return true;
 		this.db.open(this.path, {
+			dbWriteBufferSize: this.dbWriteBufferSize,
 			disableWAL: this.disableWAL,
 			enableStats: this.enableStats,
+			maxWriteBufferNumber: this.maxWriteBufferNumber,
+			maxWriteBufferSizeToMaintain: this.maxWriteBufferSizeToMaintain,
 			mode: this.pessimistic ? "pessimistic" : "optimistic",
 			name: this.name,
 			noBlockCache: this.noBlockCache,
@@ -1035,7 +1064,8 @@ var Store = class {
 			transactionLogMaxAgeThreshold: this.transactionLogMaxAgeThreshold,
 			transactionLogMaxSize: this.transactionLogMaxSize,
 			transactionLogRetentionMs: this.transactionLogRetention ? parseDuration(this.transactionLogRetention) : void 0,
-			transactionLogsPath: this.transactionLogsPath
+			transactionLogsPath: this.transactionLogsPath,
+			writeBufferSize: this.writeBufferSize
 		});
 		return false;
 	}
@@ -2068,7 +2098,7 @@ function loadLastPosition(transactionLog, readUncommitted) {
 //#region src/index.ts
 const versions = {
 	rocksdb: version,
-	"rocksdb-js": "1.2.0"
+	"rocksdb-js": "1.3.0"
 };
 
 //#endregion