Merge lp:~hrvojem/percona-xtrabackup/bug1264622-2.1 into lp:percona-xtrabackup/2.1

Proposed by Hrvoje Matijakovic on 2014-05-18
Status: Merged
Approved by: Alexey Kopytov on 2014-06-04
Approved revision: 747
Merged at revision: 748
Proposed branch: lp:~hrvojem/percona-xtrabackup/bug1264622-2.1
Merge into: lp:percona-xtrabackup/2.1
Diff against target: 229 lines (+31/-32)
4 files modified
doc/source/conf.py (+0/-2)
doc/source/innobackupex/innobackupex_option_reference.rst (+11/-10)
doc/source/intro.rst (+2/-2)
doc/source/xtrabackup_bin/xbk_option_reference.rst (+18/-18)
To merge this branch: bzr merge lp:~hrvojem/percona-xtrabackup/bug1264622-2.1
Reviewer Review Type Date Requested Status
Alexey Kopytov (community) 2014-05-18 Approve on 2014-06-04
Review via email: mp+219955@code.launchpad.net
To post a comment you must log in.
747. By Hrvoje Matijakovic on 2014-05-18

- Fixed bugs: DOC-88 and Bug #1264622

Alexey Kopytov (akopytov) :
review: Approve

Preview Diff

[H/L] Next/Prev Comment, [J/K] Next/Prev File, [N/P] Next/Prev Hunk
1=== modified file 'doc/source/conf.py'
2--- doc/source/conf.py 2014-05-06 09:52:54 +0000
3+++ doc/source/conf.py 2014-05-18 08:24:16 +0000
4@@ -118,8 +118,6 @@
5
6 .. |MySQL| replace:: *MySQL*
7
8-.. |Drizzle| replace:: *Drizzle*
9-
10 .. |MariaDB| replace:: *MariaDB*
11
12 .. |tar4ibd| replace:: :program:`tar4ibd`
13
14=== modified file 'doc/source/innobackupex/innobackupex_option_reference.rst'
15--- doc/source/innobackupex/innobackupex_option_reference.rst 2014-03-15 12:18:51 +0000
16+++ doc/source/innobackupex/innobackupex_option_reference.rst 2014-05-18 08:24:16 +0000
17@@ -22,11 +22,11 @@
18
19 This option instructs xtrabackup to compress backup copies of InnoDB data files. It is passed directly to the xtrabackup child process. See the :program:`xtrabackup` :doc:`documentation <../xtrabackup_bin/xtrabackup_binary>` for details.
20
21-.. option:: --compress-threads
22+.. option:: --compress-threads=#
23
24 This option specifies the number of worker threads that will be used for parallel compression. It is passed directly to the xtrabackup child process. See the :program:`xtrabackup` :doc:`documentation <../xtrabackup_bin/xtrabackup_binary>` for details.
25
26-.. option:: --compress-chunk-size
27+.. option:: --compress-chunk-size=#
28
29 This option specifies the size of the internal working buffer for each compression thread, measured in bytes. It is passed directly to the xtrabackup child process. The default value is 64K. See the :program:`xtrabackup` :doc:`documentation <../xtrabackup_bin/xtrabackup_binary>` for details.
30
31@@ -70,11 +70,11 @@
32
33 This option instructs xtrabackup to use the encryption key stored in the given ENCRYPTION_KEY_FILE when using the --encrypt option. It is passed directly to the xtrabackup child process. See the :program:`xtrabackup` :doc:`documentation <../xtrabackup_bin/xtrabackup_binary>` for more details.
34
35-.. option:: --encrypt-threads
36+.. option:: --encrypt-threads=#
37
38 This option specifies the number of worker threads that will be used for parallel encryption. It is passed directly to the xtrabackup child process. See the :program:`xtrabackup` :doc:`documentation <../xtrabackup_bin/xtrabackup_binary>` for more details.
39
40-.. option:: --encrypt-chunk-size
41+.. option:: --encrypt-chunk-size=#
42
43 This option specifies the size of the internal working buffer for each encryption thread, measured in bytes. It is passed directly to the xtrabackup child process. See the :program:`xtrabackup` :doc:`documentation <../xtrabackup_bin/xtrabackup_binary>` for more details.
44
45@@ -122,7 +122,7 @@
46
47 This option accepts a string argument that specifies the directory where the incremental backup will be combined with the full backup to make a new full backup. It is used with the :option:`--incremental` option.
48
49-.. option:: --incremental-lsn
50+.. option:: --incremental-lsn=LSN
51
52 This option accepts a string argument that specifies the log sequence number (:term:`LSN`) to use for the incremental backup. It is used with the :option:`--incremental` option. It is used instead of specifying :option:`--incremental-basedir`. For databases created by *MySQL* and *Percona Server* 5.0-series versions, specify the as two 32-bit integers in high:low format. For databases created in 5.1 and later, specify the LSN as a single 64-bit integer.
53
54@@ -146,7 +146,7 @@
55
56 This option specifies which types of queries are allowed to complete before innobackupex will issue the global lock. Default is all.
57
58-.. option:: --log-copy-interval
59+.. option:: --log-copy-interval=#
60
61 This option specifies time interval between checks done by log copying thread in milliseconds.
62
63@@ -159,6 +159,7 @@
64 Use this option to disable table lock with ``FLUSH TABLES WITH READ LOCK``. Use it only if ALL your tables are InnoDB and you **DO NOT CARE** about the binary log position of the backup. This option shouldn't be used if there are any ``DDL`` statements being executed or if any updates are happening on non-InnoDB tables (this includes the system MyISAM tables in the *mysql* database), otherwise it could lead to an inconsistent backup.
65 If you are considering to use :option:`--no-lock` because your backups are failing to acquire the lock, this could be because of incoming replication events preventing the lock from succeeding. Please try using :option:`--safe-slave-backup` to momentarily stop the replication slave thread, this may help the backup to succeed and you then don't need to resort to using this option.
66 :file:`xtrabackup_binlog_info` is not created when --no-lock option is used (because ``SHOW MASTER STATUS`` may be inconsistent), but under certain conditions :file:`xtrabackup_binlog_pos_innodb` can be used instead to get consistent binlog coordinates as described in :ref:`working_with_binlogs`.
67+
68 .. option:: --no-timestamp
69
70 This option prevents creation of a time-stamped subdirectory of the ``BACKUP-ROOT-DIR`` given on the command line. When it is specified, the backup is done in ``BACKUP-ROOT-DIR`` instead.
71@@ -199,7 +200,7 @@
72
73 Stop slave SQL thread and wait to start backup until ``Slave_open_temp_tables`` in ``SHOW STATUS`` is zero. If there are no open temporary tables, the backup will take place, otherwise the SQL thread will be started and stopped until there are no open temporary tables. The backup will fail if ``Slave_open_temp_tables`` does not become zero after :option:`--safe-slave-backup-timeout` seconds. The slave SQL thread will be restarted when the backup finishes.
74
75-.. option:: --safe-slave-backup-timeout
76+.. option:: --safe-slave-backup-timeout=SECONDS
77
78 How many seconds :option:`--safe-slave-backup`` should wait for ``Slave_open_temp_tables`` to become zero. Defaults to 300 seconds.
79
80@@ -211,11 +212,11 @@
81
82 This option is useful when backing up a replication slave server. It prints the binary log position and name of the master server. It also writes this information to the :file:`xtrabackup_slave_info` file as a ``CHANGE MASTER`` command. A new slave for this master can be set up by starting a slave server on this backup and issuing a ``CHANGE MASTER`` command with the binary log position saved in the :file:`xtrabackup_slave_info` file.
83
84-.. option:: --socket
85+.. option:: --socket=SOCKET
86
87 This option accepts a string argument that specifies the socket to use when connecting to the local database server with a UNIX domain socket. It is passed to the mysql child process without alteration. See :command:`mysql --help` for details.
88
89-.. option:: --sshopt = SSH-OPTIONS
90+.. option:: --sshopt=SSH-OPTIONS
91
92 This option accepts a string argument that specifies the command line options to pass to :command:`ssh` when the option :option:`--remost-host` is specified.
93
94@@ -235,7 +236,7 @@
95
96 This option accepts a string argument that specifies the location where a temporary file will be stored. It may be used when :option:`--stream` is specified. For these options, the transaction log will first be stored to a temporary file, before streaming or copying to a remote host. This option specifies the location where that temporary file will be stored. If the option is not specified, the default is to use the value of ``tmpdir`` read from the server configuration. innobackupex is passing the tmpdir value specified in my.cnf as the --target-dir option to the xtrabackup binary. Both [mysqld] and [xtrabackup] groups are read from my.cnf. If there is tmpdir in both, then the value being used depends on the order of those group in my.cnf.
97
98-.. option:: --use-memory
99+.. option:: --use-memory=#
100
101 This option accepts a string argument that specifies the amount of memory in bytes for :program:`xtrabackup` to use for crash recovery while preparing a backup. Multiples are supported providing the unit (e.g. 1MB, 1M, 1GB, 1G). It is used only with the option :option:`--apply-log`. It is passed directly to xtrabackup's :option:`xtrabackup --use-memory` option. See the |xtrabackup| documentation for details.
102
103
104=== modified file 'doc/source/intro.rst'
105--- doc/source/intro.rst 2013-08-30 09:55:04 +0000
106+++ doc/source/intro.rst 2014-05-18 08:24:16 +0000
107@@ -15,9 +15,9 @@
108
109 * Higher uptime due to faster restore time
110
111-|XtraBackup| makes |MySQL| hot backups for all versions of |Percona Server|, |MySQL|, |MariaDB|, and |Drizzle|. It performs streaming, compressed, and incremental |MySQL| backups.
112+|Percona XtraBackup| makes |MySQL| hot backups for all versions of |Percona Server|, |MySQL|, and |MariaDB|. It performs streaming, compressed, and incremental |MySQL| backups.
113
114-|Percona XtraBackup| works with |MySQL|, |MariaDB|, |Percona Server|, and |Drizzle| databases (support for |Drizzle| is beta). It supports completely non-blocking backups of |InnoDB|, |XtraDB|, and *HailDB* storage engines. In addition, it can back up the following storage engines by briefly pausing writes at the end of the backup: |MyISAM|, :term:`Merge <.MRG>`, and :term:`Archive <.ARM>`, including partitioned tables, triggers, and database options.
115+|Percona XtraBackup| works with |MySQL|, |MariaDB|, and |Percona Server|. It supports completely non-blocking backups of |InnoDB|, |XtraDB|, and *HailDB* storage engines. In addition, it can back up the following storage engines by briefly pausing writes at the end of the backup: |MyISAM|, :term:`Merge <.MRG>`, and :term:`Archive <.ARM>`, including partitioned tables, triggers, and database options.
116
117 Percona's enterprise-grade commercial `MySQL Support <http://www.percona.com/mysql-support/>`_ contracts include support for |Percona XtraBackup|. We recommend support for critical production deployments.
118
119
120=== modified file 'doc/source/xtrabackup_bin/xbk_option_reference.rst'
121--- doc/source/xtrabackup_bin/xbk_option_reference.rst 2013-11-15 12:42:15 +0000
122+++ doc/source/xtrabackup_bin/xbk_option_reference.rst 2014-05-18 08:24:16 +0000
123@@ -25,11 +25,11 @@
124
125 This option tells |xtrabackup| to compress all output data, including the transaction log file and meta data files, using the specified compression algorithm. The only currently supported algorithm is 'quicklz'. The resulting files have the qpress archive format, i.e. every `*.qp` file produced by xtrabackup is essentially a one-file qpress archive and can be extracted and uncompressed by the `qpress <http://www.quicklz.com/>`_ file archiver.
126
127-.. option:: --compress-chunk-size
128+.. option:: --compress-chunk-size=#
129
130 Size of working buffer(s) for compression threads in bytes. The default value is 64K.
131
132-.. option:: --compress-threads
133+.. option:: --compress-threads=#
134
135 This option specifies the number of worker threads used by |xtrabackup| for parallel data compression. This option defaults to 1. Parallel compression ('--compress-threads') can be used together with parallel file copying ('--parallel'). For example, '--parallel=4 --compress --compress-threads=2' will create 4 IO threads that will read the data and pipe it to 2 compression threads.
136
137@@ -37,19 +37,19 @@
138
139 This option is not currently implemented. To create the InnoDB log files, you must prepare the backup twice at present.
140
141-.. option:: --datadir
142+.. option:: --datadir=DIRECTORY
143
144 The source directory for the backup. This should be the same as the datadir for your MySQL server, so it should be read from :file:`my.cnf` if that exists; otherwise you must specify it on the command line.
145
146-.. option:: --defaults-extra-file=#
147+.. option:: --defaults-extra-file=[MY.CNF]
148
149 Read this file after the global files are read. Must be given as the first option on the command-line.
150
151-.. option:: --defaults-file=#
152+.. option:: --defaults-file=[MY.CNF]
153
154 Only read default options from the given file. Must be given as the first option on the command-line. Must be a real file; it cannot be a symbolic link.
155
156-.. option:: --defaults-group
157+.. option:: --defaults-group=GROUP-NAME
158
159 This option is to set the group which should be read from the configuration file. This is used by innobackupex if you use the `--defaults-group` option. It is needed for mysqld_multi deployments.
160
161@@ -57,15 +57,15 @@
162
163 Create files necessary for exporting tables. See :doc:`Restoring Individual Tables <restoring_individual_tables>`.
164
165-.. option:: --extra-lsndir=name
166+.. option:: --extra-lsndir=DIRECTORY
167
168 (for --backup): save an extra copy of the xtrabackup_checkpoints file in this directory.
169
170-.. option:: --incremental-basedir
171+.. option:: --incremental-basedir=DIRECTORY
172
173 When creating an incremental backup, this is the directory containing the full backup that is the base dataset for the incremental backups.
174
175-.. option:: --incremental-dir
176+.. option:: --incremental-dir=DIRECTORY
177
178 When preparing an incremental backup, this is the directory where the incremental backup is combined with the full backup to make a new full backup.
179
180@@ -73,11 +73,11 @@
181
182 When creating an incremental backup, force a full scan of the data pages in the instance being backuped even if the complete changed page bitmap data is available.
183
184-.. option:: --incremental-lsn=name
185-
186- When creating an incremental backup, you can specify the log sequence number (:term:`LSN`) instead of specifying :option:`--incremental-basedir`. For databases created by *MySQL* and *Percona Server* 5.0-series versions, specify the :term:`LSN` as two 32-bit integers in high:low format. For databases created in 5.1 and later, specify the :term:`LSN` as a single 64-bit integer. ##ATTENTION##: If a wrong LSN value is specified, it is impossible to diagnose this, causing the backup to be unusable. Be careful!
187-
188-.. option:: --innodb-log-arch-dir
189+.. option:: --incremental-lsn=LSN
190+
191+ When creating an incremental backup, you can specify the log sequence number (:term:`LSN`) instead of specifying :option:`--incremental-basedir`. For databases created by *MySQL* and *Percona Server* 5.0-series versions, specify the :term:`LSN` as two 32-bit integers in high:low format. For databases created in 5.1 and later, specify the :term:`LSN` as a single 64-bit integer. ##ATTENTION##: If a wrong LSN value is specified (a user error which XtraBackup is unable to detect), the backup will be unusable. Be careful!
192+
193+.. option:: --innodb-log-arch-dir=DIRECTORY
194
195 This option is used to specify the directory containing the archived logs. It can only be used with the :option:`xtrabackup --prepare` option.
196
197@@ -113,7 +113,7 @@
198 --innodb-read-io-threads
199 --innodb-write-io-threads
200
201-.. option:: --log-copy-interval
202+.. option:: --log-copy-interval=#
203
204 This option specifies time interval between checks done by log copying thread in milliseconds (default is 1 second).
205
206@@ -169,7 +169,7 @@
207
208 A file containing one table name per line, in databasename.tablename format. The backup will be limited to the specified tables. See :ref:`scripting-xtrabackup`.
209
210-.. option:: --target-dir=name
211+.. option:: --target-dir=DIRECTORY
212
213 This option specifies the destination directory for the backup. If the directory does not exist, :program:`xtrabackup` creates it. If the directory does exist and is empty, :program:`xtrabackup` will succeed. :program:`xtrabackup` will not overwrite existing files, however; it will fail with operating system error 17, ``file exists``.
214
215@@ -183,13 +183,13 @@
216
217 This option is currently not used for anything except printing out the correct tmpdir parameter when :option:`--print-param` is used.
218
219-.. option:: --to-archived-lsn
220+.. option:: --to-archived-lsn=LSN
221
222 This option is used to specify the LSN to which the logs should be applied when backups are being prepared. It can only be used with the :option:`xtrabackup --prepare` option.
223
224 .. option:: --use-memory=#
225
226- This option affects how much memory is allocated for preparing a backup with :option:`--prepare`, or analyzing statistics with :option:`--stats`. Its purpose is similar to :term:`innodb_buffer_pool_size`. It does not do the same thing as the similarly named option in Oracle's InnoDB Hot Backup tool. The default value is 100MB, and if you have enough available memory, 1GB to 2GB is a good recommended value.
227+ This option affects how much memory is allocated for preparing a backup with :option:`--prepare`, or analyzing statistics with :option:`--stats`. Its purpose is similar to :term:`innodb_buffer_pool_size`. It does not do the same thing as the similarly named option in Oracle's InnoDB Hot Backup tool. The default value is 100MB, and if you have enough available memory, 1GB to 2GB is a good recommended value. Multiples are supported providing the unit (e.g. 1MB, 1M, 1GB, 1G).
228
229 .. option:: --version
230

Subscribers

People subscribed via source and target branches