"Fossies" - the Fresh Open Source Software Archive

Member "drizzle-7.1.36-stable/docs/configuration/options.rst" (6 May 2012, 6218 Bytes) of package /linux/misc/old/drizzle-7.1.36-stable.tar.gz:


As a special service "Fossies" has tried to format the requested source page into HTML format (assuming markdown format). Alternatively you can here view or download the uninterpreted source code file. A member file download can also be achieved by clicking within a package contents listing on the according byte size field.

drizzled

Options

Options configure Drizzle at startup. When drizzled starts, it reads option values from three sources in this order:

  1. Default values
  2. config_files
  3. command_line_options

Values from command_line_options have the highest precedence; they override values from config_files which override the defaul values. The default values alone are sufficient to start drizzled, but since they provide only the most basic configuration, you will certainly want to specify other options.

To see which options are available, run drizzled --help. You can also see which options a plugin provides by running drizzled --plugin-add PLUGIN --help where PLUGIN is the name of any plugin. For example:

$ drizzled --plugin-add query_log --help
sbin/drizzled  Ver 2011.08.25.2411 for pc-linux-gnu on i686 (Source distribution (trunk))
Copyright (C) 2010-2011 Drizzle Developers, Copyright (C) 2008 Sun Microsystems
This software comes with ABSOLUTELY NO WARRANTY. This is free software,
and you are welcome to modify and redistribute it under the GPL license

...

Options used by query_log:
  --query-log.file-enabled                      Enable query logging to file
  --query-log.file arg (=drizzled-queries.log)  Query log file
  --query-log.threshold-execution-time arg (=0) Threshold for logging slow 
                                                queries, in microseconds

Options listed by --help can be used as command_line_options. To use them in config_files, strip the leading --.

Note

Since Drizzle uses many plugins, the available options vary depending on which plugins are loaded. If you cannnot find a certain option, ensure that the plugin which provides the option is loaded.

Setting Options

Options are read from one or more of the following sources. Each source is optional.

Config Files

Config files contain these types of lines:

# comment
option-name=value
plugin-name.plugin-option-name=value
[plugin-name]
plugin-option-name=value

Blank lines are allowed, and spaces before and after = are allowed.

The second type of line, option-name=value, specifies drizzled_options which add and remove plugins and configure the kernel.

The third type of line, plugin-name.plugin-option-name=value, specifies an option specific to a plugin. Drizzle loads many plugins by default, so many options use this type. If plugins have the same plugin-option-name, they are distinguished by different plugin-name. prefixes. For example:

drizzle-protocol.port=4427
mysql-protocol.port=3306

Those options are not the same. The first sets the Drizzle network protocol port, and the second sets the MySQL network protocol port.

The fourth type of line, [plugin-name], is a header that specifies a plugin name to prefix to all the option names that follow. The previous example is equivalent to this:

[drizzle-protocol]
port=4427

[mysql-protocol]
port=3306

Once a header is declared, it remains in affect until another header is declared, and the plugin name is prefixed to every option that follows, so you cannot override the header plugin name by specifying a different plugin name like this:

[drizzle-protocol]
port=4427
mysql-protocol.port=3306  # WRONG

That config file is wrong and it will cause an error when Drizzle starts like "unknown option drizzle-protocol.mysql-protocol.port".

Since the drizzled_options are not part of a plugin, they cannot be specified after any header. Therefore, you should specify all drizzled_options at the start of the config file, or in a separate config file by using multiple_config_files.

Command Line Options

Command line options have the form --option-name=value (the = is optional). This form works for drizzled options <drizzled_options> and all plugin options. For example:

drizzled --basedir=/opt/drizzle --innodb.buffer-pool-size=500M

Multiple Config Files

The command line option --defaults-file specifies one config file, but --config-dir specifies a directory which can contain multiple config files. If a file named drizzled.cnf exists in the config dir, it is read first. If the config dir contains a directory called conf.d, then every file in that directory is read as a config file. (Even hidden files are read, including hidden temp files created by your editor while editing config files in this directory.)

A good strategy for configuring Drizzle with multiple config files is to put general drizzled_options in /etc/drizzle/drizzled.cnf (/etc/drizzle is the default --config-dir value) and any options related to a plugin in a separate config file in /etc/drizzle/conf.d/. For example:

$ ls /etc/drizzle/*
/etc/drizzle/drizzled.cnf

/etc/drizzle/conf.d:
auth-file
$ cat /etc/drizzle/drizzled.cnf
server-id=42
core-file
$ cat /etc/drizzle/conf.d/auth-file
# drizzled option to load the auth_file plugin
plugin-remove=auth_all
plugin-add=auth_file

# Options for the plugin itself
[auth-file]
users=/etc/drizzle/users

Boolean Options

Boolean options do not and cannot take values. Most boolean options are disabled by default, so specifying them enables them. For example, --transaction-log.enable enable the transaction log because it is disabled by default. However, some options are enabled by default, so specifying them disables them. For example, --innodb.disable-checksums disables InnoDB checkum validation because it is enabled by default.