~drizzle-trunk/drizzle/development

« back to all changes in this revision

Viewing changes to docs/options.rst

  • Committer: Monty Taylor
  • Date: 2010-09-29 16:49:08 UTC
  • mto: (1802.9.1 clean-doco)
  • mto: This revision was merged to the branch mainline in revision 1813.
  • Revision ID: mordred@inaugust.com-20100929164908-l6k68hzeo39m1fbh
Removed old language arg.

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
Plugin Loading Options
 
28
----------------------
 
29
 
 
30
.. option:: --plugin-add arg
 
31
  Optional comma separated list of plugins to load at startup in addition
 
32
  to the default list of plugins.
 
33
  
 
34
  for example: --plugin_add=crc32,console,pbxt
 
35
 
 
36
.. option:: --plugin-remove arg
 
37
  Optional comma separated list of plugins to not load at startup.
 
38
  Effectively removes a plugin from the list of plugins to be loaded.
 
39
 
 
40
  for example: --plugin_remove=syslog,md5
 
41
 
 
42
.. 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,)
 
43
 
 
44
  Optional comma separated list of plugins to load at starup instead of 
 
45
  the default plugin load list. This completely replaces the whole list.
 
46
 
7
47
Kernel Options
8
48
--------------
 
49
 
 
50
.. option:: --auto-increment-increment arg (=1)
 
51
  
 
52
  Auto-increment columns are incremented by this
 
53
 
 
54
.. option:: --auto-increment-offset arg (=1)
 
55
 
 
56
  Offset added to Auto-increment columns.
 
57
  Used when auto-increment-increment != 1
 
58
 
 
59
.. option:: -b,--basedir arg
 
60
 
 
61
  Path to installation directory.
 
62
  All paths are usually resolved relative to this.
 
63
 
 
64
.. option:: -r,--chroot arg
 
65
 
 
66
  Chroot drizzled daemon during startup.
 
67
 
 
68
.. option:: --collation-server arg
 
69
 
 
70
  Set the default collation.
 
71
 
 
72
.. option:: --completion-type arg (=0)
 
73
 
 
74
  Default completion type.
 
75
 
 
76
.. option:: --core-file
 
77
 
 
78
  Write core on errors.
 
79
 
 
80
.. option:: --datadir arg
 
81
 
 
82
  Path to the database root.
 
83
 
 
84
.. option:: --default-storage-engine arg
 
85
 
 
86
  Set the default storage engine for tables.
 
87
 
 
88
.. option:: --default-time-zone arg
 
89
 
 
90
  Set the default time zone.
 
91
 
 
92
.. We should really remove --exit-info as an option
 
93
.. option:: -T,--exit-info arg
 
94
 
 
95
  Used for debugging;  Use at your own risk!
 
96
 
 
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.
 
213