Class BackupManager

Backup manager for file-level backups.

Creates backups before a transformation and restores them for rollback.

Index

Constructors

Methods

backup clearAllBackups createBackupBatch deleteBackup deleteBackupBatch findLatestBackup getAllBackups getBackupDir getBackupMetadata getLatestGroupBackups hasBackup restore restoreBackupBatch

Constructors

constructor

new BackupManager(backupDir?: string): BackupManager
Parameters
- OptionalbackupDir: string
Returns BackupManager

Methods

backup

backup(
    filePath: string,
    reason?: string,
    options?: BackupOptions,
): Promise<BackupResult>
Create a backup of a file.
Parameters
- filePath: string
  Path to file to backup
- Optionalreason: string
  Optional reason for backup
- options: BackupOptions = {}
Returns Promise<BackupResult>
Backup result with unique backup ID

clearAllBackups

clearAllBackups(): Promise<void>
Clear all backups.

Returns Promise<void>

createBackupBatch

createBackupBatch(
filePaths: string[],
reason?: string,
): Promise<BatchBackupResult>
Create backups of multiple files with a shared backup ID.
Parameters
- filePaths: string[]
  Array of file paths to backup
- Optionalreason: string
  Reason for backup
Returns Promise<BatchBackupResult>
Batch backup result

deleteBackup

deleteBackup(filePath: string): Promise<boolean>
Delete a backup (deletes most recent backup for a file).
Parameters
- filePath: string
Returns Promise<boolean>

deleteBackupBatch

deleteBackupBatch(backupId: string): Promise<boolean>
Delete a backup batch using backup ID.
Parameters
- backupId: string
  Backup ID to delete
Returns Promise<boolean>
Whether deletion was successful

findLatestBackup

findLatestBackup(filePath: string): BackupMetadata | undefined
Most recent backup of a file: from this instance, else from the metadata files in the backup directory (backups written by another instance).
Parameters
- filePath: string
Returns BackupMetadata | undefined

getAllBackups

getAllBackups(): BackupMetadata[]
Get all backup metadata.

Returns BackupMetadata[]

getBackupDir

getBackupDir(): string
Get backup directory path.

Returns string

getBackupMetadata

getBackupMetadata(filePath: string): BackupMetadata | undefined
Get backup metadata for a file (returns most recent backup).
Parameters
- filePath: string
Returns BackupMetadata | undefined

getLatestGroupBackups

getLatestGroupBackups(): BackupMetadata[]
Backups of the newest operation group in the backup directory, one per file (the newest). A backup without group forms a group of its own.

Returns BackupMetadata[]

hasBackup

hasBackup(filePath: string): boolean
Check if a backup exists for a file.
Parameters
- filePath: string
Returns boolean

restore

restore(filePath: string): Promise<RestoreResult>
Restore a file from backup (uses most recent backup).
Parameters
- filePath: string
Returns Promise<RestoreResult>

restoreBackupBatch

restoreBackupBatch(backupId: string): Promise<BatchRestoreResult>
Restore files from a backup batch using backup ID.
Parameters
- backupId: string
  Backup ID to restore
Returns Promise<BatchRestoreResult>
Batch restore result