KMP PHP API Reference

PlatformDatabaseBackupService
in package

Table of Contents

Constants

BACKUP_TYPE  : mixed = 'pg_dump'
JOB_TYPE  : mixed = 'platform_database_backup'
KEK_SECRET_NAME  : mixed = 'platform.backup.kek'

Properties

$dumper  : PlatformDatabaseBackupDumperInterface
$encryptor  : PlatformDatabaseBackupEncryptor
$kekName  : string
$platformConfig  : array<string|int, mixed>
$platformConnection  : Connection
$secretStore  : SecretStoreInterface
$storage  : PlatformDatabaseBackupStorageInterface

Methods

__construct()  : mixed
backupPlatformDatabase()  : PlatformDatabaseBackupResult
databaseName()  : string
databasePassword()  : SensitiveString
insertBackup()  : void
kekVersion()  : string
now()  : DateTime
prepareJob()  : void
scrubError()  : string

Constants

Properties

Methods

__construct()

public __construct(Connection $platformConnection, array<string, mixed> $platformConfig, SecretStoreInterface $secretStore, PlatformDatabaseBackupDumperInterface $dumper, PlatformDatabaseBackupEncryptor $encryptor, PlatformDatabaseBackupStorageInterface $storage[, string $kekName = self::KEK_SECRET_NAME ]) : mixed
Parameters
$platformConnection : Connection
$platformConfig : array<string, mixed>

Platform datasource configuration

$secretStore : SecretStoreInterface
$dumper : PlatformDatabaseBackupDumperInterface
$encryptor : PlatformDatabaseBackupEncryptor
$storage : PlatformDatabaseBackupStorageInterface
$kekName : string = self::KEK_SECRET_NAME

insertBackup()

private insertBackup(string $backupId, string $jobId, string $databaseName, int $retentionDays, DateTime $now) : void
Parameters
$backupId : string
$jobId : string
$databaseName : string
$retentionDays : int
$now : DateTime

prepareJob()

private prepareJob(string $jobId, string $databaseName, DateTime $now, bool $existing) : void
Parameters
$jobId : string
$databaseName : string
$now : DateTime
$existing : bool
On this page

Search results