@harperfast/rocksdb-js 0.1.2 → 0.1.4

package/README.md

@@ -91,6 +91,26 @@ RocksDatabase.config({
 });
 ```
 
+### `db.isOpen(): boolean`
+
+Returns `true` if the database is open, otherwise false.
+
+```typescript
+console.log(db.isOpen()); // true or false
+```
+
+### `db.name: string`
+
+Returns the database column family's name.
+
+```typescript
+const db = new RocksDatabase('path/to/db');
+console.log(db.name); // 'default'
+
+const db2 = new RocksDatabase('path/to/db', { name: 'users' });
+console.log(db.name); // 'users'
+```
+
 ### `db.open(): RocksDatabase`
 
 Opens the database at the given path. This must be called before performing any data operations.
@@ -108,16 +128,12 @@ There's also a static `open()` method for convenience that performs the same thi
 const db = RocksDatabase.open('path/to/db');
 ```
 
-### `db.name: string`
+### `db.status: 'opened' | 'closed'`
 
-Returns the database column family's name.
+Returns a string `'opened'` or `'closed'` indicating if the database is opened or closed.
 
 ```typescript
-const db = new RocksDatabase('path/to/db');
-console.log(db.name); // 'default'
-
-const db2 = new RocksDatabase('path/to/db', { name: 'users' });
-console.log(db.name); // 'users'
+console.log(db.status);
 ```
 
 ## Data Operations
@@ -156,6 +172,16 @@ const entriesRemoved = db.clearSync();
 console.log(entriesRemoved); // 10
 ```
 
+### `db.destroy(): void`
+
+Completely removes a database based on the `db` instance's path including all data, column families,
+and files on disk.
+
+```typescript
+db.destroy();
+console.log(fs.existsSync(db.path)); // false
+```
+
 ### `db.drop(): Promise<void>`
 
 Removes all entries in the database. If the database was opened with a `name`, the database will be
@@ -847,6 +873,24 @@ Returns an object containing all of the information in the log file.
   - `length: number` The size of the entry data.
   - `timestamp: number` The entry timestamp.
 
+### `registryStatus(): RegistryStatus`
+
+Returns an array containing that status of all active RocksDB instances.
+
+- `path: string` The database path.
+- `refCount: number` The number of JavaScript database instances plus the registry's reference.
+- `columnFamiles: string[]` A list of the database's column families.
+- `transactions: number` The count of active transactions.
+- `closables: number` The count of active database, transactions, and iterators.
+- `locks: number` The count of active locks.
+- `userSharedBuffers: number` The count of active user shared buffers.
+- `listenerCallbacks: number` The count of in-flight callbacks.
+
+```typescript
+import { registryStatus } from '@harperfast/rocksdb-js';
+console.log(registryStatus());
+```
+
 ### `shutdown(): void`
 
 The `shutdown()` will flush all in-memory data to disk and wait for any outstanding compactions to
@@ -858,6 +902,15 @@ import { shutdown } from '@harperfast/rocksdb-js';
 process.on('exit', shutdown);
 ```
 
+### `versions: { 'rocksdb': string; 'rocksdb-js': string }`
+
+Returns the `rocksdb-js` and RocksDB version.
+
+```typescript
+import { versions } from '@harperfast/rocksdb-js';
+console.log(versions); // { "rocksdb": "10.10.1", "rocksdb-js": "0.1.2" }
+```
+
 ## Custom Store
 
 The store is a class that sits between the `RocksDatabase` or `Transaction` instance and the native
@@ -874,6 +927,8 @@ The default `Store` contains the following methods which can be overridden:
 - `encodeValue(value)`
 - `get(context, key, resolve, reject, txnId?)`
 - `getCount(context, options?, txnId?)`
+- `getKeys(context, options?)`
+- `getKeysCount(context, options?)`
 - `getRange(context, options?)`
 - `getSync(context, key, options?)`
 - `getUserSharedBuffer(key, defaultBuffer?)`

package/dist/index.cjs

@@ -1,4 +1,5 @@
-//#region rolldown:runtime
+Object.defineProperty(exports, Symbol.toStringTag, { value: 'Module' });
+//#region \0rolldown/runtime.js
 var __create = Object.create;
 var __defProp = Object.defineProperty;
 var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
@@ -79,8 +80,9 @@ const NativeDatabase = binding.Database;
 const NativeIterator = binding.Iterator;
 const NativeTransaction = binding.Transaction;
 const TransactionLog = binding.TransactionLog;
-const version = binding.version;
+const registryStatus = binding.registryStatus;
 const shutdown = binding.shutdown;
+const version = binding.version;
 
 //#endregion
 //#region src/util.ts
@@ -168,7 +170,7 @@ var DBI = class DBI {
 	/**
 	* The RocksDB context for `get()`, `put()`, and `remove()`.
 	*/
-	#context;
+	_context;
 	/**
 	* The database store instance. The store instance is tied to the database
 	* instance and shared with transaction instances.
@@ -183,7 +185,7 @@ var DBI = class DBI {
 	constructor(store, transaction) {
 		if (new.target === DBI) throw new Error("DBI is an abstract class and cannot be instantiated directly");
 		this.store = store;
-		this.#context = transaction || store.db;
+		this._context = transaction || store.db;
 	}
 	/**
 	* Adds a listener for the given key.
@@ -214,14 +216,14 @@ var DBI = class DBI {
 	*/
 	getBinary(key, options) {
 		if (!this.store.isOpen()) return Promise.reject(/* @__PURE__ */ new Error("Database not open"));
-		return this.store.get(this.#context, key, true, this.store.getTxnId(options));
+		return this.store.get(this._context, key, true, this.store.getTxnId(options));
 	}
 	/**
 	* Synchronously retrieves the binary data for the given key.
 	*/
 	getBinarySync(key, options) {
 		if (!this.store.isOpen()) throw new Error("Database not open");
-		return this.store.getSync(this.#context, key, true, options);
+		return this.store.getSync(this._context, key, true, options);
 	}
 	/**
 	* Retrieves the binary data for the given key using a preallocated,
@@ -235,7 +237,7 @@ var DBI = class DBI {
 	*/
 	getBinaryFast(key, options) {
 		if (!this.store.isOpen()) return Promise.reject(/* @__PURE__ */ new Error("Database not open"));
-		return this.store.get(this.#context, key, false, this.store.getTxnId(options));
+		return this.store.get(this._context, key, false, this.store.getTxnId(options));
 	}
 	/**
 	* Synchronously retrieves the binary data for the given key using a
@@ -244,16 +246,13 @@ var DBI = class DBI {
 	*/
 	getBinaryFastSync(key, options) {
 		if (!this.store.isOpen()) throw new Error("Database not open");
-		return this.store.getSync(this.#context, key, false, options);
+		return this.store.getSync(this._context, key, false, options);
 	}
 	/**
 	* Retrieves all keys within a range.
 	*/
 	getKeys(options) {
-		return this.store.getRange(this.#context, {
-			...options,
-			values: false
-		}).map((item) => item.key);
+		return this.store.getKeys(this._context, options);
 	}
 	/**
 	* Retrieves the number of keys within a range.
@@ -268,7 +267,7 @@ var DBI = class DBI {
 	* ```
 	*/
 	getKeysCount(options) {
-		return this.store.getCount(this.#context, options);
+		return this.store.getKeysCount(this._context, options);
 	}
 	/**
 	* Retrieves a range of keys and their values.
@@ -288,7 +287,7 @@ var DBI = class DBI {
 	* ```
 	*/
 	getRange(options) {
-		return this.store.getRange(this.#context, options);
+		return this.store.getRange(this._context, options);
 	}
 	/**
 	* Synchronously retrieves the value for the given key, then returns the
@@ -305,7 +304,7 @@ var DBI = class DBI {
 			return result ? this.store.decodeValue(result) : void 0;
 		}
 		if (!this.store.isOpen()) throw new Error("Database not open");
-		return this.store.decodeValue(this.store.getSync(this.#context, key, true, options));
+		return this.store.decodeValue(this.store.getSync(this._context, key, true, options));
 	}
 	/**
 	* Gets the number of listeners for the given key.
@@ -374,7 +373,7 @@ var DBI = class DBI {
 	* ```
 	*/
 	async put(key, value, options) {
-		return this.store.putSync(this.#context, key, value, options);
+		return this.store.putSync(this._context, key, value, options);
 	}
 	/**
 	* Synchronously stores a value for the given key.
@@ -390,7 +389,7 @@ var DBI = class DBI {
 	* ```
 	*/
 	putSync(key, value, options) {
-		return this.store.putSync(this.#context, key, value, options);
+		return this.store.putSync(this._context, key, value, options);
 	}
 	/**
 	* Removes a value for the given key. If the key does not exist, it will
@@ -406,7 +405,7 @@ var DBI = class DBI {
 	* ```
 	*/
 	async remove(key, options) {
-		return this.store.removeSync(this.#context, key, options);
+		return this.store.removeSync(this._context, key, options);
 	}
 	/**
 	* Removes a value for the given key. If the key does not exist, it will
@@ -422,7 +421,7 @@ var DBI = class DBI {
 	* ```
 	*/
 	removeSync(key, options) {
-		return this.store.removeSync(this.#context, key, options);
+		return this.store.removeSync(this._context, key, options);
 	}
 	/**
 	* Removes an event listener. You must specify the exact same callback that was
@@ -441,7 +440,7 @@ var DBI = class DBI {
 	* @returns The transaction log.
 	*/
 	useLog(name) {
-		return this.store.useLog(this.#context, name);
+		return this.store.useLog(this._context, name);
 	}
 };
 
@@ -798,6 +797,15 @@ var Store = class {
 		}
 		return context.getCount(options, this.getTxnId(options));
 	}
+	getKeys(context, options) {
+		return this.getRange(context, {
+			...options,
+			values: false
+		}).map((item) => item.key);
+	}
+	getKeysCount(context, options) {
+		return this.getCount(context, options);
+	}
 	getRange(context, options) {
 		if (!this.db.opened) throw new Error("Database not open");
 		options = { ...options };
@@ -1099,7 +1107,6 @@ var RocksDatabase = class RocksDatabase extends DBI {
 	* ```
 	*/
 	clear() {
-		if (!this.store.db.opened) return Promise.reject(/* @__PURE__ */ new Error("Database not open"));
 		if (this.store.encoder?.structures !== void 0) this.store.encoder.structures = [];
 		return new Promise((resolve, reject) => {
 			this.store.db.clear(resolve, reject);
@@ -1115,9 +1122,8 @@ var RocksDatabase = class RocksDatabase extends DBI {
 	* ```
 	*/
 	clearSync() {
-		if (!this.store.db.opened) throw new Error("Database not open");
 		if (this.store.encoder?.structures !== void 0) this.store.encoder.structures = [];
-		return this.store.db.clearSync();
+		this.store.db.clearSync();
 	}
 	/**
 	* Closes the database.
@@ -1144,14 +1150,15 @@ var RocksDatabase = class RocksDatabase extends DBI {
 	static config(options) {
 		config(options);
 	}
+	destroy() {
+		this.store.db.destroy();
+	}
 	async drop() {
-		if (!this.store.db.opened) return Promise.reject(/* @__PURE__ */ new Error("Database not open"));
 		return new Promise((resolve, reject) => {
 			this.store.db.drop(resolve, reject);
 		});
 	}
 	dropSync() {
-		if (!this.store.db.opened) throw new Error("Database not open");
 		return this.store.db.dropSync();
 	}
 	get encoder() {
@@ -1410,6 +1417,12 @@ var RocksDatabase = class RocksDatabase extends DBI {
 		return this.store.db.purgeLogs(options);
 	}
 	/**
+	* The status of the database.
+	*/
+	get status() {
+		return this.store.isOpen() ? "open" : "closed";
+	}
+	/**
 	* Executes all operations in the callback as a single transaction.
 	*
 	* @param callback - A async function that receives the transaction as an argument.
@@ -1798,10 +1811,11 @@ function loadLastPosition(transactionLog, readUncommitted) {
 //#region src/index.ts
 const versions = {
 	rocksdb: version,
-	"rocksdb-js": "0.1.2"
+	"rocksdb-js": "0.1.4"
 };
 
 //#endregion
+exports.DBI = DBI;
 exports.DBIterator = DBIterator;
 exports.RocksDatabase = RocksDatabase;
 exports.Store = Store;
@@ -1809,6 +1823,7 @@ exports.Transaction = Transaction;
 exports.TransactionLog = TransactionLog;
 exports.constants = constants;
 exports.parseTransactionLog = parseTransactionLog;
+exports.registryStatus = registryStatus;
 exports.shutdown = shutdown;
 exports.versions = versions;
 //# sourceMappingURL=index.cjs.map