← Back to branch summary

~drizzle-trunk/drizzle/development

« back to all changes in this revision

Viewing changes to docs/configuration.rst

  • Committer: Brian Aker
  • Date: 2010-10-08 16:11:47 UTC
  • mto: This revision was merged to the branch mainline in revision 1834.
  • Revision ID: brian@tangent.org-20101008161147-o3us2a8itszsaycx
Typdef our lock type.

Show diffs side-by-side

added added

removed removed

Lines of Context:
docs/configuration.rst
 
1
=============
 
2
Configuration
 
3
=============
 
4
 
 
5
--------
 
6
Overview
 
7
--------
 
8
 
 
9
Drizzle can draw its configuration from a number of sources, including the
 
10
command line, configuration files and environment variables.
 
11
 
 
12
Support is planned for pluggable configuration souces.
 
13
 
 
14
----------------
 
15
Loading Sequence
 
16
----------------
 
17
 
 
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
 
31
option value.  See :ref:`options` for all options that :program:`drizzled`
 
32
supports.
 
33
 
 
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
 
41
per line. Due to a bug in Boost.Program_options Boolean values require an argument, e.g. `console.enable=true`.
 
42
 
 
43
Config files support section headers such as `[innodb]` with all options
 
44
occuring subsequently being prefixed by the section header. For instance, if
 
45
one were do give::
 
46
 
 
47
  [innodb]
 
48
  buffer_pool_size=10M
 
49
  log_file_size=5M
 
50
 
 
51
It would be the same as::
 
52
 
 
53
  innodb.buffer_pool_size=10M
 
54
  innodb.log_file_size
 
55