appwrite-utils-cli/dist/storage/backupCompression.d.ts

Appwrite Utility Functions to help with database management, data conversion, data import, migrations, and much more. Meant to be used as a CLI tool, I do not recommend installing this in frontend environments.

import type { BackupCreate } from "./schemas.js";
export interface BackupCompressionOptions {
    includeFiles?: boolean;
    compressionLevel?: number;
}
/**
 * Creates a compressed ZIP backup from backup data
 *
 * Structure:
 * - metadata.json (backup metadata)
 * - database.json (database config)
 * - collections/*.json (one file per collection)
 * - documents/*.json (one file per collection's documents)
 * - files/ (optional, if includeFiles is true)
 */
export declare function createBackupZip(backupData: BackupCreate, options?: BackupCompressionOptions): Promise<Buffer>;
/**
 * Estimates compression ratio for backup data
 */
export declare function estimateCompressedSize(uncompressedSize: number, format?: string): number;