Manual:DumpBackup.php

Details
dumpBackup.php file creates an XML dump for export or backup. XML dumps contain the content of the wiki (wiki pages with all their revisions), without the site-related data. DumpBackup.php does not create a full backup of the wiki database, the dump does not contain user accounts, images, edit logs, deleted revisions, etc. Once the dump is completed, you can dumps>Special:MyLanguage/Manual:Importing XML dumps|import the XML dump.

Examples
You must choose a name for the data dump.

For example the user here is saving all of the revision history ( --full) into a file named  :


 * For more details on this dump.xml example, see example>#Detailed example|Detailed example below.

You can restrict the data dump to one man-ns>Special:MyLanguage/Manual:Namespace|namespace. In this example there are only templates:

To include multiple namespaces:

Example usage of a plugin:

 php dumpBackup.php \ --plugin=AbstractFilter:extensions/ActiveAbstract/AbstractFilter.php \ --current \ --output=gzip:/dumps/abstract.xml.gz \ --filter=namespace:NS_MAIN \ --filter=noredirect \ --filter=abstract

or

 php dumpBackup.php \ --plugin=MathMLFilter:../extensions/MathSearch/maintenance/MathMLFilter.php \ --current \ --filter=namespace:NS_MAIN \ --filter=mathml

The   option can be used with .

To  :

 php dumpBackup.php \ --full \ --include-files \ --uploads \ --output=gzip:/dumps/abstract.xml.gz

The   option needs to be used also. Otherwise no files will be included.

Detailed example
In this example Green text is text you type in.


 * 1) Redirect to the maintenance folder using the cd command.  The location of your maintenance folder will vary from this example.


 * 1) Type in <tvar|dumpxml> php dumpBackup.php --full > dump.xml </> and press enter.  A long list of code is created, similar to the example below.

The new xml file will be created in the maintenance folder (you may need to refresh your SCP to see the xml file).

Options
From MediaWiki :

<pre style="overflow:auto;"> This script dumps the wiki page or logging database into an XML interchange wrapper format for export or backup.

XML output is sent to stdout; progress reports are sent to stderr.

Usage: php dumpBackup.php [ ] Actions: --full     Dump all revisions of every page. --current  Dump only the latest revision of every page. --logs     Dump all log events. --stable   Stable versions of pages? --pagelist= Where is a list of page titles to be dumped --revrange Dump specified range of revisions, requires revstart and revend options. Options: --quiet    Don't dump status reports to stderr. --report=n Report position and speed after every n pages processed. (Default: 100) --server=h Force reading from MySQL server h  --start=n   Start from page_id or log_id n  --end=n     Stop before page_id or log_id n (exclusive) --revstart=n Start from rev_id n  --revend=n    Stop before rev_id n (exclusive) --skip-header Don't output the header --skip-footer Don't output the footer --stub     Don't perform old_text lookups; for 2-pass dump --uploads  Include upload records without files --include-files Include files within the XML stream --conf= Use the specified configuration file (LocalSettings.php)

--wiki= Only back up the specified

Fancy stuff: (Works? Add examples please.) --plugin= [: ]  Load a dump plugin class --output= :     Begin a filtered output stream; s: file, gzip, bzip2, 7zip --filter= [: ] Add a filter on an output branch --7ziplevel=<0-10>         Level of 7zip compression (0 - no compression is default)

This script connects to the database using the username and password defined by <tvar|dbadminuser></> and <tvar|dbadminpassword></>, which are normally set in <tvar|localsettings></>. Although <tvar|adminsettings></> is obsolete, it can use the username and password set in that file too. Usually $wgDBadminuser is a user with more privileges than the one in <tvar|dbuser></>, but for running <tvar|php1> </> no extra privileges are required, so the usernames and passwords may be the same. If the variables are not set, <tvar|php2> </> will fail when trying to connect to the database:

<pre style="overflow:auto;"> $ php dumpBackup.php --full DB connection error: Unknown error

Error messages
If you are not in the correct folder, you will receive this message:

<pre style="overflow:auto;"> No input file specified.

The dumpBackup script says " " when the parameter after "--report" evaluates as 0 or not-a-number. The fix is to run dumpBackup without the "--report" option; then dumpBackup will print a status line every 100 pages processed.

Recommended configuration settings

 * <tvar|1></> should be set to 0, to avoid inserting all revisions into the object cache. Most of them won't benefit from being stored in the cache because your readers normally won't view random old revisions of pages on your wiki.