← Back to branch summary

~drizzle-trunk/drizzle/development

« back to all changes in this revision

Viewing changes to docs/options.rst

  • Committer: Monty Taylor
  • Date: 2010-09-29 17:10:26 UTC
  • mto: (1802.9.1 clean-doco)
  • mto: This revision was merged to the branch mainline in revision 1813.
  • Revision ID: mordred@inaugust.com-20100929171026-v3ps2fe0j70dvs1l
Document drizzled options.

Show diffs side-by-side

added added

removed removed

Lines of Context:
docs/options.rst
24
24
.. option:: --plugin-dir arg
25
25
  Directory for plugins
26
26
 
 
27
.. option:: --pid-file arg
 
28
 
 
29
  Pid file used by drizzled.
 
30
 
27
31
Plugin Loading Options
28
32
----------------------
29
33
 
94
98
 
95
99
  Used for debugging;  Use at your own risk!
96
100
 
97
 
  --gdb                                 Set up signals usable for debugging
98
 
  -L [ --language ] arg                 (IGNORED)
99
 
  --lc-time-name arg                    Set the language used for the month 
100
 
                                        names and the days of the week.
101
 
  -W [ --log-warnings ] arg             Log some not critical warnings to the 
102
 
                                        log file.
103
 
  --pid-file arg                        Pid file used by drizzled.
104
 
  --port-open-timeout arg (=0)          Maximum time in seconds to wait for the
105
 
                                        port to become free. (Default: no wait)
106
 
  --secure-file-priv arg                Limit LOAD DATA, SELECT ... OUTFILE, 
107
 
                                        and LOAD_FILE() to files within 
108
 
                                        specified directory
109
 
  --server-id arg (=0)                  Uniquely identifies the server instance
110
 
                                        in the community of replication 
111
 
                                        partners.
112
 
  --skip-stack-trace                    Don't print a stack trace on failure.
113
 
  -s [ --symbolic-links ]               Enable symbolic link support.
114
 
  --timed-mutexes                       Specify whether to time mutexes (only 
115
 
                                        InnoDB mutexes are currently supported)
116
 
  -t [ --tmpdir ] arg                   Path for temporary files.
117
 
  --transaction-isolation arg           Default transaction isolation level.
118
 
  -u [ --user ] arg                     Run drizzled daemon as user.
119
 
  -V [ --version ]                      Output version information and exit.
120
 
  --back-log arg (=50)                  The number of outstanding connection 
121
 
                                        requests Drizzle can have. This comes 
122
 
                                        into play when the main Drizzle thread 
123
 
                                        gets very many connection requests in a
124
 
                                        very short time.
125
 
  --bulk-insert-buffer-size arg (=8388608)
126
 
                                        Size of tree cache used in bulk insert 
127
 
                                        optimization. Note that this is a limit
128
 
                                        per thread!
129
 
  --div-precision-increment arg (=4)    Precision of the result of '/' operator
130
 
                                        will be increased on that value.
131
 
  --group-concat-max-len arg (=1024)    The maximum length of the result of 
132
 
                                        function  group_concat.
133
 
  --join-buffer-size arg (=131072)      The size of the buffer that is used for
134
 
                                        full joins.
135
 
  --max-allowed-packet arg (=1048576)   Max packetlength to send/receive from 
136
 
                                        to server.
137
 
  --max-connect-errors arg (=10)        If there is more than this number of 
138
 
                                        interrupted connections from a host 
139
 
                                        this host will be blocked from further 
140
 
                                        connections.
141
 
  --max-error-count arg (=64)           Max number of errors/warnings to store 
142
 
                                        for a statement.
143
 
  --max-heap-table-size arg (=16777216) Don't allow creation of heap tables 
144
 
                                        bigger than this.
145
 
  --max-join-size arg (=2147483647)     Joins that are probably going to read 
146
 
                                        more than max_join_size records return 
147
 
                                        an error.
148
 
  --max-length-for-sort-data arg (=1024)
149
 
                                        Max number of bytes in sorted records.
150
 
  --max-seeks-for-key arg (=18446744073709551615)
151
 
                                        Limit assumed max number of seeks when 
152
 
                                        looking up rows based on a key
153
 
  --max-sort-length arg (=1024)         The number of bytes to use when sorting
154
 
                                        BLOB or TEXT values (only the first 
155
 
                                        max_sort_length bytes of each value are
156
 
                                        used; the rest are ignored).
157
 
  --max-write-lock-count arg (=18446744073709551615)
158
 
                                        After this many write locks, allow some
159
 
                                        read locks to run in between.
160
 
  --min-examined-row-limit arg (=0)     Don't log queries which examine less 
161
 
                                        than min_examined_row_limit rows to 
162
 
                                        file.
163
 
  --disable-optimizer-prune             Do not apply any heuristic(s) during 
164
 
                                        query optimization to prune, thus 
165
 
                                        perform an exhaustive search from the 
166
 
                                        optimizer search space.
167
 
  --optimizer-search-depth arg (=0)     Maximum depth of search performed by 
168
 
                                        the query optimizer. Values larger than
169
 
                                        the number of relations in a query 
170
 
                                        result in better query plans, but take 
171
 
                                        longer to compile a query. Smaller 
172
 
                                        values than the number of tables in a 
173
 
                                        relation result in faster optimization,
174
 
                                        but may produce very bad query plans. 
175
 
                                        If set to 0, the system will 
176
 
                                        automatically pick a reasonable value; 
177
 
                                        if set to MAX_TABLES+2, the optimizer 
178
 
                                        will switch to the original find_best 
179
 
                                        (used for testing/comparison).
180
 
  --preload-buffer-size arg (=32768)    The size of the buffer that is 
181
 
                                        allocated when preloading indexes
182
 
  --query-alloc-block-size arg (=8192)  Allocation block size for query parsing
183
 
                                        and execution
184
 
  --query-prealloc-size arg (=8192)     Persistent buffer for query parsing and
185
 
                                        execution
186
 
  --range-alloc-block-size arg (=4096)  Allocation block size for storing 
187
 
                                        ranges during optimization
188
 
  --read-buffer-size arg (=131072)      Each thread that does a sequential scan
189
 
                                        allocates a buffer of this size for 
190
 
                                        each table it scans. If you do many 
191
 
                                        sequential scans, you may want to 
192
 
                                        increase this value.
193
 
  --read-rnd-buffer-size arg (=262144)  When reading rows in sorted order after
194
 
                                        a sort, the rows are read through this 
195
 
                                        buffer to avoid a disk seeks. If not 
196
 
                                        set, then it's set to the value of 
197
 
                                        record_buffer.
198
 
  --scheduler arg                       Select scheduler to be used (by default
199
 
                                        multi-thread).
200
 
  --sort-buffer-size arg (=2097144)     Each thread that needs to do a sort 
201
 
                                        allocates a buffer of this size.
202
 
  --table-definition-cache arg (=128)   The number of cached table definitions.
203
 
  --table-open-cache arg (=1024)        The number of cached open tables.
204
 
  --table-lock-wait-timeout arg (=50)   Timeout in seconds to wait for a table 
205
 
                                        level lock before returning an error. 
206
 
                                        Used only if the connection has active 
207
 
                                        cursors.
208
 
  --thread-stack arg (=0)               The stack size for each thread.
209
 
  --tmp-table-size arg (=16777216)      If an internal in-memory temporary 
210
 
                                        table exceeds this size, Drizzle will 
211
 
                                        automatically convert it to an on-disk 
212
 
                                        MyISAM table.
 
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.
213
297