Skip navigation links
MySQL Backup Reference Manual :: 4 MySQL Backup Programs :: 4.1 mysqlbackup — Display Backup Information
5 MySQL Backup and Replication »
Section Navigation      [Toggle]

4.1. mysqlbackup — Display Backup Information

mysqlbackup displays information from backup images created by the BACKUP DATABASE statement.

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] image_file_name

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

shell> mysqlbackup /usr/local/mysql/data/test.bak
Image path:          '/usr/local/mysql/data/test.bak'
Image size:          12305 bytes
Image compression:   none
Image version:       1
Creation time:       2009-09-08 18:08:43 UTC
Server version:      5.6.0 (5.6.0-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 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 a 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 the summary information from the end of the backup image. This includes the binary log coordinates that are the backup validity point, if binary logging was enabled with the backup was performed.

  • --verbose, -v

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

  • --version, -V

    Display version information and exit.