~drizzle-trunk/drizzle/development

« back to all changes in this revision

Viewing changes to docs/options.rst

  • Committer: Brian Aker
  • Date: 2009-02-10 00:14:40 UTC
  • Revision ID: brian@tangent.org-20090210001440-qjg8eofh3h93064b
Adding Multi-threaded Scheduler into the system.

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
.. _options:
2
 
 
3
 
Drizzled Options
4
 
================
5
 
 
6
 
There are many different options one can use to configure Drizzle.
7
 
 
8
 
Config File Options
9
 
-------------------
10
 
 
11
 
.. option:: --help-extended
12
 
  Display this help and exit after initializing plugins.
13
 
 
14
 
.. option:: -?,--help
15
 
  Display this help and exit.
16
 
 
17
 
.. option:: --no-defaults
18
 
  Configuration file defaults are not used if no-defaults is set
19
 
 
20
 
.. option:: --defaults-file arg
21
 
  Configuration file to use
22
 
 
23
 
.. option:: --config-dir arg (=/etc/drizzle)
24
 
  Base location for config files
25
 
 
26
 
.. option:: --plugin-dir arg
27
 
  Directory for plugins
28
 
 
29
 
.. option:: --pid-file arg
30
 
 
31
 
  Pid file used by drizzled.
32
 
 
33
 
Plugin Loading Options
34
 
----------------------
35
 
 
36
 
.. option:: --plugin-add arg
37
 
  Optional comma separated list of plugins to load at startup in addition
38
 
  to the default list of plugins.
39
 
  
40
 
  for example: --plugin_add=crc32,console,pbxt
41
 
 
42
 
.. 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.
52
 
 
53
 
Kernel Options
54
 
--------------
55
 
 
56
 
.. option:: --auto-increment-increment arg (=1)
57
 
  
58
 
  Auto-increment columns are incremented by this
59
 
 
60
 
.. option:: --auto-increment-offset arg (=1)
61
 
 
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.
73
 
 
74
 
.. option:: --collation-server arg
75
 
 
76
 
  Set the default collation.
77
 
 
78
 
.. option:: --completion-type arg (=0)
79
 
 
80
 
  Default completion type.
81
 
 
82
 
.. option:: --core-file
83
 
 
84
 
  Write core on errors.
85
 
 
86
 
.. option:: --datadir arg
87
 
 
88
 
  Path to the database root.
89
 
 
90
 
.. option:: --default-storage-engine arg
91
 
 
92
 
  Set the default storage engine for tables.
93
 
 
94
 
.. option:: --default-time-zone arg
95
 
 
96
 
  Set the default time zone.
97
 
 
98
 
.. We should really remove --exit-info as an option
99
 
.. option:: -T,--exit-info arg
100
 
 
101
 
  Used for debugging;  Use at your own risk!
102
 
 
103
 
.. option:: --gdb
104
 
 
105
 
  Set up signals usable for debugging
106
 
 
107
 
.. option:: --lc-time-name arg
108
 
 
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.
114
 
 
115
 
.. Why is this a core argument?
116
 
.. option:: --port-open-timeout arg (=0)
117
 
 
118
 
  Maximum time in seconds to wait for the port to become free.
119
 
  A value of 0 means not to wait.
120
 
 
121
 
.. option:: --secure-file-priv arg
122
 
 
123
 
  Limit LOAD DATA, SELECT ... OUTFILE, and LOAD_FILE() to files within
124
 
  specified directory
125
 
 
126
 
.. Why is this still here?
127
 
.. option:: --server-id arg (=0)
128
 
 
129
 
  Uniquely identifies the server instance in the community of replication
130
 
  partners.
131
 
 
132
 
.. option:: --skip-stack-trace
133
 
 
134
 
  Don't print a stack trace on failure.
135
 
 
136
 
.. option:: -s,--symbolic-links
137
 
 
138
 
  Enable symbolic link support.
139
 
 
140
 
.. option:: --timed-mutexes
141
 
 
142
 
  Specify whether to time mutexes (only InnoDB mutexes are currently supported)
143
 
 
144
 
.. option::  -t,--tmpdir arg
145
 
 
146
 
  Path for temporary files.
147
 
 
148
 
.. option:: --transaction-isolation arg
149
 
 
150
 
  Default transaction isolation level.
151
 
 
152
 
.. option:: -u,--user arg
153
 
 
154
 
  Run drizzled daemon as user.
155
 
  
156
 
.. option:: -V,--version
157
 
 
158
 
  Output version information and exit.
159
 
 
160
 
.. option:: --back-log arg (=50)
161
 
 
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.
165
 
 
166
 
.. option:: --bulk-insert-buffer-size arg (=8388608)
167
 
  
168
 
  Size of tree cache used in bulk insert optimization. Note that this is a limit
169
 
  per thread!
170
 
 
171
 
.. option:: --div-precision-increment arg (=4)
172
 
  
173
 
  Precision of the result of '/' operator will be increased on that value.
174
 
 
175
 
.. option:: --group-concat-max-len arg (=1024)
176
 
 
177
 
  The maximum length of the result of function  group_concat.
178
 
 
179
 
.. option:: --join-buffer-size arg (=131072)
180
 
 
181
 
  The size of the buffer that is used for full joins.
182
 
 
183
 
.. option:: --join-buffer-constraint arg (=0)
184
 
 
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.
187
 
 
188
 
.. Why is this a core arg?
189
 
.. option:: --max-allowed-packet arg (=64M)
190
 
 
191
 
  Max packetlength to send/receive from to server.
192
 
 
193
 
.. option:: --max-connect-errors arg (=10)
194
 
 
195
 
  If there is more than this number of interrupted connections from a host 
196
 
  this host will be blocked from further connections.
197
 
 
198
 
.. option:: --max-error-count arg (=64)
199
 
 
200
 
  Max number of errors/warnings to store for a statement.
201
 
 
202
 
.. option:: --max-heap-table-size arg (=16M)
203
 
 
204
 
  Don't allow creation of heap tables bigger than this.
205
 
 
206
 
.. option:: --max-join-size arg (=2147483647)
207
 
 
208
 
  Joins that are probably going to read more than max_join_size records return 
209
 
  an error.
210
 
 
211
 
.. option:: --max-length-for-sort-data arg (=1024)
212
 
 
213
 
  Max number of bytes in sorted records.
214
 
  
215
 
.. option:: --max-seeks-for-key arg (=18446744073709551615)
216
 
 
217
 
  Limit assumed max number of seeks when looking up rows based on a key
218
 
 
219
 
.. option:: --max-sort-length arg (=1024)
220
 
 
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).
223
 
 
224
 
.. option:: --max-write-lock-count arg (=18446744073709551615)
225
 
 
226
 
  After this many write locks, allow some read locks to run in between.
227
 
 
228
 
.. option:: --min-examined-row-limit arg (=0)
229
 
 
230
 
  Don't log queries which examine less than min_examined_row_limit rows to file.
231
 
 
232
 
.. option:: --disable-optimizer-prune
233
 
 
234
 
  Do not apply any heuristic(s) during query optimization to prune, thus
235
 
  perform an exhaustive search from the optimizer search space.
236
 
 
237
 
.. option:: --optimizer-search-depth arg (=0)
238
 
 
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).
246
 
 
247
 
.. option:: --preload-buffer-size arg (=32768)
248
 
 
249
 
  The size of the buffer that is allocated when preloading indexes
250
 
 
251
 
.. option:: --query-alloc-block-size arg (=8192)
252
 
 
253
 
  Allocation block size for query parsing and execution
254
 
 
255
 
.. option:: --query-prealloc-size arg (=8192)
256
 
 
257
 
  Persistent buffer for query parsing and execution
258
 
 
259
 
.. option:: --range-alloc-block-size arg (=4096)
260
 
 
261
 
  Allocation block size for storing ranges during optimization
262
 
 
263
 
.. option:: --read-buffer-size arg (=131072)
264
 
 
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.
268
 
 
269
 
.. option:: --read-buffer-constraint arg (=0)
270
 
 
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.
273
 
 
274
 
.. option:: --read-rnd-buffer-size arg (=262144)
275
 
 
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.
279
 
 
280
 
.. option:: --read-rnd-constraint arg (=0)
281
 
 
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.
284
 
 
285
 
.. option:: --scheduler arg (=multi-thread)
286
 
 
287
 
  Select scheduler to be used.
288
 
 
289
 
.. option:: --sort-buffer-size arg (=2097144)
290
 
 
291
 
  Each thread that needs to do a sort allocates a buffer of this size.
292
 
 
293
 
.. option:: --sort-buffer-constraint arg (=0)
294
 
 
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.
297
 
 
298
 
.. option:: --table-definition-cache arg (=128)
299
 
 
300
 
  The number of cached table definitions.
301
 
 
302
 
.. option:: --table-open-cache arg (=1024)
303
 
 
304
 
  The number of cached open tables.
305
 
 
306
 
.. option:: --table-lock-wait-timeout arg (=50)
307
 
 
308
 
  Timeout in seconds to wait for a table level lock before returning an error.
309
 
  Used only if the connection has active cursors.
310
 
 
311
 
.. option:: --thread-stack arg (=0)
312
 
 
313
 
  The stack size for each thread. 0 means use OS default.
314
 
 
315
 
.. option:: --tmp-table-size arg (=16M)
316
 
 
317
 
  If an internal in-memory temporary table exceeds this size, Drizzle will
318
 
  automatically convert it to an on-disk MyISAM table.
319