--apply-log and --decompress aren't marked as mutually exclusive in the documentation

Bug #1376874 reported by Fernando Ipar on 2014-10-02
This bug affects 4 people
Affects Status Importance Assigned to Milestone
Percona XtraBackup moved to https://jira.percona.com/projects/PXB
Fix Released
Sergei Glushchenko
Won't Fix
Fix Released
Sergei Glushchenko

Bug Description

The innobackupex option reference (http://www.percona.com/doc/percona-xtrabackup/2.2/innobackupex/innobackupex_option_reference.html) does not list --apply-log and --decompress as mutually exclusive.

However, if they're both specified, only --decompress seems to work.

While the how to guide lists the steps in the right order (decompress, apply log, as seen http://www.percona.com/doc/percona-xtrabackup/2.2/howtos/recipes_ibkx_compressed.html), the fact that these are not marked as incompatible in the option reference, and that the script prints 'Completed OK!' can lead people to believe the two can work at the same time, which can lead to a mysql instance being started with an unprepared backup.

Related branches

Fernando Ipar (fipar) on 2014-10-02
tags: added: i45575
Fernando Ipar (fipar) wrote :

Furthermore, innobackupex returns 0 if both options are supplied but the backup is not prepared, which can be very bad if this invocation is wrapped in some other script:

root@ps56 ~]# innobackupex --decompress --apply-log /backups/2014-10-02_13-17-55/ && echo ok || echo error

InnoDB Backup Utility v1.5.1-xtrabackup; Copyright 2003, 2009 Innobase Oy
and Percona LLC and/or its affiliates 2009-2013. All Rights Reserved.

This software is published under
the GNU GENERAL PUBLIC LICENSE Version 2, June 1991.

Get the latest version of Percona XtraBackup, documentation, and help resources:

IMPORTANT: Please check that the decryption and decompression run completes successfully.
           At the end of a successful decryption and decompression run innobackupex
           prints "completed OK!".

innobackupex: qpress -do /backups/2014-10-02_13-17-55/ibdata1.qp > /backups/2014-10-02_13-17-55/ibdata1
innobackupex: qpress -do /backups/2014-10-02_13-17-55/ahi_scan_test_case/to_read.ibd.qp > /backups/2014-10-02_13-17-55/ahi_scan_test_case/to_read.ibd
innobackupex: qpress -do /backups/2014-10-02_13-17-55/ahi_scan_test_case/to_drop.ibd.qp > /backups/2014-10-02_13-17-55/ahi_scan_test_case/to_drop.ibd
innobackupex: qpress -do /backups/2014-10-02_13-17-55/test/test.ibd.qp > /backups/2014-10-02_13-17-55/test/test.ibd
innobackupex: qpress -do /backups/2014-10-02_13-17-55/mysql/slave_relay_log_info.ibd.qp > /backups/2014-10-02_13-17-55/mysql/slave_relay_log_info.ibd
innobackupex: qpress -do /backups/2014-10-02_13-17-55/mysql/slave_worker_info.ibd.qp > /backups/2014-10-02_13-17-55/mysql/slave_worker_info.ibd
innobackupex: qpress -do /backups/2014-10-02_13-17-55/mysql/innodb_index_stats.ibd.qp > /backups/2014-10-02_13-17-55/mysql/innodb_index_stats.ibd
innobackupex: qpress -do /backups/2014-10-02_13-17-55/mysql/innodb_table_stats.ibd.qp > /backups/2014-10-02_13-17-55/mysql/innodb_table_stats.ibd
innobackupex: qpress -do /backups/2014-10-02_13-17-55/mysql/slave_master_info.ibd.qp > /backups/2014-10-02_13-17-55/mysql/slave_master_info.ibd
141002 13:18:13 innobackupex: completed OK!

tags: added: low-hanging-fruit

In fact we have following mutually exclusive categories of options:

  1. --decompress, --decrypt
  2. --copy_back
  3. --move_back
  4. --apply_log

I think it will be better to restrict mix any mix of these options.

Percona now uses JIRA for bug reports so this bug report is migrated to: https://jira.percona.com/browse/PXB-708

To post a comment you must log in.
This report contains Public information  Edit
Everyone can see this information.

Other bug subscribers