@harperfast/rocksdb-js 1.1.0 → 1.1.1

package/dist/index.d.cts

@@ -16,6 +16,7 @@ interface Encoder {
   encode?: (value: any, mode?: number) => Buffer;
   Encoder?: EncoderFunction;
   freezeData?: boolean;
+  name?: string;
   needsStableBuffer?: boolean;
   randomAccessStructure?: boolean;
   readKey?: (buffer: Buffer, start: number, end: number, inSequence?: boolean) => any;
@@ -372,29 +373,17 @@ interface PutOptions {
 }
 //#endregion
 //#region src/load-binding.d.ts
-type TransactionOptions = {
+type NativeTransactionOptions = {
   /**
   * Whether to disable snapshots.
   *
   * @default false
   */
   disableSnapshot?: boolean;
-  /**
-  * The maximum number of times to retry the transaction.
-  *
-  * @default 3
-  */
-  maxRetries?: number;
-  /**
-  * Whether to retry the transaction if it fails with `IsBusy`.
-  *
-  * @default `true` when the transaction is bound to a transaction log, otherwise `false`
-  */
-  retryOnBusy?: boolean;
 };
 type NativeTransaction = {
   id: number;
-  new (context: NativeDatabase, options?: TransactionOptions): NativeTransaction;
+  new (context: NativeDatabase, options?: NativeTransactionOptions): NativeTransaction;
   abort(): void;
   commit(resolve: () => void, reject: (err: Error) => void): void;
   commitSync(): void;
@@ -480,6 +469,7 @@ type NativeDatabase = {
   clear(resolve: ResolveCallback<void>, reject: RejectCallback): void;
   clearSync(): void;
   close(): void;
+  columns: string[];
   destroy(): void;
   drop(resolve: ResolveCallback<void>, reject: RejectCallback): void;
   dropSync(): void;
@@ -488,8 +478,8 @@ type NativeDatabase = {
   notify(event: string | BufferWithDataView, args?: any[]): boolean;
   get(keyLengthOrKeyBuffer: number | Buffer, resolve: ResolveCallback<Buffer>, reject: RejectCallback, txnId?: number): number;
   getCount(options?: RangeOptions, txnId?: number): number;
-  getDBIntProperty(propertyName: string): number;
-  getDBProperty(propertyName: string): string;
+  getDBIntProperty(propertyName: string): number | undefined;
+  getDBProperty(propertyName: string): string | undefined;
   getMonotonicTimestamp(): number;
   getOldestSnapshotTimestamp(): number;
   getStat(statName: string): number | StatsHistogramData;
@@ -566,7 +556,7 @@ declare class Transaction extends DBI {
   * @param store - The base store interface for this transaction.
   * @param options - The options for the transaction.
   */
-  constructor(store: Store, options?: TransactionOptions);
+  constructor(store: Store, options?: NativeTransactionOptions);
   /**
   * Abort the transaction.
   */
@@ -922,6 +912,20 @@ interface RocksDatabaseOptions extends StoreOptions {
   */
   name?: string;
 }
+interface TransactionOptions extends NativeTransactionOptions {
+  /**
+  * The maximum number of times to retry the transaction.
+  *
+  * @default 3
+  */
+  maxRetries?: number;
+  /**
+  * Whether to retry the transaction if it fails with `IsBusy`.
+  *
+  * @default `true` when the transaction is bound to a transaction log, otherwise `false`
+  */
+  retryOnBusy?: boolean;
+}
 type RocksDBStat = number | StatsHistogramData;
 type RocksDBStats = Record<string, RocksDBStat>;
 /**
@@ -971,6 +975,10 @@ declare class RocksDatabase extends DBI<DBITransactional> {
   */
   close(): void;
   /**
+  * Returns the list of column families in the RocksDB database.
+  */
+  get columns(): string[];
+  /**
   * Set global database settings.
   *
   * @param options - The options for the database.
@@ -1010,7 +1018,7 @@ declare class RocksDatabase extends DBI<DBITransactional> {
   * const numKeys = db.getDBIntProperty('rocksdb.estimate-num-keys');
   * ```
   */
-  getDBIntProperty(propertyName: string): number;
+  getDBIntProperty(propertyName: string): number | undefined;
   /**
   * Gets a RocksDB database property as a string.
   *
@@ -1024,7 +1032,7 @@ declare class RocksDatabase extends DBI<DBITransactional> {
   * const stats = db.getDBProperty('rocksdb.stats');
   * ```
   */
-  getDBProperty(propertyName: string): string;
+  getDBProperty(propertyName: string): string | undefined;
   /**
   * Returns the current timestamp as a monotonically increasing timestamp in
   * milliseconds represented as a decimal number.

package/dist/index.d.mts

@@ -16,6 +16,7 @@ interface Encoder {
   encode?: (value: any, mode?: number) => Buffer;
   Encoder?: EncoderFunction;
   freezeData?: boolean;
+  name?: string;
   needsStableBuffer?: boolean;
   randomAccessStructure?: boolean;
   readKey?: (buffer: Buffer, start: number, end: number, inSequence?: boolean) => any;
@@ -372,29 +373,17 @@ interface PutOptions {
 }
 //#endregion
 //#region src/load-binding.d.ts
-type TransactionOptions = {
+type NativeTransactionOptions = {
   /**
   * Whether to disable snapshots.
   *
   * @default false
   */
   disableSnapshot?: boolean;
-  /**
-  * The maximum number of times to retry the transaction.
-  *
-  * @default 3
-  */
-  maxRetries?: number;
-  /**
-  * Whether to retry the transaction if it fails with `IsBusy`.
-  *
-  * @default `true` when the transaction is bound to a transaction log, otherwise `false`
-  */
-  retryOnBusy?: boolean;
 };
 type NativeTransaction = {
   id: number;
-  new (context: NativeDatabase, options?: TransactionOptions): NativeTransaction;
+  new (context: NativeDatabase, options?: NativeTransactionOptions): NativeTransaction;
   abort(): void;
   commit(resolve: () => void, reject: (err: Error) => void): void;
   commitSync(): void;
@@ -480,6 +469,7 @@ type NativeDatabase = {
   clear(resolve: ResolveCallback<void>, reject: RejectCallback): void;
   clearSync(): void;
   close(): void;
+  columns: string[];
   destroy(): void;
   drop(resolve: ResolveCallback<void>, reject: RejectCallback): void;
   dropSync(): void;
@@ -488,8 +478,8 @@ type NativeDatabase = {
   notify(event: string | BufferWithDataView, args?: any[]): boolean;
   get(keyLengthOrKeyBuffer: number | Buffer, resolve: ResolveCallback<Buffer>, reject: RejectCallback, txnId?: number): number;
   getCount(options?: RangeOptions, txnId?: number): number;
-  getDBIntProperty(propertyName: string): number;
-  getDBProperty(propertyName: string): string;
+  getDBIntProperty(propertyName: string): number | undefined;
+  getDBProperty(propertyName: string): string | undefined;
   getMonotonicTimestamp(): number;
   getOldestSnapshotTimestamp(): number;
   getStat(statName: string): number | StatsHistogramData;
@@ -566,7 +556,7 @@ declare class Transaction extends DBI {
   * @param store - The base store interface for this transaction.
   * @param options - The options for the transaction.
   */
-  constructor(store: Store, options?: TransactionOptions);
+  constructor(store: Store, options?: NativeTransactionOptions);
   /**
   * Abort the transaction.
   */
@@ -922,6 +912,20 @@ interface RocksDatabaseOptions extends StoreOptions {
   */
   name?: string;
 }
+interface TransactionOptions extends NativeTransactionOptions {
+  /**
+  * The maximum number of times to retry the transaction.
+  *
+  * @default 3
+  */
+  maxRetries?: number;
+  /**
+  * Whether to retry the transaction if it fails with `IsBusy`.
+  *
+  * @default `true` when the transaction is bound to a transaction log, otherwise `false`
+  */
+  retryOnBusy?: boolean;
+}
 type RocksDBStat = number | StatsHistogramData;
 type RocksDBStats = Record<string, RocksDBStat>;
 /**
@@ -971,6 +975,10 @@ declare class RocksDatabase extends DBI<DBITransactional> {
   */
   close(): void;
   /**
+  * Returns the list of column families in the RocksDB database.
+  */
+  get columns(): string[];
+  /**
   * Set global database settings.
   *
   * @param options - The options for the database.
@@ -1010,7 +1018,7 @@ declare class RocksDatabase extends DBI<DBITransactional> {
   * const numKeys = db.getDBIntProperty('rocksdb.estimate-num-keys');
   * ```
   */
-  getDBIntProperty(propertyName: string): number;
+  getDBIntProperty(propertyName: string): number | undefined;
   /**
   * Gets a RocksDB database property as a string.
   *
@@ -1024,7 +1032,7 @@ declare class RocksDatabase extends DBI<DBITransactional> {
   * const stats = db.getDBProperty('rocksdb.stats');
   * ```
   */
-  getDBProperty(propertyName: string): string;
+  getDBProperty(propertyName: string): string | undefined;
   /**
   * Returns the current timestamp as a monotonically increasing timestamp in
   * milliseconds represented as a decimal number.

package/dist/index.mjs

@@ -1194,6 +1194,12 @@ var RocksDatabase = class RocksDatabase extends DBI {
 		this.store.close();
 	}
 	/**
+	* Returns the list of column families in the RocksDB database.
+	*/
+	get columns() {
+		return this.store.db.columns;
+	}
+	/**
 	* Set global database settings.
 	*
 	* @param options - The options for the database.
@@ -1437,14 +1443,14 @@ var RocksDatabase = class RocksDatabase extends DBI {
 					return buffer && store.decoder?.decode ? store.decoder.decode(buffer) : void 0;
 				};
 				opts.saveStructures = (structures, isCompatible) => {
-					return this.transactionSync((txn) => {
+					return this.transactionSync((txn, _attempt) => {
 						const existingStructuresBuffer = this.getBinarySync(sharedStructuresKey);
 						const existingStructures = existingStructuresBuffer && store.decoder?.decode ? store.decoder.decode(existingStructuresBuffer) : void 0;
 						if (typeof isCompatible == "function") {
 							if (!isCompatible(existingStructures)) return false;
 						} else if (existingStructures && existingStructures.length !== isCompatible) return false;
 						txn.putSync(sharedStructuresKey, structures);
-					});
+					}, { retryOnBusy: true });
 				};
 			}
 			store.encoder = new EncoderClass({
@@ -1461,16 +1467,15 @@ var RocksDatabase = class RocksDatabase extends DBI {
 			};
 			store.decoder = store.encoder;
 		}
-		if (typeof store.encoder?.writeKey === "function" && !store.encoder?.encode) {
-			store.encoder = {
-				...store.encoder,
-				encode: (value, _mode) => {
-					const bytesWritten = store.writeKey(value, store.encodeBuffer, 0);
-					return store.encodeBuffer.subarray(0, bytesWritten);
-				}
-			};
-			store.encoder.copyBuffers = true;
-		}
+		if (typeof store.encoder?.writeKey === "function" && !store.encoder?.encode) store.encoder = {
+			...store.encoder,
+			encode: (value, _mode) => {
+				const bytesWritten = store.writeKey(value, store.encodeBuffer, 0);
+				return store.encodeBuffer.subarray(0, bytesWritten);
+			},
+			copyBuffers: true
+		};
+		if (store.encoder) store.encoder.name = this.#name;
 		if (store.decoder && store.decoder.needsStableBuffer !== true) store.decoderCopies = true;
 		if (store.decoder?.readKey && !store.decoder.decode) {
 			store.decoder.decode = (buffer) => {
@@ -1906,7 +1911,7 @@ function loadLastPosition(transactionLog, readUncommitted) {
 //#region src/index.ts
 const versions = {
 	rocksdb: version,
-	"rocksdb-js": "1.1.0"
+	"rocksdb-js": "1.1.1"
 };
 
 //#endregion