~drizzle-trunk/drizzle/development

« back to all changes in this revision

Viewing changes to docs/options.rst

Merged up with trunk.

Show diffs side-by-side

added added

removed removed

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