Class BackupService

constructor

• new BackupService(logger: LoggerInterface): BackupService

  Parameters

  • logger: LoggerInterface

  Returns BackupService

ReadonlyisCreatingBackup

ReadonlyisRestoringBackup

ReadonlyshutdownTimeoutInMs

30 seconds
Copy

createBackup

• createBackup(data?: BackupCreateData): Promise<void>

  Starts a new backup based on the given configuration.

  Parameters

  • Optionaldata: BackupCreateData

  Returns Promise<void>

delete

• delete(backup: BackupEntity): Promise<void>

  Deletes the given backup.

  Parameters

  • backup: BackupEntity

  Returns Promise<void>

onAppInit

• onAppInit(app: ZibriApplication): Promise<void>

  Runs when the app initializes.

  Parameters

  • app: ZibriApplication

  Returns Promise<void>

onAppShutdown

• onAppShutdown(): Promise<void>

  Runs when the app shuts down.

  Returns Promise<void>

resolveBackupResource

• resolveBackupResource(
      resource: BackupResourceEntity,
  ): Newable<BackupResourceInterface> | undefined

  Resolves a backup resource based on the given entity.

  Parameters

  • resource: BackupResourceEntity

  Returns Newable<BackupResourceInterface> | undefined

resolveData

• resolveData(
      transports: BackupTransportInterface[],
      resource: BackupResourceEntity,
      backup: BackupEntity,
  ): Promise<Readable>

  Resolves the actual backed up data for the given resource and transports.

  Parameters

  • transports: BackupTransportInterface[]
  • resource: BackupResourceEntity
  • backup: BackupEntity

  Returns Promise<Readable>

resolveTransports

• resolveTransports(
      resource: BackupResourceEntity,
  ): BackupTransportInterface[] | undefined

  Resolve the transports for the given backup resource.

  Parameters

  • resource: BackupResourceEntity

  Returns BackupTransportInterface[] | undefined

restore

• restore(backup: BackupEntity): Promise<void>

  Restores the given backup.

  Parameters

  • backup: BackupEntity

  Returns Promise<void>

syncBackupEntities

• syncBackupEntities(): Promise<void>

  Synchronizes backup entities with the data from all transports.

  Returns Promise<void>