@harperfast/rocksdb-js 1.0.1 → 1.1.0

package/dist/index.d.cts

@@ -75,6 +75,11 @@ interface StoreOptions extends Omit<NativeDatabaseOptions, "mode" | "transaction
   * If `true`, the encoder will use a random access structure.
   */
   randomAccessStructure?: boolean;
+  /**
+  * When `true`, the database is opened in read-only mode. Write operations
+  * will throw an error with code `ERR_DATABASE_READONLY`.
+  */
+  readOnly?: boolean;
   sharedStructuresKey?: symbol;
   /**
   * A string containing the amount of time or the number of milliseconds to
@@ -180,6 +185,11 @@ declare class Store {
   */
   pessimistic: boolean;
   /**
+  * Whether the database is open in readonly mode. When `true`, write
+  * operations will throw an error with code `ERR_DATABASE_READONLY`.
+  */
+  readOnly: boolean;
+  /**
   * Encoder specific flag used to signal that the encoder should use a random
   * access structure.
   */
@@ -416,7 +426,7 @@ type TransactionEntry = {
   endTxn: boolean;
 };
 type TransactionLog = {
-  new (name: string): TransactionLog;
+  new (db: NativeDatabase, name: string): TransactionLog;
   addEntry(data: Buffer | Uint8Array, txnId?: number): void;
   getLogFileSize(sequenceId?: number): number;
   name: string;
@@ -438,6 +448,7 @@ type NativeDatabaseOptions = {
   name?: string;
   noBlockCache?: boolean;
   parallelismThreads?: number;
+  readOnly?: boolean;
   statsLevel?: (typeof stats.StatsLevel)[keyof typeof stats.StatsLevel];
   transactionLogMaxAgeThreshold?: number;
   transactionLogMaxSize?: number;
@@ -911,6 +922,8 @@ interface RocksDatabaseOptions extends StoreOptions {
   */
   name?: string;
 }
+type RocksDBStat = number | StatsHistogramData;
+type RocksDBStats = Record<string, RocksDBStat>;
 /**
 * The main class for interacting with a RocksDB database.
 *
@@ -1032,7 +1045,7 @@ declare class RocksDatabase extends DBI<DBITransactional> {
   * @param statName - The name of the statistic to retrieve.
   * @returns The statistic value.
   */
-  getStat(statName: string): number | StatsHistogramData;
+  getStat(statName: string): RocksDBStat;
   /**
   * Gets the RocksDB statistics. Requires statistics to be enabled.
   *
@@ -1042,7 +1055,7 @@ declare class RocksDatabase extends DBI<DBITransactional> {
   * const stats = db.getStats();
   * ```
   */
-  getStats(all?: boolean): Record<string, number | StatsHistogramData>;
+  getStats(all?: boolean): RocksDBStats;
   /**
   * Gets or creates a buffer that can be shared across worker threads.
   *
@@ -1096,6 +1109,10 @@ declare class RocksDatabase extends DBI<DBITransactional> {
   */
   get name(): string;
   /**
+  * Whether the database is open in readonly mode.
+  */
+  get readOnly(): boolean;
+  /**
   * Sugar method for opening a database.
   *
   * @param pathOrStore - The filesystem path to the database or a custom store.
@@ -1246,5 +1263,5 @@ declare const versions: {
   "rocksdb-js": string;
 };
 //#endregion
-export { DBI, DBIterator, type IteratorOptions, type Key, RocksDatabase, type RocksDatabaseOptions, type StatsHistogramData, Store, type StoreContext, type StoreGetOptions, type StoreIteratorOptions, type StorePutOptions, type StoreRangeOptions, type StoreRemoveOptions, Transaction, type TransactionEntry, TransactionLog, constants, currentThreadId, parseTransactionLog, registryStatus, shutdown, stats, versions };
+export { DBI, DBIterator, type IteratorOptions, type Key, type RocksDBStat, type RocksDBStats, RocksDatabase, type RocksDatabaseOptions, type StatsHistogramData, Store, type StoreContext, type StoreGetOptions, type StoreIteratorOptions, type StorePutOptions, type StoreRangeOptions, type StoreRemoveOptions, Transaction, type TransactionEntry, TransactionLog, constants, currentThreadId, parseTransactionLog, registryStatus, shutdown, stats, versions };
 //# sourceMappingURL=index.d.cts.map

package/dist/index.d.mts

@@ -75,6 +75,11 @@ interface StoreOptions extends Omit<NativeDatabaseOptions, "mode" | "transaction
   * If `true`, the encoder will use a random access structure.
   */
   randomAccessStructure?: boolean;
+  /**
+  * When `true`, the database is opened in read-only mode. Write operations
+  * will throw an error with code `ERR_DATABASE_READONLY`.
+  */
+  readOnly?: boolean;
   sharedStructuresKey?: symbol;
   /**
   * A string containing the amount of time or the number of milliseconds to
@@ -180,6 +185,11 @@ declare class Store {
   */
   pessimistic: boolean;
   /**
+  * Whether the database is open in readonly mode. When `true`, write
+  * operations will throw an error with code `ERR_DATABASE_READONLY`.
+  */
+  readOnly: boolean;
+  /**
   * Encoder specific flag used to signal that the encoder should use a random
   * access structure.
   */
@@ -416,7 +426,7 @@ type TransactionEntry = {
   endTxn: boolean;
 };
 type TransactionLog = {
-  new (name: string): TransactionLog;
+  new (db: NativeDatabase, name: string): TransactionLog;
   addEntry(data: Buffer | Uint8Array, txnId?: number): void;
   getLogFileSize(sequenceId?: number): number;
   name: string;
@@ -438,6 +448,7 @@ type NativeDatabaseOptions = {
   name?: string;
   noBlockCache?: boolean;
   parallelismThreads?: number;
+  readOnly?: boolean;
   statsLevel?: (typeof stats.StatsLevel)[keyof typeof stats.StatsLevel];
   transactionLogMaxAgeThreshold?: number;
   transactionLogMaxSize?: number;
@@ -911,6 +922,8 @@ interface RocksDatabaseOptions extends StoreOptions {
   */
   name?: string;
 }
+type RocksDBStat = number | StatsHistogramData;
+type RocksDBStats = Record<string, RocksDBStat>;
 /**
 * The main class for interacting with a RocksDB database.
 *
@@ -1032,7 +1045,7 @@ declare class RocksDatabase extends DBI<DBITransactional> {
   * @param statName - The name of the statistic to retrieve.
   * @returns The statistic value.
   */
-  getStat(statName: string): number | StatsHistogramData;
+  getStat(statName: string): RocksDBStat;
   /**
   * Gets the RocksDB statistics. Requires statistics to be enabled.
   *
@@ -1042,7 +1055,7 @@ declare class RocksDatabase extends DBI<DBITransactional> {
   * const stats = db.getStats();
   * ```
   */
-  getStats(all?: boolean): Record<string, number | StatsHistogramData>;
+  getStats(all?: boolean): RocksDBStats;
   /**
   * Gets or creates a buffer that can be shared across worker threads.
   *
@@ -1096,6 +1109,10 @@ declare class RocksDatabase extends DBI<DBITransactional> {
   */
   get name(): string;
   /**
+  * Whether the database is open in readonly mode.
+  */
+  get readOnly(): boolean;
+  /**
   * Sugar method for opening a database.
   *
   * @param pathOrStore - The filesystem path to the database or a custom store.
@@ -1246,5 +1263,5 @@ declare const versions: {
   "rocksdb-js": string;
 };
 //#endregion
-export { DBI, DBIterator, type IteratorOptions, type Key, RocksDatabase, type RocksDatabaseOptions, type StatsHistogramData, Store, type StoreContext, type StoreGetOptions, type StoreIteratorOptions, type StorePutOptions, type StoreRangeOptions, type StoreRemoveOptions, Transaction, type TransactionEntry, TransactionLog, constants, currentThreadId, parseTransactionLog, registryStatus, shutdown, stats, versions };
+export { DBI, DBIterator, type IteratorOptions, type Key, type RocksDBStat, type RocksDBStats, RocksDatabase, type RocksDatabaseOptions, type StatsHistogramData, Store, type StoreContext, type StoreGetOptions, type StoreIteratorOptions, type StorePutOptions, type StoreRangeOptions, type StoreRemoveOptions, Transaction, type TransactionEntry, TransactionLog, constants, currentThreadId, parseTransactionLog, registryStatus, shutdown, stats, versions };
 //# sourceMappingURL=index.d.mts.map

package/dist/index.mjs

@@ -629,6 +629,11 @@ var Store = class {
 	*/
 	pessimistic;
 	/**
+	* Whether the database is open in readonly mode. When `true`, write
+	* operations will throw an error with code `ERR_DATABASE_READONLY`.
+	*/
+	readOnly;
+	/**
 	* Encoder specific flag used to signal that the encoder should use a random
 	* access structure.
 	*/
@@ -697,6 +702,7 @@ var Store = class {
 		this.parallelismThreads = options?.parallelismThreads ?? 1;
 		this.path = path;
 		this.pessimistic = options?.pessimistic ?? false;
+		this.readOnly = options?.readOnly ?? false;
 		this.randomAccessStructure = options?.randomAccessStructure ?? false;
 		this.readKey = readKey;
 		this.sharedStructuresKey = options?.sharedStructuresKey;
@@ -767,6 +773,7 @@ var Store = class {
 		const keyParam = getKeyParam(this.encodeKey(key));
 		let flags = 0;
 		if (alwaysCreateNewBuffer) flags |= ALWAYS_CREATE_NEW_BUFFER_FLAG;
+		if (this.readOnly) txnId = void 0;
 		const result = context.getSync(keyParam, flags | ONLY_IF_IN_MEMORY_CACHE_FLAG, txnId);
 		if (typeof result === "number") {
 			if (result === NOT_IN_MEMORY_CACHE_FLAG) return new Promise((resolve, reject) => {
@@ -839,7 +846,7 @@ var Store = class {
 	*/
 	getTxnId(options) {
 		let txnId;
-		if (options?.transaction) {
+		if (!this.readOnly && options?.transaction) {
 			txnId = options.transaction.id;
 			if (txnId === void 0) throw new TypeError("Invalid transaction");
 		}
@@ -907,6 +914,7 @@ var Store = class {
 			name: this.name,
 			noBlockCache: this.noBlockCache,
 			parallelismThreads: this.parallelismThreads,
+			readOnly: this.readOnly,
 			statsLevel: this.statsLevel,
 			transactionLogMaxAgeThreshold: this.transactionLogMaxAgeThreshold,
 			transactionLogMaxSize: this.transactionLogMaxSize,
@@ -1022,9 +1030,17 @@ var Transaction = class extends DBI {
 	* @param options - The options for the transaction.
 	*/
 	constructor(store, options) {
-		const txn = new NativeTransaction(store.db, options);
-		super(store, txn);
-		this.#txn = txn;
+		if (store.readOnly) {
+			super(store);
+			this.#txn = { id: 0 };
+			this.abort = this.commitSync = this.setTimestamp = () => {};
+			this.commit = async () => {};
+			this.getTimestamp = () => 0;
+		} else {
+			const txn = new NativeTransaction(store.db, options);
+			super(store, txn);
+			this.#txn = txn;
+		}
 	}
 	/**
 	* Abort the transaction.
@@ -1354,6 +1370,12 @@ var RocksDatabase = class RocksDatabase extends DBI {
 		return this.#name;
 	}
 	/**
+	* Whether the database is open in readonly mode.
+	*/
+	get readOnly() {
+		return this.store.readOnly;
+	}
+	/**
 	* Sugar method for opening a database.
 	*
 	* @param pathOrStore - The filesystem path to the database or a custom store.
@@ -1884,7 +1906,7 @@ function loadLastPosition(transactionLog, readUncommitted) {
 //#region src/index.ts
 const versions = {
 	rocksdb: version,
-	"rocksdb-js": "1.0.1"
+	"rocksdb-js": "1.1.0"
 };
 
 //#endregion