@harperfast/rocksdb-js 0.1.1 → 0.1.3

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,6 +128,14 @@ There's also a static `open()` method for convenience that performs the same thi
 const db = RocksDatabase.open('path/to/db');
 ```
 
+### `db.status: 'opened' | 'closed'`
+
+Returns a string `'opened'` or `'closed'` indicating if the database is opened or closed.
+
+```typescript
+console.log(db.status);
+```
+
 ## Data Operations
 
 ### `db.clear(options?): Promise<number>`
@@ -144,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
@@ -835,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
@@ -846,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

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
@@ -1079,10 +1081,15 @@ var Transaction = class extends DBI {
 * ```
 */
 var RocksDatabase = class RocksDatabase extends DBI {
+	/**
+	* The name of the database.
+	*/
+	#name;
 	constructor(pathOrStore, options) {
 		if (typeof pathOrStore === "string") super(new Store(pathOrStore, options));
 		else if (pathOrStore instanceof Store) super(pathOrStore);
 		else throw new TypeError("Invalid database path or store");
+		this.#name = options?.name ?? "default";
 	}
 	/**
 	* Removes all data from the database asynchronously.
@@ -1094,7 +1101,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);
@@ -1110,9 +1116,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.
@@ -1139,14 +1144,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() {
@@ -1281,6 +1287,12 @@ var RocksDatabase = class RocksDatabase extends DBI {
 		return this.store.listLogs();
 	}
 	/**
+	* The name of the database.
+	*/
+	get name() {
+		return this.#name;
+	}
+	/**
 	* Sugar method for opening a database.
 	*
 	* @param pathOrStore - The filesystem path to the database or a custom store.
@@ -1399,6 +1411,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.
@@ -1787,7 +1805,7 @@ function loadLastPosition(transactionLog, readUncommitted) {
 //#region src/index.ts
 const versions = {
 	rocksdb: version,
-	"rocksdb-js": "0.1.1"
+	"rocksdb-js": "0.1.3"
 };
 
 //#endregion
@@ -1798,6 +1816,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