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

Proposed by Hrvoje Matijakovic on 2014-06-04
Status: Merged
Approved by: Alexey Kopytov on 2014-06-04
Approved revision: 4973
Merged at revision: 4978
Proposed branch: lp:~hrvojem/percona-xtrabackup/bug1264622-2.2
Merge into: lp:percona-xtrabackup/2.2
Diff against target: 216 lines (+29/-31)
4 files modified
storage/innobase/xtrabackup/doc/source/conf.py (+0/-2)
storage/innobase/xtrabackup/doc/source/innobackupex/innobackupex_option_reference.rst (+9/-9)
storage/innobase/xtrabackup/doc/source/intro.rst (+2/-2)
storage/innobase/xtrabackup/doc/source/xtrabackup_bin/xbk_option_reference.rst (+18/-18)
To merge this branch: bzr merge lp:~hrvojem/percona-xtrabackup/bug1264622-2.2
Reviewer Review Type Date Requested Status
Alexey Kopytov (community) 2014-06-04 Approve on 2014-06-04
Review via email: mp+221991@code.launchpad.net
To post a comment you must log in.
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 'storage/innobase/xtrabackup/doc/source/conf.py'
2--- storage/innobase/xtrabackup/doc/source/conf.py 2014-05-06 17:08:06 +0000
3+++ storage/innobase/xtrabackup/doc/source/conf.py 2014-06-04 08:15:57 +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 'storage/innobase/xtrabackup/doc/source/innobackupex/innobackupex_option_reference.rst'
15--- storage/innobase/xtrabackup/doc/source/innobackupex/innobackupex_option_reference.rst 2014-03-28 11:46:09 +0000
16+++ storage/innobase/xtrabackup/doc/source/innobackupex/innobackupex_option_reference.rst 2014-06-04 08:15:57 +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@@ -134,7 +134,7 @@
46
47 This option specifies the UUID of the specific history record stored in the :ref:`PERCONA_SCHEMA.xtrabackup_history <xtrabackup_history>` to base an incremental backup on. :option:`innobackupex --incremental-history-name`,:optionL`innobackupex --incremental-basedir` and :option:`innobackupex --incremental-lsn`. If no valid lsn can be found (no success record with that uuid) xtrabackup will return with an error. It is used with the :option:`innobackupex --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@@ -158,7 +158,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@@ -211,7 +211,7 @@
64
65 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.
66
67-.. option:: --safe-slave-backup-timeout
68+.. option:: --safe-slave-backup-timeout=SECONDS
69
70 How many seconds :option:`--safe-slave-backup`` should wait for ``Slave_open_temp_tables`` to become zero. Defaults to 300 seconds.
71
72@@ -227,7 +227,7 @@
73
74 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.
75
76-.. option:: --sshopt = SSH-OPTIONS
77+.. option:: --sshopt=SSH-OPTIONS
78
79 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.
80
81@@ -247,7 +247,7 @@
82
83 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.
84
85-.. option:: --use-memory
86+.. option:: --use-memory=#
87
88 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.
89
90
91=== modified file 'storage/innobase/xtrabackup/doc/source/intro.rst'
92--- storage/innobase/xtrabackup/doc/source/intro.rst 2014-05-18 17:31:38 +0000
93+++ storage/innobase/xtrabackup/doc/source/intro.rst 2014-06-04 08:15:57 +0000
94@@ -15,9 +15,9 @@
95
96 * Higher uptime due to faster restore time
97
98-|XtraBackup| makes |MySQL| hot backups for all versions of |Percona Server|, |MySQL|, |MariaDB|, and |Drizzle|. It performs streaming, compressed, and incremental |MySQL| backups.
99+|Percona XtraBackup| makes |MySQL| hot backups for all versions of |Percona Server|, |MySQL|, and |MariaDB|. It performs streaming, compressed, and incremental |MySQL| backups.
100
101-|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.
102+|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.
103
104 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.
105
106
107=== modified file 'storage/innobase/xtrabackup/doc/source/xtrabackup_bin/xbk_option_reference.rst'
108--- storage/innobase/xtrabackup/doc/source/xtrabackup_bin/xbk_option_reference.rst 2013-11-15 12:42:15 +0000
109+++ storage/innobase/xtrabackup/doc/source/xtrabackup_bin/xbk_option_reference.rst 2014-06-04 08:15:57 +0000
110@@ -25,11 +25,11 @@
111
112 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.
113
114-.. option:: --compress-chunk-size
115+.. option:: --compress-chunk-size=#
116
117 Size of working buffer(s) for compression threads in bytes. The default value is 64K.
118
119-.. option:: --compress-threads
120+.. option:: --compress-threads=#
121
122 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.
123
124@@ -37,19 +37,19 @@
125
126 This option is not currently implemented. To create the InnoDB log files, you must prepare the backup twice at present.
127
128-.. option:: --datadir
129+.. option:: --datadir=DIRECTORY
130
131 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.
132
133-.. option:: --defaults-extra-file=#
134+.. option:: --defaults-extra-file=[MY.CNF]
135
136 Read this file after the global files are read. Must be given as the first option on the command-line.
137
138-.. option:: --defaults-file=#
139+.. option:: --defaults-file=[MY.CNF]
140
141 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.
142
143-.. option:: --defaults-group
144+.. option:: --defaults-group=GROUP-NAME
145
146 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.
147
148@@ -57,15 +57,15 @@
149
150 Create files necessary for exporting tables. See :doc:`Restoring Individual Tables <restoring_individual_tables>`.
151
152-.. option:: --extra-lsndir=name
153+.. option:: --extra-lsndir=DIRECTORY
154
155 (for --backup): save an extra copy of the xtrabackup_checkpoints file in this directory.
156
157-.. option:: --incremental-basedir
158+.. option:: --incremental-basedir=DIRECTORY
159
160 When creating an incremental backup, this is the directory containing the full backup that is the base dataset for the incremental backups.
161
162-.. option:: --incremental-dir
163+.. option:: --incremental-dir=DIRECTORY
164
165 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.
166
167@@ -73,11 +73,11 @@
168
169 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.
170
171-.. option:: --incremental-lsn=name
172-
173- 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!
174-
175-.. option:: --innodb-log-arch-dir
176+.. option:: --incremental-lsn=LSN
177+
178+ 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!
179+
180+.. option:: --innodb-log-arch-dir=DIRECTORY
181
182 This option is used to specify the directory containing the archived logs. It can only be used with the :option:`xtrabackup --prepare` option.
183
184@@ -113,7 +113,7 @@
185 --innodb-read-io-threads
186 --innodb-write-io-threads
187
188-.. option:: --log-copy-interval
189+.. option:: --log-copy-interval=#
190
191 This option specifies time interval between checks done by log copying thread in milliseconds (default is 1 second).
192
193@@ -169,7 +169,7 @@
194
195 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`.
196
197-.. option:: --target-dir=name
198+.. option:: --target-dir=DIRECTORY
199
200 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``.
201
202@@ -183,13 +183,13 @@
203
204 This option is currently not used for anything except printing out the correct tmpdir parameter when :option:`--print-param` is used.
205
206-.. option:: --to-archived-lsn
207+.. option:: --to-archived-lsn=LSN
208
209 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.
210
211 .. option:: --use-memory=#
212
213- 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.
214+ 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).
215
216 .. option:: --version
217

Subscribers

People subscribed via source and target branches