MYSQLBACKUP(1)

NAME
mysqlbackup - Display backup information

SYNOPSIS

mysqlbackup [options] backup_image_file

DESCRIPTION

mysqlbackup displays information from backup images created by the BACKUP DATABASE statement. This program was added in MySQL 6.0.11.

mysqlbackup has these capabilities:

•   List the objects contained in the backup image or information about the objects

•   Display the metadata (SQL statements to create objects in the backup image)

•   Search the backup image for a particular object

Invoke mysqlbackup like this:

    shell> mysqlbackup [options] backup_image_file

With no options, mysqlbackup displays a short summary about the backup image:

    shell> mysqlbackup /tmp/test.bak
    Image path:          '/tmp/test.bak'
    Image size:          12305 bytes
    Image compression:   none
    Image version:       1
    Creation time:       2009-04-08 18:08:43 UTC
    Server version:      6.0.11 (6.0.11-alpha)
    Server byte order:   little-endian

mysqlbackup supports the following options. It also reads option files and supports the options for processing them described at Section 4.2.3.2.1, “Command-Line Options that Affect Option-File Handling”.

•   --help, -?

    Display a help message and exit.

•   --all

    Display everything except snapshots and data-chunks.

•   --catalog-details

    Display the details of the database objects catalog.

•   --catalog-summary

    Display summary of the database objects catalog.

•   --data-chunks

    Display the length of each data chunk contained in the backup image.

•   --data-totals

    Display the data length for each object contained in the backup image.

•   --debug[=debug_options], -# [debug_options]

    Write a debugging log. A typical debug_options string is 'd:t:o,file_name'. The default is 'd:t:o,/tmp/mysqlbackup.trace'.

•   --exact

    Display lengths using the exact number of bytes instead of multiplier units such as KB, MB, and GB.

•   --image-order

    Display catalog items and metadata in the order of the backup image.

•   --metadata-extra

    Display extra metadata for the database objects.

•   --metadata-statements

    Display SQL statements that create the database objects in the backup image.

•   --open_files_limit=count

    Specify how many file descriptors to reserve.

•   --search=name

    Search for the given object in the backup image. The name can be object to find a global object or database.object to find a per-database object. Quoting of database and/or object with ", ', or ` is allowed. The wildcard characters '%' and '_' are available and have the same effect as for the LIKE operator. Use this option with the --metadata-* options to see metadata.

•   --snapshots

    Display information about snapshots contained in the backup image.

•   --summary

    Display a summary information from end of the backup image.

•   --verbose, -v

    Verbose mode. Include more information about the backup image in program output.

•   --version, -V

    Display version information and exit.

COPYRIGHT

Copyright 2007-2008 MySQL AB, 2009 Sun Microsystems, Inc.

This documentation is free software; you can redistribute it and/or modify it only under the terms of the GNU General Public License as published by the Free Software Foundation; version 2 of the License.

This documentation is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with the program; if not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA or see http://www.gnu.org/licenses/.

SEE ALSO
For more information, please refer to the MySQL Reference Manual, which may already be installed locally and which is also available online at http://dev.mysql.com/doc/.

AUTHOR
MySQL AB (http://www.mysql.com/).