← Back to branch summary

~drizzle-trunk/drizzle/development

« back to all changes in this revision

Viewing changes to docs/clients/drizzledump.rst

  • Committer: Andrew Hutchings
  • Date: 2011-02-23 14:17:23 UTC
  • mto: (2196.1.3 build)
  • mto: This revision was merged to the branch mainline in revision 2197.
  • Revision ID: andrew@linuxjedi.co.uk-20110223141723-spck4t85k8igzk4j
Markup fixes

Show diffs side-by-side

added added

removed removed

Lines of Context:
docs/clients/drizzledump.rst
33
33
 
34
34
.. option:: --all-databases, -A
35
35
 
36
 
Dumps all databases found on the server apart from ``information_schema`` and
37
 
``data_dictionary`` in Drizzle and ``information_schema``,
38
 
``performance_schema`` and ``mysql`` in MySQL.
 
36
   Dumps all databases found on the server apart from ``information_schema`` and
 
37
   ``data_dictionary`` in Drizzle and ``information_schema``,
 
38
   ``performance_schema`` and ``mysql`` in MySQL.
39
39
 
40
40
.. option:: --force, -f
41
41
 
42
 
Continue even if we get an sql-error.
 
42
   Continue even if we get an sql-error.
43
43
 
44
44
.. option:: --help, -?
45
45
 
46
 
Show a message with all the available options.
 
46
   Show a message with all the available options.
47
47
 
48
48
.. option:: --lock-all-tables, -x
49
49
 
50
 
Locks all the tables for all databases with a global read lock.  The lock is
51
 
released automatically when :program:`drizzledump` ends.
52
 
Turns on :option:`--single-transaction` and :option:`--lock-tables`.
 
50
   Locks all the tables for all databases with a global read lock.  The lock is
 
51
   released automatically when :program:`drizzledump` ends.
 
52
   Turns on :option:`--single-transaction` and :option:`--lock-tables`.
53
53
 
54
54
.. option:: --single-transaction
55
55
 
56
 
Creates a consistent snapshot by dumping the tables in a single transaction.
57
 
During the snapshot no other connected client should use any of the
58
 
following as this will implicitly commit the transaction and prevent the
59
 
consistency:
 
56
   Creates a consistent snapshot by dumping the tables in a single transaction.
 
57
   During the snapshot no other connected client should use any of the
 
58
   following as this will implicitly commit the transaction and prevent the
 
59
   consistency:
60
60
 
61
 
.. code-block:: mysql
 
61
   .. code-block:: mysql
62
62
 
63
63
        ALTER TABLE
64
64
        DROP TABLE
65
65
        RENAME TABLE
66
66
        TRUNCATE TABLE
67
67
 
68
 
Only works with InnoDB.
 
68
   Only works with InnoDB.
69
69
 
70
70
.. option:: --skip-opt
71
71
 
72
 
A shortcut for :option:`--skip-drop-table`, :option:`--skip-create`, 
73
 
:option:`--skip-extended-insert` and :option:`--skip-disable-keys`
 
72
   A shortcut for :option:`--skip-drop-table`, :option:`--skip-create`, 
 
73
   :option:`--skip-extended-insert` and :option:`--skip-disable-keys`
74
74
 
75
75
.. option:: --tables t1 t2 ...
76
76
 
77
 
Dump a list of tables.
 
77
   Dump a list of tables.
78
78
 
79
79
.. option:: --show-progress-size rows (=10000)
80
80
 
81
 
Show progress of the dump every *rows* of the dump.  Requires
82
 
:option:`--verbose`
 
81
   Show progress of the dump every *rows* of the dump.  Requires
 
82
   :option:`--verbose`
83
83
 
84
84
.. option:: --verbose, -v
85
85
 
86
 
Sends various verbose information to stderr as the dump progresses.
 
86
   Sends various verbose information to stderr as the dump progresses.
87
87
 
88
88
.. option:: --skip-extended-insert
89
89
 
90
 
Dump every row on an individual line.  For example:
 
90
   Dump every row on an individual line.  For example:
91
91
 
92
92
.. code-block:: mysql
93
93
 
96
96
 
97
97
.. option:: --skip-dump-date
98
98
 
99
 
Do not display the date/time at the end of the dump.
 
99
   Do not display the date/time at the end of the dump.
100
100
 
101
101
.. option:: --no-defaults
102
102
 
103
 
Do not attempt to read configuration from configuration files.
 
103
   Do not attempt to read configuration from configuration files.
104
104
 
105
105
.. option:: --add-drop-database
106
106
 
107
 
Add ``DROP DATABASE`` statements before ``CREATE DATABASE``.
 
107
   Add ``DROP DATABASE`` statements before ``CREATE DATABASE``.
108
108
 
109
109
.. option:: --compact
110
110
 
111
 
Gives a more compact output by disabling header/footer comments and enabling
112
 
:option:`--skip-add-drop-table`, :option:`--skip-disable-keys` 
113
 
and :option:`--skip-add-locks`.
 
111
   Gives a more compact output by disabling header/footer comments and enabling
 
112
   :option:`--skip-add-drop-table`, :option:`--skip-disable-keys` 
 
113
   and :option:`--skip-add-locks`.
114
114
 
115
115
.. option:: --databases, -B
116
116
 
117
 
Dump several databases.  The databases do not need to follow on after this
118
 
option, they can be anywhere in the command line.
 
117
   Dump several databases.  The databases do not need to follow on after this
 
118
   option, they can be anywhere in the command line.
119
119
 
120
120
.. option:: --skip-disable-keys, -K
121
121
 
122
 
Do not dump the statements ``ALTER TABLE ... DISABLE KEYS`` and
123
 
``ALTER TABLE ... ENABLE KEYS``
 
122
   Do not dump the statements ``ALTER TABLE ... DISABLE KEYS`` and
 
123
   ``ALTER TABLE ... ENABLE KEYS``
124
124
 
125
125
.. option:: --ignore-table table
126
126
 
127
 
Do not dump specified table, needs to be in the format ``database.table``.
128
 
Can be specified multiple times for multiple tables.
 
127
   Do not dump specified table, needs to be in the format ``database.table``.
 
128
   Can be specified multiple times for multiple tables.
129
129
 
130
130
.. option:: --insert-ignore
131
131
 
132
 
Add the ``IGNORE`` keyword into every ``INSERT`` statement.
 
132
   Add the ``IGNORE`` keyword into every ``INSERT`` statement.
133
133
 
134
134
.. option:: --no-autocommit
135
135
 
136
 
Make the dump of each table a single transaction by wrapping it in ``COMMIT``
137
 
statements.
 
136
   Make the dump of each table a single transaction by wrapping it in ``COMMIT``
 
137
   statements.
138
138
 
139
139
.. option:: --no-create-db, -n
140
140
 
141
 
Do not dump the ``CREATE DATABASE`` statements when using
142
 
:option:`--all-databases` or :option:`--databases`.
 
141
   Do not dump the ``CREATE DATABASE`` statements when using
 
142
   :option:`--all-databases` or :option:`--databases`.
143
143
 
144
144
.. option:: --skip-create, -t
145
145
 
146
 
Do not dump the ``CREATE TABLE`` statements.
 
146
   Do not dump the ``CREATE TABLE`` statements.
147
147
 
148
148
.. option:: --no-data, -d
149
149
 
150
 
Do not dump the data itself, used to dump the schemas only.
 
150
   Do not dump the data itself, used to dump the schemas only.
151
151
 
152
152
.. option:: --replace
153
153
 
154
 
Use ``REPLACE INTO`` statements instead of ``INSERT INTO``
 
154
   Use ``REPLACE INTO`` statements instead of ``INSERT INTO``
155
155
 
156
156
.. option:: --destination-type type (=stdout)
157
157
 
158
 
Destination of the data.
159
 
 
160
 
**stdout**
161
 
The default.  Output to the command line
162
 
 
163
 
**database**
164
 
Connect to another database and pipe data to that.
165
 
 
166
 
.. versionadded:: 2010-09-27
 
158
   Destination of the data.
 
159
 
 
160
   **stdout**
 
161
   The default.  Output to the command line
 
162
 
 
163
   **database**
 
164
   Connect to another database and pipe data to that.
 
165
 
 
166
   .. versionadded:: Drizzle7 2010-09-27
167
167
 
168
168
.. option:: --destination-host hostname (=localhost)
169
169
 
170
 
The hostname for the destination database.  Requires
171
 
:option:`--destination-type` `= database`
 
170
   The hostname for the destination database.  Requires
 
171
   :option:`--destination-type` `= database`
172
172
 
173
 
.. versionadded:: 2010-09-27
 
173
   .. versionadded:: Drizzle7 2010-09-27
174
174
 
175
175
.. option:: --destination-port port (=3306)
176
176
 
177
 
The port number for the destination database.  Requires
178
 
:option:`--destination-type` `= database`
 
177
   The port number for the destination database.  Requires
 
178
   :option:`--destination-type` `= database`
179
179
 
180
 
.. versionadded:: 2010-09-27
 
180
   .. versionadded:: Drizzle7 2010-09-27
181
181
 
182
182
.. option:: --destination-user username
183
183
 
184
 
The username for the destinations database.  Requires
185
 
:option:`--destination-type` `= database`
 
184
   The username for the destinations database.  Requires
 
185
   :option:`--destination-type` `= database`
186
186
 
187
 
.. versionadded:: 2010-09-27
 
187
   .. versionadded:: Drizzle7 2010-09-27
188
188
 
189
189
.. option:: --destination-password password
190
190
 
191
 
The password for the destination database.  Requires
192
 
:option:`--destination-type` `= database`
 
191
   The password for the destination database.  Requires
 
192
   :option:`--destination-type` `= database`
193
193
 
194
 
.. versionadded:: 2010-09-27
 
194
   .. versionadded:: Drizzle7 2010-09-27
195
195
 
196
196
.. option:: --destination-database database
197
197
 
198
 
The database for the destination database, for use when only dumping a
199
 
single database.  Requires
200
 
:option:`--destination-type` `= database`
 
198
   The database for the destination database, for use when only dumping a
 
199
   single database.  Requires
 
200
   :option:`--destination-type` `= database`
201
201
 
202
 
.. versionadded:: 2010-09-27
 
202
   .. versionadded:: Drizzle7 2010-09-27
203
203
 
204
204
.. option:: --my-data-is-mangled
205
205
 
206
 
If your data is UTF8 but has been stored in a latin1 table using a latin1
207
 
connection then corruption is likely and drizzledump by default will retrieve
208
 
mangled data.  This is because MySQL will convert the data to UTF8 on the way
209
 
out to drizzledump and you effectively get a double-conversion to UTF8.
210
 
 
211
 
This typically happens with PHP apps that do not use ``SET NAMES``.
212
 
 
213
 
In these cases setting this option will retrieve the data as you see it in your
214
 
application.
215
 
 
216
 
.. versionadded:: 2011-01-31
 
206
   If your data is UTF8 but has been stored in a latin1 table using a latin1
 
207
   connection then corruption is likely and drizzledump by default will retrieve
 
208
   mangled data.  This is because MySQL will convert the data to UTF8 on the way
 
209
   out to drizzledump and you effectively get a double-conversion to UTF8.
 
210
 
 
211
   This typically happens with PHP apps that do not use ``SET NAMES``.
 
212
 
 
213
   In these cases setting this option will retrieve the data as you see it in
 
214
   your application.
 
215
 
 
216
   .. versionadded:: Drizzle7 2011-01-31
217
217
 
218
218
.. option:: --host, -h hostname (=localhost)
219
219
 
220
 
The hostname of the database server.
 
220
   The hostname of the database server.
221
221
 
222
222
.. option:: --user, -u username
223
223
 
224
 
The username for the database server.
 
224
   The username for the database server.
225
225
 
226
226
.. option:: --password, -P password
227
227
 
228
 
The password for the database server.
 
228
   The password for the database server.
229
229
 
230
230
.. option:: --port, -p port (=4427)
231
231
 
232
 
The port number of the database server.
 
232
   The port number of the database server.
233
233
 
234
234
.. option:: --protocol protocol (=mysql)
235
235
 
236
 
The protocol to use when connecting to the database server.  Options are:
237
 
 
238
 
**mysql**
239
 
The standard MySQL protocol.
240
 
 
241
 
**drizzle**
242
 
The Drizzle protocol.
 
236
   The protocol to use when connecting to the database server.  Options are:
 
237
 
 
238
   **mysql**
 
239
   The standard MySQL protocol.
 
240
 
 
241
   **drizzle**
 
242
   The Drizzle protocol.
243
243
 
244
244
Backups using Drizzledump
245
245
-------------------------