@harperfast/rocksdb-js 2.7.0 → 2.7.1

package/dist/index.d.cts

@@ -293,6 +293,23 @@ type CompressionInfo = {
   algorithm: CompressionAlgorithm;
   level?: number;
 };
+/**
+ * The informational-log settings currently in effect for a database, as
+ * returned by the `logOptions` getter. These are database-wide (`DBOptions`)
+ * settings, not per-column-family.
+ */
+type LogOptions = {
+  /**
+   * Per-file size cap (bytes) for informational log files (`LOG` /
+   * `LOG.old.*`).
+   */
+  maxLogFileSize: number;
+  /**
+   * Verbosity of informational logging: `0` (debug), `1` (info), `2` (warn),
+   * `3` (error), `4` (fatal), or `5` (header-only).
+   */
+  infoLogLevel: number;
+};
 /**
  * Options for the `Store` class.
  */
@@ -439,6 +456,11 @@ declare class Store {
    * Encoder specific option used to signal that the data should be frozen.
    */
   freezeData: boolean;
+  /**
+   * Verbosity of RocksDB's informational logging (`info_log_level`). Omit to
+   * leave RocksDB's own default.
+   */
+  infoLogLevel?: number;
   /**
    * Reusable buffer for encoding keys.
    */
@@ -451,6 +473,16 @@ declare class Store {
    * The maximum key size.
    */
   maxKeySize: number;
+  /**
+   * Per-file size cap (bytes) for informational log files (`LOG` /
+   * `LOG.old.*`). Bounds total informational-log footprint to roughly `5 *
+   * maxLogFileSize` (RocksDB retains up to 5 of these files). A value of `0`
+   * is RocksDB's "single unbounded log file" mode: it disables size-based
+   * rotation, so the log can grow without limit — set it only if you want that.
+   *
+   * @default 16777216 (16MB)
+   */
+  maxLogFileSize?: number;
   /**
    * The maximum number of table files RocksDB keeps open. `0` (the default)
    * derives a budget from the effective per-process open-file limit (an
@@ -470,13 +502,26 @@ declare class Store {
   /**
    * The bytes of recent memtable history to retain in memory for transaction
    * conflict checking. `-1` derives the value from
-   * `maxWriteBufferNumber * writeBufferSize`.
+   * `maxWriteBufferNumber * writeBufferSize`, except under a stalling
+   * `writeBufferManager`, where it derives `0`: retained history is charged to
+   * that manager and is only trimmable down to this target, so a target the
+   * budget cannot hold stalls writes permanently. Set a number to size it
+   * yourself against the budget and the column-family count.
    */
   maxWriteBufferSizeToMaintain?: number;
   /**
    * The total memtable budget in bytes across all column families. When the
-   * sum of memtables reaches this size, RocksDB flushes the largest one. `0`
-   * disables the global trigger so per-CF `writeBufferSize` drives flushing.
+   * sum of memtables reaches this size, RocksDB flushes the largest one.
+   * Defaults to `0`, which disables the global trigger so per-CF
+   * `writeBufferSize` drives flushing.
+   *
+   * Set this only if you know your column-family count: it is one budget split
+   * across all of them, so a value that suits a few families starves many. To
+   * bound total memtable memory instead, configure a WriteBufferManager.
+   *
+   * Database-wide, so it binds when the path is first opened in this process:
+   * a later open of the same path — including from another worker thread —
+   * keeps the first opener's value rather than overriding or rejecting it.
    */
   dbWriteBufferSize?: number;
   /**
@@ -1811,6 +1856,22 @@ type NativeDatabaseOptions = {
   dbWriteBufferSize?: number;
   disableWAL?: boolean;
   enableStats?: boolean;
+  /**
+   * Verbosity of RocksDB's informational logging (`info_log_level`): `0`
+   * (debug), `1` (info), `2` (warn), `3` (error), `4` (fatal), or `5`
+   * (header-only). Omit to leave RocksDB's own default (`INFO_LEVEL` in a
+   * release build of the linked RocksDB library).
+   */
+  infoLogLevel?: number;
+  /**
+   * Per-file size cap (bytes) for informational log files (`LOG` /
+   * `LOG.old.*`, `max_log_file_size`). RocksDB retains up to 5 of these files
+   * (`keep_log_file_num`, not currently exposed as an option), so total
+   * informational-log footprint is bounded at roughly `5 * maxLogFileSize`.
+   *
+   * @default 16777216 (16MB)
+   */
+  maxLogFileSize?: number;
   maxOpenFiles?: number;
   maxWriteBufferNumber?: number;
   maxWriteBufferSizeToMaintain?: number;
@@ -1883,6 +1944,10 @@ type NativeDatabase = {
   getCount(options?: RangeOptions, txnId?: number): number;
   getDBIntProperty(propertyName: string): number | undefined;
   getDBProperty(propertyName: string): string | undefined;
+  getLogOptions(): {
+    maxLogFileSize: number;
+    infoLogLevel: number;
+  };
   getMonotonicTimestamp(): number;
   getOldestSnapshotTimestamp(): number;
   getStat(statName: string): number | StatsHistogramData;
@@ -2259,6 +2324,22 @@ declare class RocksDatabase extends DBI<DBITransactional> {
    * ```
    */
   get compression(): CompressionInfo;
+  /**
+   * The informational-log settings currently in effect for this database,
+   * read live from RocksDB, as `{ maxLogFileSize, infoLogLevel }`. These are
+   * database-wide settings (not per-column-family): `maxLogFileSize` bounds
+   * each retained `LOG` / `LOG.old.*` file's size (defaults to 16MB, so with
+   * RocksDB's `keep_log_file_num = 5` the total footprint is bounded at
+   * roughly 80MB); `infoLogLevel` is the logging verbosity. The database must
+   * be open.
+   *
+   * @example
+   * ```typescript
+   * const db = RocksDatabase.open('/path/to/db', { maxLogFileSize: 4 * 1024 * 1024 });
+   * db.logOptions; // { maxLogFileSize: 4194304, infoLogLevel: 1 }
+   * ```
+   */
+  get logOptions(): LogOptions;
   /**
    * Set global database settings.
    *
@@ -2647,5 +2728,5 @@ declare const versions: {
   "rocksdb-js": string;
 };
 //#endregion
-export { type BackupInfo, type BackupOptions, type BackupStreamOptions, type CompressionAlgorithm, type CompressionInfo, type CompressionOption, DBI, DBIterator, type GetStatsMethod, type IteratorOptions, type Key, type RestoreMode, type RestoreOptions, type RocksDBStat, type RocksDBStats, RocksDatabase, type RocksDatabaseOptions, type StatsAll, type StatsAllExtras, type StatsBasics, type StatsCurated, type StatsCuratedExtras, type StatsDefault, type StatsHistogramData, type StatsValue, Store, type StoreContext, type StoreGetOptions, type StoreIteratorOptions, type StorePutOptions, type StoreRangeOptions, type StoreRemoveOptions, Transaction, type TransactionEntry, TransactionLog, type TransactionLogFileValidation, type TransactionLogPosition, type TransactionLogStats, type TransactionLogStoreValidation, type ValidateTransactionLogStoreOptions, backups, constants, coolTransactionLogs, currentThreadId, fileLockRelease, parseTransactionLog, registryStatus, shutdown, stats, supportedCompression, tryFileLock, validateTransactionLogStore, versions };
+export { type BackupInfo, type BackupOptions, type BackupStreamOptions, type CompressionAlgorithm, type CompressionInfo, type CompressionOption, DBI, DBIterator, type GetStatsMethod, type IteratorOptions, type Key, type LogOptions, type RestoreMode, type RestoreOptions, type RocksDBStat, type RocksDBStats, RocksDatabase, type RocksDatabaseOptions, type StatsAll, type StatsAllExtras, type StatsBasics, type StatsCurated, type StatsCuratedExtras, type StatsDefault, type StatsHistogramData, type StatsValue, Store, type StoreContext, type StoreGetOptions, type StoreIteratorOptions, type StorePutOptions, type StoreRangeOptions, type StoreRemoveOptions, Transaction, type TransactionEntry, TransactionLog, type TransactionLogFileValidation, type TransactionLogPosition, type TransactionLogStats, type TransactionLogStoreValidation, type ValidateTransactionLogStoreOptions, backups, constants, coolTransactionLogs, currentThreadId, fileLockRelease, parseTransactionLog, registryStatus, shutdown, stats, supportedCompression, tryFileLock, validateTransactionLogStore, versions };
 //# sourceMappingURL=index.d.cts.map

package/dist/index.d.mts

@@ -293,6 +293,23 @@ type CompressionInfo = {
   algorithm: CompressionAlgorithm;
   level?: number;
 };
+/**
+ * The informational-log settings currently in effect for a database, as
+ * returned by the `logOptions` getter. These are database-wide (`DBOptions`)
+ * settings, not per-column-family.
+ */
+type LogOptions = {
+  /**
+   * Per-file size cap (bytes) for informational log files (`LOG` /
+   * `LOG.old.*`).
+   */
+  maxLogFileSize: number;
+  /**
+   * Verbosity of informational logging: `0` (debug), `1` (info), `2` (warn),
+   * `3` (error), `4` (fatal), or `5` (header-only).
+   */
+  infoLogLevel: number;
+};
 /**
  * Options for the `Store` class.
  */
@@ -439,6 +456,11 @@ declare class Store {
    * Encoder specific option used to signal that the data should be frozen.
    */
   freezeData: boolean;
+  /**
+   * Verbosity of RocksDB's informational logging (`info_log_level`). Omit to
+   * leave RocksDB's own default.
+   */
+  infoLogLevel?: number;
   /**
    * Reusable buffer for encoding keys.
    */
@@ -451,6 +473,16 @@ declare class Store {
    * The maximum key size.
    */
   maxKeySize: number;
+  /**
+   * Per-file size cap (bytes) for informational log files (`LOG` /
+   * `LOG.old.*`). Bounds total informational-log footprint to roughly `5 *
+   * maxLogFileSize` (RocksDB retains up to 5 of these files). A value of `0`
+   * is RocksDB's "single unbounded log file" mode: it disables size-based
+   * rotation, so the log can grow without limit — set it only if you want that.
+   *
+   * @default 16777216 (16MB)
+   */
+  maxLogFileSize?: number;
   /**
    * The maximum number of table files RocksDB keeps open. `0` (the default)
    * derives a budget from the effective per-process open-file limit (an
@@ -470,13 +502,26 @@ declare class Store {
   /**
    * The bytes of recent memtable history to retain in memory for transaction
    * conflict checking. `-1` derives the value from
-   * `maxWriteBufferNumber * writeBufferSize`.
+   * `maxWriteBufferNumber * writeBufferSize`, except under a stalling
+   * `writeBufferManager`, where it derives `0`: retained history is charged to
+   * that manager and is only trimmable down to this target, so a target the
+   * budget cannot hold stalls writes permanently. Set a number to size it
+   * yourself against the budget and the column-family count.
    */
   maxWriteBufferSizeToMaintain?: number;
   /**
    * The total memtable budget in bytes across all column families. When the
-   * sum of memtables reaches this size, RocksDB flushes the largest one. `0`
-   * disables the global trigger so per-CF `writeBufferSize` drives flushing.
+   * sum of memtables reaches this size, RocksDB flushes the largest one.
+   * Defaults to `0`, which disables the global trigger so per-CF
+   * `writeBufferSize` drives flushing.
+   *
+   * Set this only if you know your column-family count: it is one budget split
+   * across all of them, so a value that suits a few families starves many. To
+   * bound total memtable memory instead, configure a WriteBufferManager.
+   *
+   * Database-wide, so it binds when the path is first opened in this process:
+   * a later open of the same path — including from another worker thread —
+   * keeps the first opener's value rather than overriding or rejecting it.
    */
   dbWriteBufferSize?: number;
   /**
@@ -1811,6 +1856,22 @@ type NativeDatabaseOptions = {
   dbWriteBufferSize?: number;
   disableWAL?: boolean;
   enableStats?: boolean;
+  /**
+   * Verbosity of RocksDB's informational logging (`info_log_level`): `0`
+   * (debug), `1` (info), `2` (warn), `3` (error), `4` (fatal), or `5`
+   * (header-only). Omit to leave RocksDB's own default (`INFO_LEVEL` in a
+   * release build of the linked RocksDB library).
+   */
+  infoLogLevel?: number;
+  /**
+   * Per-file size cap (bytes) for informational log files (`LOG` /
+   * `LOG.old.*`, `max_log_file_size`). RocksDB retains up to 5 of these files
+   * (`keep_log_file_num`, not currently exposed as an option), so total
+   * informational-log footprint is bounded at roughly `5 * maxLogFileSize`.
+   *
+   * @default 16777216 (16MB)
+   */
+  maxLogFileSize?: number;
   maxOpenFiles?: number;
   maxWriteBufferNumber?: number;
   maxWriteBufferSizeToMaintain?: number;
@@ -1883,6 +1944,10 @@ type NativeDatabase = {
   getCount(options?: RangeOptions, txnId?: number): number;
   getDBIntProperty(propertyName: string): number | undefined;
   getDBProperty(propertyName: string): string | undefined;
+  getLogOptions(): {
+    maxLogFileSize: number;
+    infoLogLevel: number;
+  };
   getMonotonicTimestamp(): number;
   getOldestSnapshotTimestamp(): number;
   getStat(statName: string): number | StatsHistogramData;
@@ -2259,6 +2324,22 @@ declare class RocksDatabase extends DBI<DBITransactional> {
    * ```
    */
   get compression(): CompressionInfo;
+  /**
+   * The informational-log settings currently in effect for this database,
+   * read live from RocksDB, as `{ maxLogFileSize, infoLogLevel }`. These are
+   * database-wide settings (not per-column-family): `maxLogFileSize` bounds
+   * each retained `LOG` / `LOG.old.*` file's size (defaults to 16MB, so with
+   * RocksDB's `keep_log_file_num = 5` the total footprint is bounded at
+   * roughly 80MB); `infoLogLevel` is the logging verbosity. The database must
+   * be open.
+   *
+   * @example
+   * ```typescript
+   * const db = RocksDatabase.open('/path/to/db', { maxLogFileSize: 4 * 1024 * 1024 });
+   * db.logOptions; // { maxLogFileSize: 4194304, infoLogLevel: 1 }
+   * ```
+   */
+  get logOptions(): LogOptions;
   /**
    * Set global database settings.
    *
@@ -2647,5 +2728,5 @@ declare const versions: {
   "rocksdb-js": string;
 };
 //#endregion
-export { type BackupInfo, type BackupOptions, type BackupStreamOptions, type CompressionAlgorithm, type CompressionInfo, type CompressionOption, DBI, DBIterator, type GetStatsMethod, type IteratorOptions, type Key, type RestoreMode, type RestoreOptions, type RocksDBStat, type RocksDBStats, RocksDatabase, type RocksDatabaseOptions, type StatsAll, type StatsAllExtras, type StatsBasics, type StatsCurated, type StatsCuratedExtras, type StatsDefault, type StatsHistogramData, type StatsValue, Store, type StoreContext, type StoreGetOptions, type StoreIteratorOptions, type StorePutOptions, type StoreRangeOptions, type StoreRemoveOptions, Transaction, type TransactionEntry, TransactionLog, type TransactionLogFileValidation, type TransactionLogPosition, type TransactionLogStats, type TransactionLogStoreValidation, type ValidateTransactionLogStoreOptions, backups, constants, coolTransactionLogs, currentThreadId, fileLockRelease, parseTransactionLog, registryStatus, shutdown, stats, supportedCompression, tryFileLock, validateTransactionLogStore, versions };
+export { type BackupInfo, type BackupOptions, type BackupStreamOptions, type CompressionAlgorithm, type CompressionInfo, type CompressionOption, DBI, DBIterator, type GetStatsMethod, type IteratorOptions, type Key, type LogOptions, type RestoreMode, type RestoreOptions, type RocksDBStat, type RocksDBStats, RocksDatabase, type RocksDatabaseOptions, type StatsAll, type StatsAllExtras, type StatsBasics, type StatsCurated, type StatsCuratedExtras, type StatsDefault, type StatsHistogramData, type StatsValue, Store, type StoreContext, type StoreGetOptions, type StoreIteratorOptions, type StorePutOptions, type StoreRangeOptions, type StoreRemoveOptions, Transaction, type TransactionEntry, TransactionLog, type TransactionLogFileValidation, type TransactionLogPosition, type TransactionLogStats, type TransactionLogStoreValidation, type ValidateTransactionLogStoreOptions, backups, constants, coolTransactionLogs, currentThreadId, fileLockRelease, parseTransactionLog, registryStatus, shutdown, stats, supportedCompression, tryFileLock, validateTransactionLogStore, versions };
 //# sourceMappingURL=index.d.mts.map

package/dist/index.mjs

@@ -1311,6 +1311,11 @@ var Store = class {
 	*/
 	freezeData;
 	/**
+	* Verbosity of RocksDB's informational logging (`info_log_level`). Omit to
+	* leave RocksDB's own default.
+	*/
+	infoLogLevel;
+	/**
 	* Reusable buffer for encoding keys.
 	*/
 	keyBuffer;
@@ -1323,6 +1328,16 @@ var Store = class {
 	*/
 	maxKeySize;
 	/**
+	* Per-file size cap (bytes) for informational log files (`LOG` /
+	* `LOG.old.*`). Bounds total informational-log footprint to roughly `5 *
+	* maxLogFileSize` (RocksDB retains up to 5 of these files). A value of `0`
+	* is RocksDB's "single unbounded log file" mode: it disables size-based
+	* rotation, so the log can grow without limit — set it only if you want that.
+	*
+	* @default 16777216 (16MB)
+	*/
+	maxLogFileSize;
+	/**
 	* The maximum number of table files RocksDB keeps open. `0` (the default)
 	* derives a budget from the effective per-process open-file limit (an
 	* eighth of the limit — several databases can share one process — clamped
@@ -1341,13 +1356,26 @@ var Store = class {
 	/**
 	* The bytes of recent memtable history to retain in memory for transaction
 	* conflict checking. `-1` derives the value from
-	* `maxWriteBufferNumber * writeBufferSize`.
+	* `maxWriteBufferNumber * writeBufferSize`, except under a stalling
+	* `writeBufferManager`, where it derives `0`: retained history is charged to
+	* that manager and is only trimmable down to this target, so a target the
+	* budget cannot hold stalls writes permanently. Set a number to size it
+	* yourself against the budget and the column-family count.
 	*/
 	maxWriteBufferSizeToMaintain;
 	/**
 	* The total memtable budget in bytes across all column families. When the
-	* sum of memtables reaches this size, RocksDB flushes the largest one. `0`
-	* disables the global trigger so per-CF `writeBufferSize` drives flushing.
+	* sum of memtables reaches this size, RocksDB flushes the largest one.
+	* Defaults to `0`, which disables the global trigger so per-CF
+	* `writeBufferSize` drives flushing.
+	*
+	* Set this only if you know your column-family count: it is one budget split
+	* across all of them, so a value that suits a few families starves many. To
+	* bound total memtable memory instead, configure a WriteBufferManager.
+	*
+	* Database-wide, so it binds when the path is first opened in this process:
+	* a later open of the same path — including from another worker thread —
+	* keeps the first opener's value rather than overriding or rejecting it.
 	*/
 	dbWriteBufferSize;
 	/**
@@ -1452,9 +1480,11 @@ var Store = class {
 		this.encoder = options?.encoder ?? null;
 		this.encoding = options?.encoding ?? null;
 		this.freezeData = options?.freezeData ?? false;
+		this.infoLogLevel = options?.infoLogLevel;
 		this.keyBuffer = KEY_BUFFER;
 		this.keyEncoding = keyEncoding;
 		this.maxKeySize = options?.maxKeySize ?? MAX_KEY_SIZE;
+		this.maxLogFileSize = options?.maxLogFileSize;
 		this.maxOpenFiles = options?.maxOpenFiles;
 		this.maxWriteBufferNumber = options?.maxWriteBufferNumber;
 		this.maxWriteBufferSizeToMaintain = options?.maxWriteBufferSizeToMaintain;
@@ -1762,6 +1792,8 @@ var Store = class {
 			dbWriteBufferSize: this.dbWriteBufferSize,
 			disableWAL: this.disableWAL,
 			enableStats: this.enableStats,
+			infoLogLevel: this.infoLogLevel,
+			maxLogFileSize: this.maxLogFileSize,
 			maxOpenFiles: this.maxOpenFiles,
 			maxWriteBufferNumber: this.maxWriteBufferNumber,
 			maxWriteBufferSizeToMaintain: this.maxWriteBufferSizeToMaintain,
@@ -2206,6 +2238,24 @@ var RocksDatabase = class RocksDatabase extends DBI {
 		return this.store.db.getCompression();
 	}
 	/**
+	* The informational-log settings currently in effect for this database,
+	* read live from RocksDB, as `{ maxLogFileSize, infoLogLevel }`. These are
+	* database-wide settings (not per-column-family): `maxLogFileSize` bounds
+	* each retained `LOG` / `LOG.old.*` file's size (defaults to 16MB, so with
+	* RocksDB's `keep_log_file_num = 5` the total footprint is bounded at
+	* roughly 80MB); `infoLogLevel` is the logging verbosity. The database must
+	* be open.
+	*
+	* @example
+	* ```typescript
+	* const db = RocksDatabase.open('/path/to/db', { maxLogFileSize: 4 * 1024 * 1024 });
+	* db.logOptions; // { maxLogFileSize: 4194304, infoLogLevel: 1 }
+	* ```
+	*/
+	get logOptions() {
+		return this.store.db.getLogOptions();
+	}
+	/**
 	* Set global database settings.
 	*
 	* @param options - The options for the database.
@@ -3035,7 +3085,7 @@ function loadLastPosition(transactionLog, readUncommitted) {
 //#region src/index.ts
 const versions = {
 	rocksdb: version,
-	"rocksdb-js": "2.7.0"
+	"rocksdb-js": "2.7.1"
 };
 
 //#endregion