WireDatabaseBackup class

ProcessWire Database Backup and Restore

// Get an instance of WireDatabaseBackup $backup = $database->backups();

This class intentionally does not have any external dependencies (other than PDO)so that it can be included by outside tools for restoring/exporting, with the main example of that being the ProcessWire installer.

The recommended way to access these backup methods is via the $database API variable method $database->backups(), which returns a WireDatabaseBackup instance, however you can also initialize the class manually if you prefer, like this:

// determine where backups will go (should NOT be web accessible) $backupPath = $config->paths->assets . 'backups/';  // create a new WireDatabaseBackup instance $backup = new WireDatabaseBackup($backupPath);  // Option 1: set the already-connected DB connection $backup->setDatabase($this->database);  // Option 2: OR provide a Config object that contains the DB connection info $backup->setDatabaseConfig($this->config);

Backup the database

$file = $backup->backup(); if($file) {   echo "Backed up to: $file"; } else {   echo "Backup failed: " . implode("<br>", $backup->errors()); }

Restore a database

$success = $backup->restore($file); if($success) {   echo "Restored database from file: $file"; } else {   echo "Restore failed: " . implode("<br>", $backup->errors()); }

Click any linked item for full usage details and examples. Hookable methods are indicated with the icon.

Initialization

It’s not typically necessary to call these initialization methods unless doing manual initialization.

Advanced

NameReturnSummary 
$backup->getDatabase()
PDO

Get current database connection, initiating the connection if not yet active

 
$backup->restoreMerge(string $filename1, string $filename2, array $options)
bool

Restore from 2 SQL files while resolving table differences (think of it as array_merge for a DB restore)

 

Common

NameReturnSummary 
$backup->dropAllTables()
int

Drop all tables from database

 

API reference based on ProcessWire core version 3.0.255