~drizzle-trunk/drizzle/development

« back to all changes in this revision

Viewing changes to docs/options.rst

  • Committer: Lee Bieber
  • Date: 2011-02-24 03:20:47 UTC
  • mfrom: (2196.1.4 build)
  • Revision ID: kalebral@gmail.com-20110224032047-avmw06iwww3m73cw
Merge Andrew - 723653: Docs day first pass fixes 
Merge Brian - Puts back in support for COM_KILL, Also adds back in the INTERACTIVE flag, and creates a DD to track sessions/check on usage
Merge Olaf - Use List::size()

Show diffs side-by-side

added added

removed removed

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