zerobucket 0.7.0 → 0.8.1

package/dist/index.d.cts

@@ -1,5 +1,5 @@
-import { S as StorageBackend, O as OperationEvent, a as ObjectStorageLike, P as PreparedRow, C as CallOptions, b as StoredRecord, c as StoredRecordMetadata, d as StreamOptions, e as StorageInfo, I as ImageListOptions, f as ImageListEntry, M as MysqlPoolLike, g as ContentValidator, V as ValidatedContent } from './client-XQ22b1l3.cjs';
-export { B as BatchDeleteResult, h as BatchGetResult, i as BatchPutResult, j as BeforeGetHook, k as BeforePutHook, l as Connection, D as DEFAULT_MAX_BYTES, G as GetOptions, m as Image, n as ImageInput, o as ImageMetadata, p as MysqlPoolConnectionLike, q as MysqlQueryable, r as ObjectStorage, s as ObjectStorageOptions, t as OptimizationResult, u as OptimizeOptions, v as PutManyOptions, w as PutOptions, Q as Queryable, x as SqliteDatabaseLike, y as StreamOptions, W as WritableLike, Z as ZeroBucket, z as ZeroBucketOptions, A as optimizeImage, E as readInput } from './client-XQ22b1l3.cjs';
+import { S as StorageBackend, O as OperationEvent, a as ObjectStorageLike, P as PreparedRow, C as CallOptions, b as StoredRecord, c as StoredRecordMetadata, d as StreamOptions, e as StorageInfo, I as ImageListOptions, f as ImageListEntry, M as MigrateToDedupOptions, g as MigrateToDedupResult, h as MysqlPoolLike, i as ContentValidator, V as ValidatedContent } from './client-l4jPIFJI.cjs';
+export { B as BatchDeleteResult, j as BatchGetResult, k as BatchPutResult, l as BeforeGetHook, m as BeforePutHook, n as Connection, D as DEFAULT_MAX_BYTES, G as GetOptions, o as Image, p as ImageInput, q as ImageMetadata, r as MysqlPoolConnectionLike, s as MysqlQueryable, t as ObjectStorage, u as ObjectStorageOptions, v as OptimizationResult, w as OptimizeOptions, x as PutManyOptions, y as PutOptions, Q as Queryable, z as SqliteDatabaseLike, A as StreamOptions, W as WritableLike, Z as ZeroBucket, E as ZeroBucketOptions, F as optimizeImage, H as readInput } from './client-l4jPIFJI.cjs';
 import { Pool } from 'pg';
 
 /**
@@ -158,18 +158,13 @@ declare class PostgresBackend implements StorageBackend {
      * dedup instance's tables, preserving every id (external references keep working) and
      * deduplicating identical content on the way. The classic table is never modified.
      *
-     * Differences from the Python version, all deliberate: rows are copied in small batches (bounded
-     * memory instead of loading the whole table); re-running is safe (already-migrated ids are
-     * skipped and reported, not an error); and classic rows already tiered to object storage are
-     * refused up front with a clear message (their bytes are not in the database to copy).
+     * Rows are copied in small batches (bounded memory instead of loading the whole table);
+     * re-running is safe (already-migrated ids are skipped and reported, not an error). Classic rows
+     * already tiered to object storage are refused up front with a clear message (their bytes are
+     * not in the database to copy) unless `skipTiered: true`, which skips and counts them instead.
      * Still all-or-nothing: one transaction.
      */
-    migrateClassicToDedup(): Promise<{
-        imagesMigrated: number;
-        distinctBlobsCreated: number;
-        duplicateReferencesFound: number;
-        alreadyMigrated: number;
-    }>;
+    migrateClassicToDedup(opts?: MigrateToDedupOptions): Promise<MigrateToDedupResult>;
     private hydrate;
     /**
      * Remove tiered objects AFTER their rows are gone. Ordering is deliberate:
@@ -295,7 +290,11 @@ interface MySQLBackendOptions {
     onOperation?: (event: OperationEvent) => void;
     /** Enables transparent reads of tiered rows and `tierToObjectStorage()`. */
     objectStorage?: ObjectStorageLike;
-    /** Not available for MySQL yet; passing `true` throws. */
+    /**
+     * Content-addressed storage: identical bytes are stored once and shared by every image that has them
+     * (reference counted). Same tables as the Python package's dedup mode. Cannot be combined with
+     * `objectStorage` (a blob may be shared by many images).
+     */
     dedup?: boolean;
 }
 declare class MySQLBackend implements StorageBackend {
@@ -308,6 +307,8 @@ declare class MySQLBackend implements StorageBackend {
     private readonly retryBaseDelayMs;
     private readonly poolTimeoutMs;
     private readonly autoMigrate;
+    private readonly dedup;
+    private readonly sql;
     constructor(opts: MySQLBackendOptions);
     ready(): Promise<void>;
     private init;
@@ -317,6 +318,8 @@ declare class MySQLBackend implements StorageBackend {
      * re-running is a no-op.
      */
     private migrate;
+    /** Dedup tables, created only if missing (same no-needless-DDL rule as the classic table). */
+    private migrateDedup;
     close(): Promise<void>;
     private emit;
     /** Wait for a pool slot, but never longer than poolTimeoutMs. */
@@ -351,6 +354,17 @@ declare class MySQLBackend implements StorageBackend {
     delete(id: string, { connection }?: CallOptions): Promise<boolean>;
     deleteMany(ids: string[], { connection }?: CallOptions): Promise<string[]>;
     exists(id: string, { connection }?: CallOptions): Promise<boolean>;
+    /** Storage statistics, or null if the tables do not exist yet (nothing is created). */
+    getInfo(): Promise<StorageInfo | null>;
+    /** Ids matching the filters: oldest first, or a random sample. Used by the CLI's verify and tier. */
+    listImages(o?: ImageListOptions): Promise<ImageListEntry[]>;
+    /**
+     * Lock the ref row, delete it, then decrement its blob (the UPDATE takes the blob row lock, so two
+     * deletes of different refs to one blob serialize instead of racing) and remove the blob once nothing
+     * references it. All in one transaction: a failure can never leave a ref without its count or the reverse.
+     */
+    private deleteDedup;
+    private deleteManyDedup;
     private hydrate;
     /**
      * Remove tiered objects AFTER their rows are gone: once the row is deleted the image is correctly
@@ -415,4 +429,4 @@ declare class PDFValidator implements ContentValidator {
     }): ValidatedContent;
 }
 
-export { AccessDeniedError, CallOptions, ContentValidationError, ContentValidator, CorruptedImageError, DEFAULT_MAX_PIXELS, DEFAULT_STREAM_CHUNK_SIZE, ImageNotFoundError, ImageTooLargeError, ImageValidationError, MySQLBackend, type MySQLBackendOptions, MysqlPoolLike, ObjectStorageLike, OperationEvent, PDFValidator, PostgresBackend, type PostgresBackendOptions, PreparedRow, SQLiteBackend, type SQLiteBackendOptions, SUPPORTED_FORMATS, StorageBackend, StorageError, StoredRecord, StoredRecordMetadata, UnsupportedFormatError, ValidatedContent, type ValidatedImage, ZeroBucketError, validateImage };
+export { AccessDeniedError, CallOptions, ContentValidationError, ContentValidator, CorruptedImageError, DEFAULT_MAX_PIXELS, DEFAULT_STREAM_CHUNK_SIZE, ImageNotFoundError, ImageTooLargeError, ImageValidationError, MigrateToDedupOptions, MigrateToDedupResult, MySQLBackend, type MySQLBackendOptions, MysqlPoolLike, ObjectStorageLike, OperationEvent, PDFValidator, PostgresBackend, type PostgresBackendOptions, PreparedRow, SQLiteBackend, type SQLiteBackendOptions, SUPPORTED_FORMATS, StorageBackend, StorageError, StoredRecord, StoredRecordMetadata, UnsupportedFormatError, ValidatedContent, type ValidatedImage, ZeroBucketError, validateImage };

package/dist/index.d.ts

@@ -1,5 +1,5 @@
-import { S as StorageBackend, O as OperationEvent, a as ObjectStorageLike, P as PreparedRow, C as CallOptions, b as StoredRecord, c as StoredRecordMetadata, d as StreamOptions, e as StorageInfo, I as ImageListOptions, f as ImageListEntry, M as MysqlPoolLike, g as ContentValidator, V as ValidatedContent } from './client-XQ22b1l3.js';
-export { B as BatchDeleteResult, h as BatchGetResult, i as BatchPutResult, j as BeforeGetHook, k as BeforePutHook, l as Connection, D as DEFAULT_MAX_BYTES, G as GetOptions, m as Image, n as ImageInput, o as ImageMetadata, p as MysqlPoolConnectionLike, q as MysqlQueryable, r as ObjectStorage, s as ObjectStorageOptions, t as OptimizationResult, u as OptimizeOptions, v as PutManyOptions, w as PutOptions, Q as Queryable, x as SqliteDatabaseLike, y as StreamOptions, W as WritableLike, Z as ZeroBucket, z as ZeroBucketOptions, A as optimizeImage, E as readInput } from './client-XQ22b1l3.js';
+import { S as StorageBackend, O as OperationEvent, a as ObjectStorageLike, P as PreparedRow, C as CallOptions, b as StoredRecord, c as StoredRecordMetadata, d as StreamOptions, e as StorageInfo, I as ImageListOptions, f as ImageListEntry, M as MigrateToDedupOptions, g as MigrateToDedupResult, h as MysqlPoolLike, i as ContentValidator, V as ValidatedContent } from './client-l4jPIFJI.js';
+export { B as BatchDeleteResult, j as BatchGetResult, k as BatchPutResult, l as BeforeGetHook, m as BeforePutHook, n as Connection, D as DEFAULT_MAX_BYTES, G as GetOptions, o as Image, p as ImageInput, q as ImageMetadata, r as MysqlPoolConnectionLike, s as MysqlQueryable, t as ObjectStorage, u as ObjectStorageOptions, v as OptimizationResult, w as OptimizeOptions, x as PutManyOptions, y as PutOptions, Q as Queryable, z as SqliteDatabaseLike, A as StreamOptions, W as WritableLike, Z as ZeroBucket, E as ZeroBucketOptions, F as optimizeImage, H as readInput } from './client-l4jPIFJI.js';
 import { Pool } from 'pg';
 
 /**
@@ -158,18 +158,13 @@ declare class PostgresBackend implements StorageBackend {
      * dedup instance's tables, preserving every id (external references keep working) and
      * deduplicating identical content on the way. The classic table is never modified.
      *
-     * Differences from the Python version, all deliberate: rows are copied in small batches (bounded
-     * memory instead of loading the whole table); re-running is safe (already-migrated ids are
-     * skipped and reported, not an error); and classic rows already tiered to object storage are
-     * refused up front with a clear message (their bytes are not in the database to copy).
+     * Rows are copied in small batches (bounded memory instead of loading the whole table);
+     * re-running is safe (already-migrated ids are skipped and reported, not an error). Classic rows
+     * already tiered to object storage are refused up front with a clear message (their bytes are
+     * not in the database to copy) unless `skipTiered: true`, which skips and counts them instead.
      * Still all-or-nothing: one transaction.
      */
-    migrateClassicToDedup(): Promise<{
-        imagesMigrated: number;
-        distinctBlobsCreated: number;
-        duplicateReferencesFound: number;
-        alreadyMigrated: number;
-    }>;
+    migrateClassicToDedup(opts?: MigrateToDedupOptions): Promise<MigrateToDedupResult>;
     private hydrate;
     /**
      * Remove tiered objects AFTER their rows are gone. Ordering is deliberate:
@@ -295,7 +290,11 @@ interface MySQLBackendOptions {
     onOperation?: (event: OperationEvent) => void;
     /** Enables transparent reads of tiered rows and `tierToObjectStorage()`. */
     objectStorage?: ObjectStorageLike;
-    /** Not available for MySQL yet; passing `true` throws. */
+    /**
+     * Content-addressed storage: identical bytes are stored once and shared by every image that has them
+     * (reference counted). Same tables as the Python package's dedup mode. Cannot be combined with
+     * `objectStorage` (a blob may be shared by many images).
+     */
     dedup?: boolean;
 }
 declare class MySQLBackend implements StorageBackend {
@@ -308,6 +307,8 @@ declare class MySQLBackend implements StorageBackend {
     private readonly retryBaseDelayMs;
     private readonly poolTimeoutMs;
     private readonly autoMigrate;
+    private readonly dedup;
+    private readonly sql;
     constructor(opts: MySQLBackendOptions);
     ready(): Promise<void>;
     private init;
@@ -317,6 +318,8 @@ declare class MySQLBackend implements StorageBackend {
      * re-running is a no-op.
      */
     private migrate;
+    /** Dedup tables, created only if missing (same no-needless-DDL rule as the classic table). */
+    private migrateDedup;
     close(): Promise<void>;
     private emit;
     /** Wait for a pool slot, but never longer than poolTimeoutMs. */
@@ -351,6 +354,17 @@ declare class MySQLBackend implements StorageBackend {
     delete(id: string, { connection }?: CallOptions): Promise<boolean>;
     deleteMany(ids: string[], { connection }?: CallOptions): Promise<string[]>;
     exists(id: string, { connection }?: CallOptions): Promise<boolean>;
+    /** Storage statistics, or null if the tables do not exist yet (nothing is created). */
+    getInfo(): Promise<StorageInfo | null>;
+    /** Ids matching the filters: oldest first, or a random sample. Used by the CLI's verify and tier. */
+    listImages(o?: ImageListOptions): Promise<ImageListEntry[]>;
+    /**
+     * Lock the ref row, delete it, then decrement its blob (the UPDATE takes the blob row lock, so two
+     * deletes of different refs to one blob serialize instead of racing) and remove the blob once nothing
+     * references it. All in one transaction: a failure can never leave a ref without its count or the reverse.
+     */
+    private deleteDedup;
+    private deleteManyDedup;
     private hydrate;
     /**
      * Remove tiered objects AFTER their rows are gone: once the row is deleted the image is correctly
@@ -415,4 +429,4 @@ declare class PDFValidator implements ContentValidator {
     }): ValidatedContent;
 }
 
-export { AccessDeniedError, CallOptions, ContentValidationError, ContentValidator, CorruptedImageError, DEFAULT_MAX_PIXELS, DEFAULT_STREAM_CHUNK_SIZE, ImageNotFoundError, ImageTooLargeError, ImageValidationError, MySQLBackend, type MySQLBackendOptions, MysqlPoolLike, ObjectStorageLike, OperationEvent, PDFValidator, PostgresBackend, type PostgresBackendOptions, PreparedRow, SQLiteBackend, type SQLiteBackendOptions, SUPPORTED_FORMATS, StorageBackend, StorageError, StoredRecord, StoredRecordMetadata, UnsupportedFormatError, ValidatedContent, type ValidatedImage, ZeroBucketError, validateImage };
+export { AccessDeniedError, CallOptions, ContentValidationError, ContentValidator, CorruptedImageError, DEFAULT_MAX_PIXELS, DEFAULT_STREAM_CHUNK_SIZE, ImageNotFoundError, ImageTooLargeError, ImageValidationError, MigrateToDedupOptions, MigrateToDedupResult, MySQLBackend, type MySQLBackendOptions, MysqlPoolLike, ObjectStorageLike, OperationEvent, PDFValidator, PostgresBackend, type PostgresBackendOptions, PreparedRow, SQLiteBackend, type SQLiteBackendOptions, SUPPORTED_FORMATS, StorageBackend, StorageError, StoredRecord, StoredRecordMetadata, UnsupportedFormatError, ValidatedContent, type ValidatedImage, ZeroBucketError, validateImage };