Class: SaveBackupToPathCommand
Defined in: electron/services/commands/DatabaseCommands.ts:432
Command for saving a SQLite database backup directly to disk.
Remarks
This command exists to support backup workflows that should not load the
entire backup into memory (e.g. large databases). The command delegates to
DataBackupService#saveDatabaseBackupToPath.
Hierarchy
Extends
Constructors
Constructor
new SaveBackupToPathCommand(context: DatabaseCommandContext & {
targetPath: string;
}): SaveBackupToPathCommand;
Defined in: electron/services/commands/DatabaseCommands.ts:449
Parameters
context
DatabaseCommandContext & {
targetPath: string;
}
Returns
SaveBackupToPathCommand
Overrides
Properties
cache
protected readonly cache: StandardizedCache<Site>;
Defined in: electron/services/commands/DatabaseCommands.ts:140
Site cache for data synchronization during operations
Inherited from
eventEmitter
protected readonly eventEmitter: TypedEventBus<UptimeEvents>;
Defined in: electron/services/commands/DatabaseCommands.ts:143
Event bus for emitting command execution events
Inherited from
serviceFactory
protected readonly serviceFactory: DatabaseCommandServiceFactory;
Defined in: electron/services/commands/DatabaseCommands.ts:146
Factory for accessing database services and repositories
Inherited from
DatabaseCommand.serviceFactory
configurationManager
protected readonly configurationManager:
| ConfigurationManager
| undefined;
Defined in: electron/services/commands/DatabaseCommands.ts:149
Optional configuration manager used for validation flows
Inherited from
DatabaseCommand.configurationManager
updateHistoryLimit
protected readonly updateHistoryLimit:
| ((limit: number) => Promise<void>)
| undefined;
Defined in: electron/services/commands/DatabaseCommands.ts:152
Optional history limit updater for settings propagation
Inherited from
DatabaseCommand.updateHistoryLimit
targetPath
private readonly targetPath: string;
Defined in: electron/services/commands/DatabaseCommands.ts:433
Methods
emitSuccessEvent()
protected emitSuccessEvent<K>(eventType: K, data: Partial<EventPayload<UptimeEvents, K>>): Promise<void>;
Defined in: electron/services/commands/DatabaseCommands.ts:167
Internal
Emits a success event for the command operation.
Type Parameters
K
K extends EventKey<UptimeEvents>
Parameters
eventType
K
The event type to emit.
data
Partial<EventPayload<UptimeEvents, K>>
Additional event data to include in the event payload.
Returns
Promise<void>
Remarks
Used internally to emit a typed event indicating command success, including additional event data.
Inherited from
DatabaseCommand.emitSuccessEvent
rollback()
rollback(): Promise<void>;
Defined in: electron/services/commands/DatabaseCommands.ts:435
Rolls back the command operation if possible.
Returns
Promise<void>
Promise resolving when rollback is complete.
Remarks
Attempts to revert the effects of the command. Not all commands require rollback.
Overrides
validate()
validate(): Promise<{
errors: string[];
isValid: boolean;
}>;
Defined in: electron/services/commands/DatabaseCommands.ts:440
Validates the command before execution.
Returns
Promise<{
errors: string[];
isValid: boolean;
}>
Promise resolving to validation result.
Remarks
Ensures the command is in a valid state before execution. Returns a validation result with errors if any.
Overrides
execute()
execute(): Promise<DatabaseBackupMetadata>;
Defined in: electron/services/commands/DatabaseCommands.ts:444
Executes the command operation.
Returns
Promise<DatabaseBackupMetadata>
Promise resolving to the operation result.
Remarks
Performs the main database operation encapsulated by the command.
Throws
When command execution fails.
Overrides
getDescription()
getDescription(): string;
Defined in: electron/services/commands/DatabaseCommands.ts:456
Gets a description of the command for logging and debugging.
Returns
string
Human-readable command description.