appwrite-utils-cli/dist/backups/operations/collectionBackup.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, Databases } from "node-appwrite";
import type { DatabaseAdapter } from "../../adapters/DatabaseAdapter.js";
import type { AppwriteConfig } from "appwrite-utils";
export interface CollectionBackupOptions {
    trackingDatabaseId: string;
    databaseId: string;
    collectionIds: string[];
    backupFormat?: 'json' | 'zip';
    onProgress?: (message: string) => void;
}
export interface CollectionBackupResult {
    backupId: string;
    manifestFileId: string;
    databaseId: string;
    collections: Array<{
        collectionId: string;
        collectionName: string;
        documentCount: number;
        status: 'completed' | 'failed';
        error?: string;
    }>;
    totalDocuments: number;
    sizeBytes: number;
    status: 'completed' | 'partial' | 'failed';
    errors: string[];
}
/**
 * Backup specific collections from a database
 */
export declare function backupCollections(config: AppwriteConfig, databases: Databases, storage: Storage, adapter: DatabaseAdapter, options: CollectionBackupOptions): Promise<CollectionBackupResult>;