2165.3.1
by Andrew Hutchings
Make fixes to drizzledump docs |
1 |
.. _options: |
2 |
||
1794.2.5
by Monty Taylor
Added support to pandora for finding and including per-plugin documentation. |
3 |
Drizzled Options
|
4 |
================
|
|
5 |
||
6 |
There are many different options one can use to configure Drizzle. |
|
7 |
||
1802.8.4
by Monty Taylor
Removed old language arg. |
8 |
Config File Options
|
9 |
-------------------
|
|
10 |
||
2194.5.5
by Andrew Hutchings
Fix options indexing |
11 |
.. program:: drizzled |
12 |
||
1813.2.3
by Monty Taylor
Merged in documentation fixes and language removal. |
13 |
.. option:: --help-extended |
2194.5.3
by Andrew Hutchings
Markup fixes |
14 |
|
15 |
Display this help and exit after initializing plugins. |
|
16 |
||
17 |
.. option:: --help, -? |
|
18 |
||
19 |
Display this help and exit. |
|
1802.8.4
by Monty Taylor
Removed old language arg. |
20 |
|
21 |
.. option:: --no-defaults |
|
2194.5.3
by Andrew Hutchings
Markup fixes |
22 |
|
23 |
Configuration file defaults are not used if no-defaults is set |
|
1802.8.4
by Monty Taylor
Removed old language arg. |
24 |
|
25 |
.. option:: --defaults-file arg |
|
2194.5.3
by Andrew Hutchings
Markup fixes |
26 |
|
27 |
Configuration file to use |
|
1802.8.4
by Monty Taylor
Removed old language arg. |
28 |
|
29 |
.. option:: --config-dir arg (=/etc/drizzle) |
|
2194.5.3
by Andrew Hutchings
Markup fixes |
30 |
|
31 |
Base location for config files |
|
1802.8.4
by Monty Taylor
Removed old language arg. |
32 |
|
33 |
.. option:: --plugin-dir arg |
|
2194.5.3
by Andrew Hutchings
Markup fixes |
34 |
|
35 |
Directory for plugins |
|
1802.8.4
by Monty Taylor
Removed old language arg. |
36 |
|
1813.3.5
by Monty Taylor
Document drizzled options. |
37 |
.. option:: --pid-file arg |
38 |
||
2194.5.3
by Andrew Hutchings
Markup fixes |
39 |
Pid file used by drizzled. |
1813.3.5
by Monty Taylor
Document drizzled options. |
40 |
|
1802.8.4
by Monty Taylor
Removed old language arg. |
41 |
Plugin Loading Options
|
42 |
----------------------
|
|
43 |
||
2194.5.5
by Andrew Hutchings
Fix options indexing |
44 |
.. program:: drizzled |
45 |
||
1802.8.4
by Monty Taylor
Removed old language arg. |
46 |
.. option:: --plugin-add arg |
2194.5.3
by Andrew Hutchings
Markup fixes |
47 |
|
48 |
Optional comma separated list of plugins to load at startup in addition |
|
49 |
to the default list of plugins. |
|
1802.8.4
by Monty Taylor
Removed old language arg. |
50 |
|
2194.5.3
by Andrew Hutchings
Markup fixes |
51 |
For example::
|
52 |
||
53 |
--plugin_add=crc32,console,pbxt
|
|
1802.8.4
by Monty Taylor
Removed old language arg. |
54 |
|
55 |
.. option:: --plugin-remove arg |
|
2194.5.3
by Andrew Hutchings
Markup fixes |
56 |
|
57 |
Optional comma separated list of plugins to not load at startup. |
|
58 |
Effectively removes a plugin from the list of plugins to be loaded. |
|
59 |
||
60 |
For example::
|
|
61 |
||
62 |
--plugin_remove=syslog,md5
|
|
63 |
||
64 |
.. option:: --plugin-load arg (=version, uuid_function, user_function, transaction_log, syslog, substr_functions, sleep, show_schema_proto, rot13, reverse_function, rand_function, multi_thread, md5, logging_stats, length, hex_functions, hello_world, filtered_replicator, errmsg_stderr, default_replicator, database_function, crc32, connection_id, compression, charlength, benchmark, ascii) |
|
65 |
||
66 |
Optional comma separated list of plugins to load at starup instead of |
|
67 |
the default plugin load list. This completely replaces the whole list. |
|
1802.8.4
by Monty Taylor
Removed old language arg. |
68 |
|
1794.2.5
by Monty Taylor
Added support to pandora for finding and including per-plugin documentation. |
69 |
Kernel Options
|
70 |
--------------
|
|
1802.8.4
by Monty Taylor
Removed old language arg. |
71 |
|
2194.5.5
by Andrew Hutchings
Fix options indexing |
72 |
.. program:: drizzled |
73 |
||
1802.8.4
by Monty Taylor
Removed old language arg. |
74 |
.. option:: --auto-increment-increment arg (=1) |
75 |
||
2194.5.3
by Andrew Hutchings
Markup fixes |
76 |
Auto-increment columns are incremented by this |
1802.8.4
by Monty Taylor
Removed old language arg. |
77 |
|
78 |
.. option:: --auto-increment-offset arg (=1) |
|
79 |
||
2194.5.3
by Andrew Hutchings
Markup fixes |
80 |
Offset added to Auto-increment columns. |
81 |
Used when auto-increment-increment != 1 |
|
82 |
||
83 |
.. option:: --basedir, -b arg |
|
84 |
||
85 |
Path to installation directory. |
|
86 |
All paths are usually resolved relative to this. |
|
87 |
||
88 |
.. option:: --chroot, -r arg |
|
89 |
||
90 |
Chroot drizzled daemon during startup. |
|
1802.8.4
by Monty Taylor
Removed old language arg. |
91 |
|
92 |
.. option:: --collation-server arg |
|
93 |
||
2194.5.3
by Andrew Hutchings
Markup fixes |
94 |
Set the default collation. |
1802.8.4
by Monty Taylor
Removed old language arg. |
95 |
|
96 |
.. option:: --completion-type arg (=0) |
|
97 |
||
2194.5.3
by Andrew Hutchings
Markup fixes |
98 |
Default completion type. |
1802.8.4
by Monty Taylor
Removed old language arg. |
99 |
|
100 |
.. option:: --core-file |
|
101 |
||
2194.5.3
by Andrew Hutchings
Markup fixes |
102 |
Write core on errors. |
1802.8.4
by Monty Taylor
Removed old language arg. |
103 |
|
104 |
.. option:: --datadir arg |
|
105 |
||
2194.5.3
by Andrew Hutchings
Markup fixes |
106 |
Path to the database root. |
1802.8.4
by Monty Taylor
Removed old language arg. |
107 |
|
108 |
.. option:: --default-storage-engine arg |
|
109 |
||
2194.5.3
by Andrew Hutchings
Markup fixes |
110 |
Set the default storage engine for tables. |
1802.8.4
by Monty Taylor
Removed old language arg. |
111 |
|
112 |
.. option:: --default-time-zone arg |
|
113 |
||
2194.5.3
by Andrew Hutchings
Markup fixes |
114 |
Set the default time zone. |
1802.8.4
by Monty Taylor
Removed old language arg. |
115 |
|
116 |
.. We should really remove --exit-info as an option
|
|
2194.5.3
by Andrew Hutchings
Markup fixes |
117 |
.. option:: --exit-info, -T arg |
1802.8.4
by Monty Taylor
Removed old language arg. |
118 |
|
2194.5.3
by Andrew Hutchings
Markup fixes |
119 |
Used for debugging; Use at your own risk! |
1802.8.4
by Monty Taylor
Removed old language arg. |
120 |
|
1802.8.5
by Monty Taylor
Document drizzled options. |
121 |
.. option:: --gdb |
122 |
||
2194.5.3
by Andrew Hutchings
Markup fixes |
123 |
Set up signals usable for debugging |
1802.8.5
by Monty Taylor
Document drizzled options. |
124 |
|
125 |
.. option:: --lc-time-name arg |
|
126 |
||
2194.5.3
by Andrew Hutchings
Markup fixes |
127 |
Set the language used for the month names and the days of the week. |
128 |
||
129 |
.. option:: --log-warnings, -W arg |
|
130 |
||
131 |
Log some not critical warnings to the log file. |
|
1802.8.5
by Monty Taylor
Document drizzled options. |
132 |
|
133 |
.. Why is this a core argument?
|
|
134 |
.. option:: --port-open-timeout arg (=0) |
|
135 |
||
2194.5.3
by Andrew Hutchings
Markup fixes |
136 |
Maximum time in seconds to wait for the port to become free. |
137 |
A value of 0 means not to wait. |
|
1802.8.5
by Monty Taylor
Document drizzled options. |
138 |
|
139 |
.. option:: --secure-file-priv arg |
|
140 |
||
2194.5.3
by Andrew Hutchings
Markup fixes |
141 |
Limit LOAD DATA, SELECT ... OUTFILE, and LOAD_FILE() to files within |
142 |
specified directory |
|
1802.8.5
by Monty Taylor
Document drizzled options. |
143 |
|
144 |
.. Why is this still here?
|
|
145 |
.. option:: --server-id arg (=0) |
|
146 |
||
2194.5.3
by Andrew Hutchings
Markup fixes |
147 |
Uniquely identifies the server instance in the community of replication |
148 |
partners. |
|
1802.8.5
by Monty Taylor
Document drizzled options. |
149 |
|
150 |
.. option:: --skip-stack-trace |
|
151 |
||
2194.5.3
by Andrew Hutchings
Markup fixes |
152 |
Don't print a stack trace on failure. |
153 |
||
154 |
.. option:: --symbolic-links, -s |
|
155 |
||
156 |
Enable symbolic link support. |
|
1802.8.5
by Monty Taylor
Document drizzled options. |
157 |
|
158 |
.. option:: --timed-mutexes |
|
159 |
||
2194.5.3
by Andrew Hutchings
Markup fixes |
160 |
Specify whether to time mutexes (only InnoDB mutexes are currently supported) |
161 |
||
162 |
.. option:: --tmpdir, -t arg |
|
163 |
||
164 |
Path for temporary files. |
|
1802.8.5
by Monty Taylor
Document drizzled options. |
165 |
|
166 |
.. option:: --transaction-isolation arg |
|
167 |
||
2194.5.3
by Andrew Hutchings
Markup fixes |
168 |
Default transaction isolation level. |
169 |
||
170 |
.. option:: --user, -u arg |
|
171 |
||
172 |
Run drizzled daemon as user. |
|
1802.8.5
by Monty Taylor
Document drizzled options. |
173 |
|
2194.5.3
by Andrew Hutchings
Markup fixes |
174 |
.. option:: --version, -V |
1802.8.5
by Monty Taylor
Document drizzled options. |
175 |
|
2194.5.3
by Andrew Hutchings
Markup fixes |
176 |
Output version information and exit. |
1802.8.5
by Monty Taylor
Document drizzled options. |
177 |
|
178 |
.. option:: --back-log arg (=50) |
|
179 |
||
2194.5.3
by Andrew Hutchings
Markup fixes |
180 |
The number of outstanding connection requests Drizzle can have. This comes |
181 |
into play when the main Drizzle thread gets very many connection requests in |
|
182 |
a very short time. |
|
1802.8.5
by Monty Taylor
Document drizzled options. |
183 |
|
184 |
.. option:: --bulk-insert-buffer-size arg (=8388608) |
|
185 |
||
2194.5.3
by Andrew Hutchings
Markup fixes |
186 |
Size of tree cache used in bulk insert optimization. Note that this is a |
187 |
limit per thread! |
|
1802.8.5
by Monty Taylor
Document drizzled options. |
188 |
|
189 |
.. option:: --div-precision-increment arg (=4) |
|
190 |
||
2194.5.3
by Andrew Hutchings
Markup fixes |
191 |
Precision of the result of '/' operator will be increased on that value. |
1802.8.5
by Monty Taylor
Document drizzled options. |
192 |
|
193 |
.. option:: --group-concat-max-len arg (=1024) |
|
194 |
||
2194.5.3
by Andrew Hutchings
Markup fixes |
195 |
The maximum length of the result of function group_concat. |
1802.8.5
by Monty Taylor
Document drizzled options. |
196 |
|
197 |
.. option:: --join-buffer-size arg (=131072) |
|
198 |
||
2194.5.3
by Andrew Hutchings
Markup fixes |
199 |
The size of the buffer that is used for full joins. |
1802.8.5
by Monty Taylor
Document drizzled options. |
200 |
|
1796.4.14
by Andrew Hutchings
Document new options (also fix another option in documentation) |
201 |
.. option:: --join-buffer-constraint arg (=0) |
202 |
||
2194.5.3
by Andrew Hutchings
Markup fixes |
203 |
A global constraint for join-buffer-size for all clients, cannot be set lower |
204 |
than --join-buffer-size. Setting to 0 means unlimited. |
|
1796.4.14
by Andrew Hutchings
Document new options (also fix another option in documentation) |
205 |
|
1802.8.5
by Monty Taylor
Document drizzled options. |
206 |
.. Why is this a core arg?
|
1796.4.14
by Andrew Hutchings
Document new options (also fix another option in documentation) |
207 |
.. option:: --max-allowed-packet arg (=64M) |
1802.8.5
by Monty Taylor
Document drizzled options. |
208 |
|
2194.5.3
by Andrew Hutchings
Markup fixes |
209 |
Max packetlength to send/receive from to server. |
1802.8.5
by Monty Taylor
Document drizzled options. |
210 |
|
211 |
.. option:: --max-connect-errors arg (=10) |
|
212 |
||
2194.5.3
by Andrew Hutchings
Markup fixes |
213 |
If there is more than this number of interrupted connections from a host |
214 |
this host will be blocked from further connections. |
|
1802.8.5
by Monty Taylor
Document drizzled options. |
215 |
|
216 |
.. option:: --max-error-count arg (=64) |
|
217 |
||
2194.5.3
by Andrew Hutchings
Markup fixes |
218 |
Max number of errors/warnings to store for a statement. |
1802.8.5
by Monty Taylor
Document drizzled options. |
219 |
|
220 |
.. option:: --max-heap-table-size arg (=16M) |
|
221 |
||
2194.5.3
by Andrew Hutchings
Markup fixes |
222 |
Don't allow creation of heap tables bigger than this. |
1802.8.5
by Monty Taylor
Document drizzled options. |
223 |
|
224 |
.. option:: --max-join-size arg (=2147483647) |
|
225 |
||
2194.5.3
by Andrew Hutchings
Markup fixes |
226 |
Joins that are probably going to read more than max_join_size records return |
227 |
an error. |
|
1802.8.5
by Monty Taylor
Document drizzled options. |
228 |
|
229 |
.. option:: --max-length-for-sort-data arg (=1024) |
|
230 |
||
2194.5.3
by Andrew Hutchings
Markup fixes |
231 |
Max number of bytes in sorted records. |
1802.8.5
by Monty Taylor
Document drizzled options. |
232 |
|
233 |
.. option:: --max-seeks-for-key arg (=18446744073709551615) |
|
234 |
||
2194.5.3
by Andrew Hutchings
Markup fixes |
235 |
Limit assumed max number of seeks when looking up rows based on a key |
1802.8.5
by Monty Taylor
Document drizzled options. |
236 |
|
237 |
.. option:: --max-sort-length arg (=1024) |
|
238 |
||
2194.5.3
by Andrew Hutchings
Markup fixes |
239 |
The number of bytes to use when sorting BLOB or TEXT values (only the first |
240 |
max_sort_length bytes of each value are used; the rest are ignored). |
|
1802.8.5
by Monty Taylor
Document drizzled options. |
241 |
|
242 |
.. option:: --max-write-lock-count arg (=18446744073709551615) |
|
243 |
||
2194.5.3
by Andrew Hutchings
Markup fixes |
244 |
After this many write locks, allow some read locks to run in between. |
1802.8.5
by Monty Taylor
Document drizzled options. |
245 |
|
246 |
.. option:: --min-examined-row-limit arg (=0) |
|
247 |
||
2194.5.3
by Andrew Hutchings
Markup fixes |
248 |
Don't log queries which examine less than min_examined_row_limit rows to |
249 |
file. |
|
1802.8.5
by Monty Taylor
Document drizzled options. |
250 |
|
251 |
.. option:: --disable-optimizer-prune |
|
252 |
||
2194.5.3
by Andrew Hutchings
Markup fixes |
253 |
Do not apply any heuristic(s) during query optimization to prune, thus |
254 |
perform an exhaustive search from the optimizer search space. |
|
1802.8.5
by Monty Taylor
Document drizzled options. |
255 |
|
256 |
.. option:: --optimizer-search-depth arg (=0) |
|
257 |
||
2194.5.3
by Andrew Hutchings
Markup fixes |
258 |
Maximum depth of search performed by the query optimizer. Values larger than |
259 |
the number of relations in a query result in better query plans, but take |
|
260 |
longer to compile a query. Smaller values than the number of tables in a |
|
261 |
relation result in faster optimization, but may produce very bad query plans. |
|
262 |
If set to 0, the system will automatically pick a reasonable value; if set to |
|
263 |
MAX_TABLES+2, the optimizer will switch to the original find_best (used for |
|
264 |
testing/comparison). |
|
1802.8.5
by Monty Taylor
Document drizzled options. |
265 |
|
266 |
.. option:: --preload-buffer-size arg (=32768) |
|
267 |
||
2194.5.3
by Andrew Hutchings
Markup fixes |
268 |
The size of the buffer that is allocated when preloading indexes |
1802.8.5
by Monty Taylor
Document drizzled options. |
269 |
|
270 |
.. option:: --query-alloc-block-size arg (=8192) |
|
271 |
||
2194.5.3
by Andrew Hutchings
Markup fixes |
272 |
Allocation block size for query parsing and execution |
1802.8.5
by Monty Taylor
Document drizzled options. |
273 |
|
274 |
.. option:: --query-prealloc-size arg (=8192) |
|
275 |
||
2194.5.3
by Andrew Hutchings
Markup fixes |
276 |
Persistent buffer for query parsing and execution |
1802.8.5
by Monty Taylor
Document drizzled options. |
277 |
|
278 |
.. option:: --range-alloc-block-size arg (=4096) |
|
279 |
||
2194.5.3
by Andrew Hutchings
Markup fixes |
280 |
Allocation block size for storing ranges during optimization |
1802.8.5
by Monty Taylor
Document drizzled options. |
281 |
|
282 |
.. option:: --read-buffer-size arg (=131072) |
|
283 |
||
2194.5.3
by Andrew Hutchings
Markup fixes |
284 |
Each thread that does a sequential scan allocates a buffer of this size for |
285 |
each table it scans. If you do many sequential scans, you may want to |
|
286 |
increase this value. Note that this only affect MyISAM. |
|
1802.8.5
by Monty Taylor
Document drizzled options. |
287 |
|
1796.4.14
by Andrew Hutchings
Document new options (also fix another option in documentation) |
288 |
.. option:: --read-buffer-constraint arg (=0) |
289 |
||
2194.5.3
by Andrew Hutchings
Markup fixes |
290 |
A global constraint for read-buffer-size for all clients, cannot be set lower |
291 |
than --read-buffer-size. Setting to 0 means unlimited. |
|
1796.4.14
by Andrew Hutchings
Document new options (also fix another option in documentation) |
292 |
|
1802.8.5
by Monty Taylor
Document drizzled options. |
293 |
.. option:: --read-rnd-buffer-size arg (=262144) |
294 |
||
2194.5.3
by Andrew Hutchings
Markup fixes |
295 |
When reading rows in sorted order after a sort, the rows are read through |
296 |
this buffer to avoid a disk seeks. If not set, then it's set to the value of |
|
297 |
record_buffer. |
|
1802.8.5
by Monty Taylor
Document drizzled options. |
298 |
|
1796.4.14
by Andrew Hutchings
Document new options (also fix another option in documentation) |
299 |
.. option:: --read-rnd-constraint arg (=0) |
300 |
||
2194.5.3
by Andrew Hutchings
Markup fixes |
301 |
A global constraint for read-rnd-buffer-size for all clients, cannot be set |
302 |
lower than --read-rnd-buffer-size. Setting to 0 means unlimited. |
|
1796.4.14
by Andrew Hutchings
Document new options (also fix another option in documentation) |
303 |
|
1802.8.5
by Monty Taylor
Document drizzled options. |
304 |
.. option:: --scheduler arg (=multi-thread) |
305 |
||
2194.5.3
by Andrew Hutchings
Markup fixes |
306 |
Select scheduler to be used. |
1802.8.5
by Monty Taylor
Document drizzled options. |
307 |
|
308 |
.. option:: --sort-buffer-size arg (=2097144) |
|
309 |
||
2194.5.3
by Andrew Hutchings
Markup fixes |
310 |
Each thread that needs to do a sort allocates a buffer of this size. |
1802.8.5
by Monty Taylor
Document drizzled options. |
311 |
|
1796.4.14
by Andrew Hutchings
Document new options (also fix another option in documentation) |
312 |
.. option:: --sort-buffer-constraint arg (=0) |
313 |
||
2194.5.3
by Andrew Hutchings
Markup fixes |
314 |
A global constraint for sort-buffer-size for all clients, cannot be set lower |
315 |
than --sort-buffer-size. Setting to 0 means unlimited. |
|
1796.4.14
by Andrew Hutchings
Document new options (also fix another option in documentation) |
316 |
|
1802.8.5
by Monty Taylor
Document drizzled options. |
317 |
.. option:: --table-definition-cache arg (=128) |
318 |
||
2194.5.3
by Andrew Hutchings
Markup fixes |
319 |
The number of cached table definitions. |
1802.8.5
by Monty Taylor
Document drizzled options. |
320 |
|
321 |
.. option:: --table-open-cache arg (=1024) |
|
322 |
||
2194.5.3
by Andrew Hutchings
Markup fixes |
323 |
The number of cached open tables. |
1802.8.5
by Monty Taylor
Document drizzled options. |
324 |
|
325 |
.. option:: --table-lock-wait-timeout arg (=50) |
|
326 |
||
2194.5.3
by Andrew Hutchings
Markup fixes |
327 |
Timeout in seconds to wait for a table level lock before returning an error. |
328 |
Used only if the connection has active cursors. |
|
1802.8.5
by Monty Taylor
Document drizzled options. |
329 |
|
330 |
.. option:: --thread-stack arg (=0) |
|
331 |
||
2194.5.3
by Andrew Hutchings
Markup fixes |
332 |
The stack size for each thread. 0 means use OS default. |
1802.8.5
by Monty Taylor
Document drizzled options. |
333 |
|
334 |
.. option:: --tmp-table-size arg (=16M) |
|
335 |
||
2194.5.3
by Andrew Hutchings
Markup fixes |
336 |
If an internal in-memory temporary table exceeds this size, Drizzle will |
337 |
automatically convert it to an on-disk MyISAM table. |
|
1802.8.4
by Monty Taylor
Removed old language arg. |
338 |