~drizzle-trunk/drizzle/development

« back to all changes in this revision

Viewing changes to docs/options.rst

  • Committer: Mark Atwood
  • Date: 2011-08-12 04:08:33 UTC
  • mfrom: (2385.2.17 refactor5)
  • Revision ID: me@mark.atwood.name-20110812040833-u6j85nc6ahuc0dtz
mergeĀ lp:~olafvdspek/drizzle/refactor5

Show diffs side-by-side

added added

removed removed

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