~drizzle-trunk/drizzle/development

1794.2.3 by Monty Taylor
Added stubs for option docs.
1
=============
2
Configuration
3
=============
4
5
--------
6
Overview
7
--------
8
9
Drizzle can draw its configuration from a number of sources, including the
2222.2.1 by Mark Atwood
documentation work
10
command line, from configuration files, and from environment variables.
1794.2.3 by Monty Taylor
Added stubs for option docs.
11
1994.4.109 by Marisa Plumb
slave plugin docs
12
Support is planned for pluggable configuration sources.
1794.2.3 by Monty Taylor
Added stubs for option docs.
13
14
----------------
15
Loading Sequence
16
----------------
17
1794.2.4 by Monty Taylor
Expanded on config rules.
18
Drizzle first reads the command line options dealing with config file
19
location. These options may only be given as command line options.
20
Then, the config files are parsed, for all options. After that,
21
environment variables are processed, and any value given in them will
22
override values input from the config files. Finally, values on the command
23
line will be processed and any options given here take final precedence.
24
25
----------------
26
Format and Rules
27
----------------
28
29
Command line options are of the form `--option-name=value`. There are some
30
boolean flags, such as `--help` which do not require (nor can accept) an
1799.3.2 by Monty Taylor
Use drizzledump sphinx docs as manpage source.
31
option value.  See :ref:`options` for all options that :program:`drizzled`
1794.2.5 by Monty Taylor
Added support to pandora for finding and including per-plugin documentation.
32
supports.
33
1794.2.4 by Monty Taylor
Expanded on config rules.
34
Environment variables are the same as the command line options, except that
35
the variable name is prefixed with *DRIZZLED_*, in all caps and all `.` and
36
`-` are turned into underscores. So the option
37
`--innodb.buffer_pool_size=10` could be given in the environment variable
38
*DRIZZLED_INNODB_BUFFER_POOL_SIZE*
39
40
The config files contain a set of lines of the form `option-name=value`, one
2222.2.1 by Mark Atwood
documentation work
41
per line. Due to a bug in Boost.Program_options Boolean values require an argument,
42
e.g. `console.enable=true`.
1794.2.4 by Monty Taylor
Expanded on config rules.
43
44
Config files support section headers such as `[innodb]` with all options
45
occuring subsequently being prefixed by the section header. For instance, if
2194.5.3 by Andrew Hutchings
Markup fixes
46
one were do give:
47
48
.. code-block:: ini
1794.2.4 by Monty Taylor
Expanded on config rules.
49
50
  [innodb]
51
  buffer_pool_size=10M
52
  log_file_size=5M
53
2194.5.3 by Andrew Hutchings
Markup fixes
54
It would be the same as:
55
56
.. code-block:: ini
1794.2.4 by Monty Taylor
Expanded on config rules.
57
58
  innodb.buffer_pool_size=10M
59
  innodb.log_file_size
60