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