WireDatabaseBackup::restore() method

Restore/import a MySQL database dump file

This method is designed to restore dump files created by the backup() method of this class, however it may also work with dump files created from other sources like mysqldump or PhpMyAdmin.

Usage

// basic usage
$true = $backup->restore(string $filename);

// usage with all arguments
$true = $backup->restore(string $filename, array $options = []);

Arguments

NameType(s)Description
filenamestring

Filename to restore, optionally including path (if no path, then path set to construct is assumed)

options (optional)array

Options to modify default behavior:

  • tables (array): table names to restore (empty=all)
  • allowDrop (bool): allow DROP TABLE statements (default=true)
  • dropAll (bool): DROP ALL tables before restore? The allowDrop optional must also be true. (default=false)
  • haltOnError (bool): halt execution when an error occurs? (default=false)
  • maxSeconds (int): max number of seconds allowed for execution (default=1200)
  • findReplace (array): find and replace in row data. Example: ['databass' => 'database']
  • findReplaceCreateTable (array): find and replace in create table statements.
    Example: ['DEFAULT CHARSET=utf8;' => 'DEFAULT CHARSET=utf8mb4;']

Return value

true

on success, false on failure. Call the errors() method to retrieve errors.

Exceptions

Method can throw exceptions on error:

  • \Exception - on fatal error

See Also


$backup methods and properties

API reference based on ProcessWire core version 3.0.168

Twitter updates

  • There’s a new modules directory on the ProcessWire site now up and running. In this post we’ll cover a few details about what’s changed and what’s new—More
    20 November 2020
  • ProcessWire 3.0.168 core updates — More
    26 October 2020
  • This week a 2nd new module for processing Stripe payments has been added to FormBuilder. Unlike our other Stripe Inputfield, this new one supports 3D Secure (SCA) payments. We’ll take a closer look at it in this post, plus a live demo— More
    16 October 2020

Newest forum posts

Latest news

  • ProcessWire Weekly #341
    In the 341st issue of ProcessWire Weekly we're going to check out the latest processwire.com blog post, introduce upcoming commercial module called NiftyPasswordsPlus, and check out a brand new site of the week. Read on!
    Weekly.pw / 21 November 2020
  • New ProcessWire modules directory
    There’s a new modules directory on the ProcessWire site now up and running. In this post we’ll cover a few details about what’s changed and what’s new.
    Blog / 20 November 2020
  • Subscribe to weekly ProcessWire news

“Indeed, if ProcessWire can be considered as a CMS in its own right, it also offers all the advantages of a CMF (Content Management Framework). Unlike other solutions, the programmer is not forced to follow the proposed model and can integrate his/her ways of doing things.” —Guy Verville, Spiria Digital Inc.