Skip to main content

Class: RestoreBackupCommand

Defined in: electron/services/commands/DatabaseCommands.ts:876

Command responsible for restoring a SQLite backup and refreshing derived caches.

Hierarchy​

View Summary

Extends​

Constructors​

Constructor​

new RestoreBackupCommand(
   serviceFactory: DatabaseCommandServiceFactory,
   eventEmitter: TypedEventBus<UptimeEvents>,
   cache: StandardizedCache<Site>,
   payload: DatabaseRestorePayload): RestoreBackupCommand;

Defined in: electron/services/commands/DatabaseCommands.ts:961

Parameters​

serviceFactory​

DatabaseCommandServiceFactory

eventEmitter​

TypedEventBus<UptimeEvents>

cache​

StandardizedCache<Site>

payload​

DatabaseRestorePayload

Returns​

RestoreBackupCommand

Overrides​

DatabaseCommand.constructor

Constructor​

new RestoreBackupCommand(context: DatabaseCommandContext & {
  payload: DatabaseRestorePayload;
}): RestoreBackupCommand;

Defined in: electron/services/commands/DatabaseCommands.ts:968

Parameters​

context​

DatabaseCommandContext & { payload: DatabaseRestorePayload; }

Returns​

RestoreBackupCommand

Overrides​

DatabaseCommand.constructor

Properties​

cache​

protected readonly cache: StandardizedCache<Site>;

Defined in: electron/services/commands/DatabaseCommands.ts:140

Site cache for data synchronization during operations

Inherited from​

DatabaseCommand.cache

eventEmitter​

protected readonly eventEmitter: TypedEventBus<UptimeEvents>;

Defined in: electron/services/commands/DatabaseCommands.ts:143

Event bus for emitting command execution events

Inherited from​

DatabaseCommand.eventEmitter

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

previousBackup​

private previousBackup:
  | DatabaseBackupResult
  | undefined;

Defined in: electron/services/commands/DatabaseCommands.ts:877

payload​

private readonly payload: DatabaseRestorePayload;

Defined in: electron/services/commands/DatabaseCommands.ts:879

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

execute()​

execute(): Promise<DatabaseRestoreSummary>;

Defined in: electron/services/commands/DatabaseCommands.ts:881

Executes the command operation.

Returns​

Promise<DatabaseRestoreSummary>

Promise resolving to the operation result.

Remarks​

Performs the main database operation encapsulated by the command.

Throws​

When command execution fails.

Overrides​

DatabaseCommand.execute

rollback()​

rollback(): Promise<void>;

Defined in: electron/services/commands/DatabaseCommands.ts:936

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​

DatabaseCommand.rollback

validate()​

validate(): Promise<{
  errors: string[];
  isValid: boolean;
}>;

Defined in: electron/services/commands/DatabaseCommands.ts:945

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​

DatabaseCommand.validate

getDescription()​

getDescription(): string;

Defined in: electron/services/commands/DatabaseCommands.ts:1002

Gets a description of the command for logging and debugging.

Returns​

string

Human-readable command description.

Overrides​

DatabaseCommand.getDescription