~drizzle-trunk/drizzle/development

« back to all changes in this revision

Viewing changes to docs/configuration/values.rst

  • Committer: Daniel Nichter
  • Date: 2011-10-02 06:29:23 UTC
  • mto: This revision was merged to the branch mainline in revision 2448.
  • Revision ID: daniel@percona.com-20111002062923-kqkyj396c0d8hj5o
Rewrite Configuration docs.

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
.. program:: drizzled
 
2
 
 
3
.. _configuration_values:
 
4
 
 
5
Values
 
6
======
 
7
 
 
8
All :ref:`configuration_options` and :ref:`configuration_variables` have
 
9
values (NULL values are not allowed), and all values have a generic
 
10
type.  Value types are similar to, but simpler than, the SQL language
 
11
:doc:`/data_types`.
 
12
 
 
13
Currently, options' value types are not documented, but most options clearly
 
14
imply their value type.
 
15
 
 
16
Value Types
 
17
-----------
 
18
 
 
19
Numeric
 
20
^^^^^^^
 
21
 
 
22
Numeric values are positive or negative integers.  Some numeric values
 
23
are constrained, which means that the value must be within a specific
 
24
range.  Currently, constraints are not documented, but
 
25
:ref:`setting a variable <setting_variables>` out-of-range will cause
 
26
an error.
 
27
 
 
28
String
 
29
^^^^^^
 
30
 
 
31
String values are any kind of quoted strings.  Since NULL values are
 
32
not allowed, empty strings are sometimes used to mean "no value" or
 
33
"undefined".
 
34
 
 
35
Boolean
 
36
^^^^^^^
 
37
 
 
38
When :ref:`setting a variable <setting_variables>`, boolean values are
 
39
one of the various true and false values listed for the
 
40
:doc:`/boolean_data_type`.  When setting a :ref:`boolean_options`,
 
41
no value is need or allowed.
 
42
 
 
43
Size
 
44
^^^^
 
45
 
 
46
Size values are like numeric values but allow optional size suffixes:
 
47
K, M, and G.  The size value ``1k`` is equivalent to the numeric value
 
48
``1024``.  Size values are shown as their equivalent numeric values
 
49
when you :ref:`query the variables <querying_variables>`.
 
50
 
 
51
.. note:: Only :ref:`configuration_options` can use size values.  :ref:`configuration_variables` must use numeric values.
 
52
 
 
53
Path
 
54
^^^^
 
55
 
 
56
Path values that are not absolute are prefixed with a path in the
 
57
Drizzle installation directory.  For example, if :option:`--pid-file`
 
58
is set to :file:`drizzled.pid`, Drizzle prefixes that value with
 
59
the :option:`--datadir` value, resulting in a value like
 
60
:file:`/opt/drizzle/data/drizzled.pid`.
 
61
 
 
62
Default Values
 
63
--------------
 
64
 
 
65
If an option has a default value, ``drizzled --help`` gives it in parentheses
 
66
after ``arg``, like ``(=drizzled-queries.log)``.  The relevant documentation
 
67
for an option should also list its default value, if any.