appwrite-utils-cli/dist/backups/operations/bucketBackup.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 { Storage } from "node-appwrite";
export interface BucketBackupOptions {
    compressionLevel?: number;
    parallelDownloads?: number;
    onProgress?: (current: number, total: number, fileName: string) => void;
}
export interface BucketBackupResult {
    backupFileId: string;
    manifestFileId: string;
    fileCount: number;
    totalSizeBytes: number;
    zipSizeBytes: number;
    status: 'completed' | 'partial' | 'failed';
    errors?: string[];
}
/**
 * Downloads all files from a bucket in parallel and creates a ZIP backup
 */
export declare function backupBucket(storage: Storage, bucketId: string, backupBucketId: string, options?: BucketBackupOptions): Promise<BucketBackupResult>;