@harperfast/rocksdb-js 0.1.2 → 0.1.4

package/dist/index.d.cts

@@ -50,7 +50,12 @@ declare class DBIterator<T> implements Iterator<DBIteratorValue<T>> {
 }
 //#endregion
 //#region src/store.d.ts
-type Context = NativeDatabase | NativeTransaction;
+type StoreContext = NativeDatabase | NativeTransaction;
+type StoreGetOptions = GetOptions & DBITransactional;
+type StoreIteratorOptions = IteratorOptions & DBITransactional;
+type StorePutOptions = PutOptions & DBITransactional;
+type StoreRangeOptions = RangeOptions & DBITransactional;
+type StoreRemoveOptions = DBITransactional | unknown;
 /**
 * Options for the `Store` class.
 */
@@ -248,10 +253,12 @@ declare class Store {
   * @returns The encoded value.
   */
   encodeValue(value: any): BufferWithDataView | Uint8Array;
-  get(context: NativeDatabase | NativeTransaction, key: Key, alwaysCreateNewBuffer?: boolean, txnId?: number): any | undefined;
-  getCount(context: NativeDatabase | NativeTransaction, options?: RangeOptions): number;
-  getRange(context: NativeDatabase | NativeTransaction, options?: IteratorOptions & DBITransactional): ExtendedIterable<DBIteratorValue<any>>;
-  getSync(context: NativeDatabase | NativeTransaction, key: Key, alwaysCreateNewBuffer?: boolean, options?: GetOptions & DBITransactional): any | undefined;
+  get(context: StoreContext, key: Key, alwaysCreateNewBuffer?: boolean, txnId?: number): any | undefined;
+  getCount(context: StoreContext, options?: StoreRangeOptions): number;
+  getKeys(context: StoreContext, options?: StoreIteratorOptions): any | undefined;
+  getKeysCount(context: StoreContext, options?: StoreRangeOptions): number;
+  getRange(context: StoreContext, options?: StoreIteratorOptions): ExtendedIterable<DBIteratorValue<any>>;
+  getSync(context: StoreContext, key: Key, alwaysCreateNewBuffer?: boolean, options?: StoreGetOptions): any | undefined;
   /**
   * Checks if the data method options object contains a transaction ID and
   * returns it.
@@ -294,8 +301,8 @@ declare class Store {
   * are performed.
   */
   open(): boolean;
-  putSync(context: NativeDatabase | NativeTransaction, key: Key, value: any, options?: PutOptions & DBITransactional): void;
-  removeSync(context: NativeDatabase | NativeTransaction, key: Key, options?: DBITransactional | undefined): void;
+  putSync(context: StoreContext, key: Key, value: any, options?: StorePutOptions): void;
+  removeSync(context: StoreContext, key: Key, options?: StoreRemoveOptions): void;
   /**
   * Attempts to acquire a lock for a given key. If the lock is available,
   * the function returns `true` and the optional callback is never called.
@@ -321,7 +328,7 @@ declare class Store {
   * @param name - The name of the transaction log.
   * @returns The transaction log.
   */
-  useLog(context: NativeDatabase | NativeTransaction, name: string | number): TransactionLog;
+  useLog(context: StoreContext, name: string | number): TransactionLog;
   /**
   * Acquires a lock on the given key and calls the callback.
   *
@@ -427,6 +434,7 @@ type NativeDatabase = {
   clear(resolve: ResolveCallback<void>, reject: RejectCallback): void;
   clearSync(): void;
   close(): void;
+  destroy(): void;
   drop(resolve: ResolveCallback<void>, reject: RejectCallback): void;
   dropSync(): void;
   flush(resolve: ResolveCallback<void>, reject: RejectCallback): void;
@@ -459,6 +467,17 @@ type NativeDatabase = {
 type RocksDatabaseConfig = {
   blockCacheSize?: number;
 };
+type RegistryStatusDB = {
+  path: string;
+  refCount: number;
+  columnFamilies: string[];
+  transactions: number;
+  closables: number;
+  locks: number;
+  userSharedBuffers: number;
+  listenerCallbacks: number;
+};
+type RegistryStatus = RegistryStatusDB[];
 declare const constants: {
   TRANSACTION_LOG_TOKEN: number;
   TRANSACTION_LOG_FILE_HEADER_SIZE: number;
@@ -470,6 +489,7 @@ declare const constants: {
 declare const NativeDatabase: NativeDatabase;
 declare const NativeTransaction: NativeTransaction;
 declare const TransactionLog: TransactionLog;
+declare const registryStatus: () => RegistryStatus;
 declare const shutdown: () => void;
 //#endregion
 //#region src/transaction.d.ts
@@ -626,7 +646,10 @@ interface DBITransactional {
 * This class is not meant to be used directly.
 */
 declare class DBI<T extends DBITransactional | unknown = unknown> {
-  #private;
+  /**
+  * The RocksDB context for `get()`, `put()`, and `remove()`.
+  */
+  _context: StoreContext;
   /**
   * The database store instance. The store instance is tied to the database
   * instance and shared with transaction instances.
@@ -893,6 +916,7 @@ declare class RocksDatabase extends DBI<DBITransactional> {
   * ```
   */
   static config(options: RocksDatabaseConfig): void;
+  destroy(): void;
   drop(): Promise<void>;
   dropSync(): void;
   get encoder(): Encoder | null;
@@ -1041,6 +1065,10 @@ declare class RocksDatabase extends DBI<DBITransactional> {
   */
   purgeLogs(options?: PurgeLogsOptions): string[];
   /**
+  * The status of the database.
+  */
+  get status(): "open" | "closed";
+  /**
   * Executes all operations in the callback as a single transaction.
   *
   * @param callback - A async function that receives the transaction as an argument.
@@ -1153,5 +1181,5 @@ declare const versions: {
   "rocksdb-js": string;
 };
 //#endregion
-export { type Context, DBIterator, type IteratorOptions, type Key, RocksDatabase, type RocksDatabaseOptions, Store, Transaction, type TransactionEntry, TransactionLog, constants, parseTransactionLog, shutdown, versions };
+export { DBI, DBIterator, type IteratorOptions, type Key, RocksDatabase, type RocksDatabaseOptions, Store, type StoreContext, type StoreGetOptions, type StoreIteratorOptions, type StorePutOptions, type StoreRangeOptions, type StoreRemoveOptions, Transaction, type TransactionEntry, TransactionLog, constants, parseTransactionLog, registryStatus, shutdown, versions };
 //# sourceMappingURL=index.d.cts.map

package/dist/index.d.mts

@@ -50,7 +50,12 @@ declare class DBIterator<T> implements Iterator<DBIteratorValue<T>> {
 }
 //#endregion
 //#region src/store.d.ts
-type Context = NativeDatabase | NativeTransaction;
+type StoreContext = NativeDatabase | NativeTransaction;
+type StoreGetOptions = GetOptions & DBITransactional;
+type StoreIteratorOptions = IteratorOptions & DBITransactional;
+type StorePutOptions = PutOptions & DBITransactional;
+type StoreRangeOptions = RangeOptions & DBITransactional;
+type StoreRemoveOptions = DBITransactional | unknown;
 /**
 * Options for the `Store` class.
 */
@@ -248,10 +253,12 @@ declare class Store {
   * @returns The encoded value.
   */
   encodeValue(value: any): BufferWithDataView | Uint8Array;
-  get(context: NativeDatabase | NativeTransaction, key: Key, alwaysCreateNewBuffer?: boolean, txnId?: number): any | undefined;
-  getCount(context: NativeDatabase | NativeTransaction, options?: RangeOptions): number;
-  getRange(context: NativeDatabase | NativeTransaction, options?: IteratorOptions & DBITransactional): ExtendedIterable<DBIteratorValue<any>>;
-  getSync(context: NativeDatabase | NativeTransaction, key: Key, alwaysCreateNewBuffer?: boolean, options?: GetOptions & DBITransactional): any | undefined;
+  get(context: StoreContext, key: Key, alwaysCreateNewBuffer?: boolean, txnId?: number): any | undefined;
+  getCount(context: StoreContext, options?: StoreRangeOptions): number;
+  getKeys(context: StoreContext, options?: StoreIteratorOptions): any | undefined;
+  getKeysCount(context: StoreContext, options?: StoreRangeOptions): number;
+  getRange(context: StoreContext, options?: StoreIteratorOptions): ExtendedIterable<DBIteratorValue<any>>;
+  getSync(context: StoreContext, key: Key, alwaysCreateNewBuffer?: boolean, options?: StoreGetOptions): any | undefined;
   /**
   * Checks if the data method options object contains a transaction ID and
   * returns it.
@@ -294,8 +301,8 @@ declare class Store {
   * are performed.
   */
   open(): boolean;
-  putSync(context: NativeDatabase | NativeTransaction, key: Key, value: any, options?: PutOptions & DBITransactional): void;
-  removeSync(context: NativeDatabase | NativeTransaction, key: Key, options?: DBITransactional | undefined): void;
+  putSync(context: StoreContext, key: Key, value: any, options?: StorePutOptions): void;
+  removeSync(context: StoreContext, key: Key, options?: StoreRemoveOptions): void;
   /**
   * Attempts to acquire a lock for a given key. If the lock is available,
   * the function returns `true` and the optional callback is never called.
@@ -321,7 +328,7 @@ declare class Store {
   * @param name - The name of the transaction log.
   * @returns The transaction log.
   */
-  useLog(context: NativeDatabase | NativeTransaction, name: string | number): TransactionLog;
+  useLog(context: StoreContext, name: string | number): TransactionLog;
   /**
   * Acquires a lock on the given key and calls the callback.
   *
@@ -427,6 +434,7 @@ type NativeDatabase = {
   clear(resolve: ResolveCallback<void>, reject: RejectCallback): void;
   clearSync(): void;
   close(): void;
+  destroy(): void;
   drop(resolve: ResolveCallback<void>, reject: RejectCallback): void;
   dropSync(): void;
   flush(resolve: ResolveCallback<void>, reject: RejectCallback): void;
@@ -459,6 +467,17 @@ type NativeDatabase = {
 type RocksDatabaseConfig = {
   blockCacheSize?: number;
 };
+type RegistryStatusDB = {
+  path: string;
+  refCount: number;
+  columnFamilies: string[];
+  transactions: number;
+  closables: number;
+  locks: number;
+  userSharedBuffers: number;
+  listenerCallbacks: number;
+};
+type RegistryStatus = RegistryStatusDB[];
 declare const constants: {
   TRANSACTION_LOG_TOKEN: number;
   TRANSACTION_LOG_FILE_HEADER_SIZE: number;
@@ -470,6 +489,7 @@ declare const constants: {
 declare const NativeDatabase: NativeDatabase;
 declare const NativeTransaction: NativeTransaction;
 declare const TransactionLog: TransactionLog;
+declare const registryStatus: () => RegistryStatus;
 declare const shutdown: () => void;
 //#endregion
 //#region src/transaction.d.ts
@@ -626,7 +646,10 @@ interface DBITransactional {
 * This class is not meant to be used directly.
 */
 declare class DBI<T extends DBITransactional | unknown = unknown> {
-  #private;
+  /**
+  * The RocksDB context for `get()`, `put()`, and `remove()`.
+  */
+  _context: StoreContext;
   /**
   * The database store instance. The store instance is tied to the database
   * instance and shared with transaction instances.
@@ -893,6 +916,7 @@ declare class RocksDatabase extends DBI<DBITransactional> {
   * ```
   */
   static config(options: RocksDatabaseConfig): void;
+  destroy(): void;
   drop(): Promise<void>;
   dropSync(): void;
   get encoder(): Encoder | null;
@@ -1041,6 +1065,10 @@ declare class RocksDatabase extends DBI<DBITransactional> {
   */
   purgeLogs(options?: PurgeLogsOptions): string[];
   /**
+  * The status of the database.
+  */
+  get status(): "open" | "closed";
+  /**
   * Executes all operations in the callback as a single transaction.
   *
   * @param callback - A async function that receives the transaction as an argument.
@@ -1153,5 +1181,5 @@ declare const versions: {
   "rocksdb-js": string;
 };
 //#endregion
-export { type Context, DBIterator, type IteratorOptions, type Key, RocksDatabase, type RocksDatabaseOptions, Store, Transaction, type TransactionEntry, TransactionLog, constants, parseTransactionLog, shutdown, versions };
+export { DBI, DBIterator, type IteratorOptions, type Key, RocksDatabase, type RocksDatabaseOptions, Store, type StoreContext, type StoreGetOptions, type StoreIteratorOptions, type StorePutOptions, type StoreRangeOptions, type StoreRemoveOptions, Transaction, type TransactionEntry, TransactionLog, constants, parseTransactionLog, registryStatus, shutdown, versions };
 //# sourceMappingURL=index.d.mts.map

package/dist/index.mjs

@@ -7,7 +7,7 @@ import { Encoder } from "msgpackr";
 import * as orderedBinary from "ordered-binary";
 import { ExtendedIterable } from "@harperfast/extended-iterable";
 
-//#region rolldown:runtime
+//#region \0rolldown/runtime.js
 var __require = /* @__PURE__ */ createRequire(import.meta.url);
 
 //#endregion
@@ -55,8 +55,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
@@ -144,7 +145,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.
@@ -159,7 +160,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.
@@ -190,14 +191,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,
@@ -211,7 +212,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
@@ -220,16 +221,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.
@@ -244,7 +242,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.
@@ -264,7 +262,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
@@ -281,7 +279,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.
@@ -350,7 +348,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.
@@ -366,7 +364,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
@@ -382,7 +380,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
@@ -398,7 +396,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
@@ -417,7 +415,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);
 	}
 };
 
@@ -774,6 +772,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 };
@@ -1075,7 +1082,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);
@@ -1091,9 +1097,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.
@@ -1120,14 +1125,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() {
@@ -1386,6 +1392,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.
@@ -1774,9 +1786,9 @@ function loadLastPosition(transactionLog, readUncommitted) {
 //#region src/index.ts
 const versions = {
 	rocksdb: version,
-	"rocksdb-js": "0.1.2"
+	"rocksdb-js": "0.1.4"
 };
 
 //#endregion
-export { DBIterator, RocksDatabase, Store, Transaction, TransactionLog, constants, parseTransactionLog, shutdown, versions };
+export { DBI, DBIterator, RocksDatabase, Store, Transaction, TransactionLog, constants, parseTransactionLog, registryStatus, shutdown, versions };
 //# sourceMappingURL=index.mjs.map