· 8 years ago · May 29, 2018, 11:42 PM
1innobackupex-1.5.1 --help
2Options:
3 --apply-log
4 Prepare a backup in BACKUP-DIR by applying the transaction log file
5 named "xtrabackup_logfile" located in the same directory. Also,
6 create new transaction logs. The InnoDB configuration is read from
7 the file "backup-my.cnf".
8
9 --copy-back
10 Copy all the files in a previously made backup from the backup
11 directory to their original locations.
12
13 --databases=LIST
14 This option specifies the list of databases that innobackupex should
15 back up. The option accepts a string argument. The list is of the
16 form "databasename1[.table_name1] databasename2[.table_name2] . .
17 .". If this option is not specified, all databases containing MyISAM
18 and InnoDB tables will be backed up. Please make sure that
19 --databases contains all of the InnoDB databases and tables, so that
20 all of the innodb.frm files are also backed up. In case the list is
21 very long, this can be specified in a file, and the full path of the
22 file can be specified instead of the list. (See option
23 --tables-file.)
24
25 --defaults-file=[MY.CNF]
26 This option specifies what file to read the default MySQL options
27 from. The option accepts a string argument. It is also passed
28 directly to xtrabackup's --defaults-file option. See the xtrabackup
29 documentation for details.
30
31 --export
32 This option is passed directly to xtrabackup's --export option. It
33 enables exporting individual tables for import into another server.
34 See the xtrabackup documentation for details.
35
36 --extra-lsndir=DIRECTORY
37 This option specifies the directory in which to save an extra copy
38 of the "xtrabackup_checkpoints" file. The option accepts a string
39 argument. It is passed directly to xtrabackup's --extra-lsndir
40 option. See the xtrabackup documentation for details.
41
42 --force-tar
43 This option forces the use of tar when creating a streamed backup,
44 rather than tar4ibd, which is the default.
45
46 --help
47 This option displays a help screen and exits.
48
49 --host=HOST
50 This option specifies the host to use when connecting to the
51 database server with TCP/IP. The option accepts a string argument.
52 It is passed to the mysql child process without alteration. See
53 mysql --help for details.
54
55 --ibbackup-binary=IBBACKUP-BINARY
56 This option specifies which xtrabackup binary should be used. The
57 option accepts a string argument. IBBACKUP-BINARY should be the
58 command used to run XtraBackup. The option can be useful if the
59 xtrabackup binary is not in your search path or working directory.
60 If this option is not specified, innobackupex attempts to determine
61 the binary to use automatically. By default, "xtrabackup" is the
62 command used. However, when option --copy-back is specified,
63 "xtrabackup_51" is the command used. And when option --apply-log is
64 specified, the binary is used whose name is in the file
65 "xtrabackup_binary" in the backup directory, if that file exists.
66
67 --include=REGEXP
68 This option is a regular expression to be matched against table
69 names in databasename.tablename format. It is passed directly to
70 xtrabackup's --tables option. See the xtrabackup documentation for
71 details.
72
73 --incremental
74 This option tells xtrabackup to create an incremental backup, rather
75 than a full one. It is passed to the xtrabackup child process. When
76 this option is specified, either --incremental-lsn or
77 --incremental-basedir can also be given. If neither option is given,
78 option --incremental-basedir is passed to xtrabackup by default, set
79 to the first timestamped backup directory in the backup base
80 directory.
81
82 --incremental-basedir=DIRECTORY
83 This option specifies the directory containing the full backup that
84 is the base dataset for the incremental backup. The option accepts a
85 string argument. It is used with the --incremental option.
86
87 --incremental-dir=DIRECTORY
88 This option specifies the directory where the incremental backup
89 will be combined with the full backup to make a new full backup. The
90 option accepts a string argument. It is used with the --incremental
91 option.
92
93 --incremental-lsn
94 This option specifies the log sequence number (LSN) to use for the
95 incremental backup. The option accepts a string argument. It is used
96 with the --incremental option. It is used instead of specifying
97 --incremental-basedir. For databases created by MySQL and Percona
98 Server 5.0-series versions, specify the LSN as two 32-bit integers
99 in high:low format. For databases created in 5.1 and later, specify
100 the LSN as a single 64-bit integer.
101
102 --no-lock
103 Use this option to disable table lock with "FLUSH TABLES WITH READ
104 LOCK". Use it only if ALL your tables are InnoDB and you DO NOT CARE
105 about the binary log position of the backup.
106
107 --no-timestamp
108 This option prevents creation of a time-stamped subdirectory of the
109 BACKUP-ROOT-DIR given on the command line. When it is specified, the
110 backup is done in BACKUP-ROOT-DIR instead.
111
112 --parallel=NUMBER-OF-THREADS
113 This option specifies the number of threads the xtrabackup child
114 process should use to back up files concurrently. The option accepts
115 an integer argument. It is passed directly to xtrabackup's
116 --parallel option. See the xtrabackup documentation for details.
117
118 --password=WORD
119 This option specifies the password to use when connecting to the
120 database. It accepts a string argument. It is passed to the mysql
121 child process without alteration. See mysql --help for details.
122
123 --port=PORT
124 This option specifies the port to use when connecting to the
125 database server with TCP/IP. The option accepts a string argument.
126 It is passed to the mysql child process. It is passed to the mysql
127 child process without alteration. See mysql --help for details.
128
129 --redo-only
130 This option is passed directly to xtrabackup's --apply-log-only
131 option. This forces xtrabackup to skip the "rollback" phase and do a
132 "redo" only. This is necessary if the backup will have incremental
133 changes applied to it later. See the xtrabackup documentation for
134 details.
135
136 --remote-host=HOSTNAME
137 This option specifies the remote host on which the backup files will
138 be created, by using an ssh connection. The option accepts a string
139 argument.
140
141 --safe-slave-backup
142 Stop slave SQL thread and wait to start backup until
143 Slave_open_temp_tables in "SHOW STATUS" is zero. If there are no
144 open temporary tables, the backup will take place, otherwise the SQL
145 thread will be started and stopped until there are no open temporary
146 tables. The backup will fail if Slave_open_temp_tables does not
147 become zero after --safe-slave-backup-timeout seconds. The slave SQL
148 thread will be restarted when the backup finishes.
149
150 --safe-slave-backup-timeout
151 How many seconds --safe-slave-backup should wait for
152 Slave_open_temp_tables to become zero. (default 300)
153
154 --scpopt=SCP-OPTIONS
155 This option specifies the command line options to pass to scp when
156 the option --remost-host is specified. The option accepts a string
157 argument. If the option is not specified, the default options are
158 "-Cp -c arcfour".
159
160 --slave-info
161 This option is useful when backing up a replication slave server. It
162 prints the binary log position and name of the master server. It
163 also writes this information to the "xtrabackup_slave_info" file as
164 a "CHANGE MASTER" command. A new slave for this master can be set up
165 by starting a slave server on this backup and issuing a "CHANGE
166 MASTER" command with the binary log position saved in the
167 "xtrabackup_slave_info" file.
168
169 --socket=SOCKET
170 This option specifies the socket to use when connecting to the local
171 database server with a UNIX domain socket. The option accepts a
172 string argument. It is passed to the mysql child process without
173 alteration. See mysql --help for details.
174
175 --stream=[tar|. . .]
176 This option specifies the format in which to do the streamed backup.
177 The option accepts a string argument. The backup will be done to
178 STDOUT in the specified format. Currently, the only supported format
179 is tar. Uses tar4ibd, which is available in XtraBackup
180 distributions.
181
182 --tables-file=FILE
183 This option specifies the file in which there are a list of names of
184 the form database. The option accepts a string argument.table, one
185 per line. The option is passed directly to xtrabackup's
186 --tables-file option.
187
188 --throttle=IOS
189 This option specifies a number of I/O operations (pairs of
190 read+write) per second. It accepts an integer argument. It is passed
191 directly to xtrabackup's --throttle option.
192
193 --tmpdir=DIRECTORY
194 This option specifies the location where a temporary file will be
195 stored. The option accepts a string argument. It should be used when
196 --remote-host or --stream is specified. For these options, the
197 transaction log will first be stored to a temporary file, before
198 streaming or copying to a remote host. This option specifies the
199 location where that temporary file will be stored. If the option is
200 not specifed, the default is to use the value of tmpdir read from
201 the server configuration.
202
203 --use-memory=MB
204 This option specifies the amount of memory in megabytes for
205 xtrabackup to use for crash recovery while preparing a backup. The
206 option accepts a string argument. It is used only with the option
207 --apply-log. It is passed directly to xtrabackup's --use-memory
208 option. See the xtrabackup documentation for details.
209
210 --user=NAME
211 This option specifies the MySQL username used when connecting to the
212 server, if that's not the current user. The option accepts a string
213 argument. It is passed to the mysql child process without
214 alteration. See mysql --help for details.
215
216 --version
217 This option displays the xtrabackup version and copyright notice and
218 then exits.