@harperfast/rocksdb-js 2.11.0 → 2.12.0

package/dist/index.d.cts

@@ -178,6 +178,14 @@ export declare const backups: {
    * Verifies a backup's file sizes, and optionally their checksums (which
    * requires reading all backed-up data).
    *
+   * Set `verifyTables: true` to also prove this build can read the backup
+   * before restoring it: every table file is opened, one at a time, and its
+   * footer (including `format_version`) and properties must be readable, and
+   * every compression algorithm it records must be supported by this build.
+   * A checksum-valid table written by a newer or differently built RocksDB
+   * otherwise passes and fails on the first read after a restore. Blob files
+   * are not checked.
+   *
    * When the backup was created with `transactionLogs: true`, the backup's
    * transaction log snapshot (`<backupDir>/transaction_logs/<backupId>/`) is
    * also validated — every log file's header and entry framing must be intact
@@ -186,6 +194,7 @@ export declare const backups: {
    */
   verify(backupDir: string, backupId: number, options?: {
     verifyWithChecksum?: boolean;
+    verifyTables?: boolean;
     verifyTransactionLogs?: boolean;
   }): Promise<void>;
 };
@@ -2016,6 +2025,7 @@ type TransactionLogStats = {
     oldestFileAgeMs: number;
     purgeableFiles: number;
     retainedUnflushedFiles: number;
+    retentionPins: number;
     lastPurgeMs: number;
   };
   totals: {

package/dist/index.d.mts

@@ -178,6 +178,14 @@ export declare const backups: {
    * Verifies a backup's file sizes, and optionally their checksums (which
    * requires reading all backed-up data).
    *
+   * Set `verifyTables: true` to also prove this build can read the backup
+   * before restoring it: every table file is opened, one at a time, and its
+   * footer (including `format_version`) and properties must be readable, and
+   * every compression algorithm it records must be supported by this build.
+   * A checksum-valid table written by a newer or differently built RocksDB
+   * otherwise passes and fails on the first read after a restore. Blob files
+   * are not checked.
+   *
    * When the backup was created with `transactionLogs: true`, the backup's
    * transaction log snapshot (`<backupDir>/transaction_logs/<backupId>/`) is
    * also validated — every log file's header and entry framing must be intact
@@ -186,6 +194,7 @@ export declare const backups: {
    */
   verify(backupDir: string, backupId: number, options?: {
     verifyWithChecksum?: boolean;
+    verifyTables?: boolean;
     verifyTransactionLogs?: boolean;
   }): Promise<void>;
 };
@@ -2016,6 +2025,7 @@ type TransactionLogStats = {
     oldestFileAgeMs: number;
     purgeableFiles: number;
     retainedUnflushedFiles: number;
+    retentionPins: number;
     lastPurgeMs: number;
   };
   totals: {

package/dist/index.mjs

@@ -525,6 +525,14 @@ const backups = {
 	* Verifies a backup's file sizes, and optionally their checksums (which
 	* requires reading all backed-up data).
 	*
+	* Set `verifyTables: true` to also prove this build can read the backup
+	* before restoring it: every table file is opened, one at a time, and its
+	* footer (including `format_version`) and properties must be readable, and
+	* every compression algorithm it records must be supported by this build.
+	* A checksum-valid table written by a newer or differently built RocksDB
+	* otherwise passes and fails on the first read after a restore. Blob files
+	* are not checked.
+	*
 	* When the backup was created with `transactionLogs: true`, the backup's
 	* transaction log snapshot (`<backupDir>/transaction_logs/<backupId>/`) is
 	* also validated — every log file's header and entry framing must be intact
@@ -532,7 +540,9 @@ const backups = {
 	* is a verification failure). Set `verifyTransactionLogs: false` to skip.
 	*/
 	async verify(backupDir, backupId, options) {
-		await new Promise((resolve, reject) => nativeBackupVerify(resolve, reject, backupDir, backupId, options?.verifyWithChecksum ?? false));
+		const verifyTables = options?.verifyTables;
+		if (verifyTables !== void 0 && typeof verifyTables !== "boolean") throw new TypeError(`verifyTables must be a boolean, received ${verifyTables === null ? "null" : typeof verifyTables}`);
+		await new Promise((resolve, reject) => nativeBackupVerify(resolve, reject, backupDir, backupId, options?.verifyWithChecksum ?? false, verifyTables === true));
 		if (options?.verifyTransactionLogs === false) return;
 		const logsDir = join(backupDir, TRANSACTION_LOGS_DIRNAME, String(backupId));
 		if (!await exists(logsDir)) return;
@@ -3950,7 +3960,7 @@ function loadLastPosition(transactionLog, readUncommitted) {
 //#region src/index.ts
 const versions = {
 	rocksdb: version,
-	"rocksdb-js": "2.11.0"
+	"rocksdb-js": "2.12.0"
 };
 
 //#endregion