dbbalancer.conf(5)

NAME

/etc/dbbalancer/dbbalancer.conf — configuration file for the dbbalancer daemon.

DESCRIPTION

This manual page was written for the Debian GNU/Linux distribution because the original program does not have a manual page. Instead, it has documentation in HTML format located in the /usr/share/doc/dbbalancer/manual.

The Debian startup scripts for DBBalancer look in the /etc/dbbalancer/conf.d directory for configuration files and start a DBBalancer Daemon for each file found. If a filename ends with `-w' then the init script will start a writer process, otherwise a reader process will be started.

PLEASE NOTE

This configuration file may contain sensitive information, such as usernames and passwords to connect to databases, possibly on other systems.

If that is the case for your configuration you should ensure that these files are mode 600, and are owned by root. Since that probably is the case, that is the default configuration at installation.

DIRECTIVES

Directives fall into two categories:

•: `Daemon' directives control the operation of the connections made to dbbalancer by the application.

•: `Machine' directives control the operation of the connections made by dbbalancer to the backend database.

In the Debian GNU/Linux installation of DBBalancer the init script will start a dbbalancerd daemon process for each configuration file found in /etc/dbbalancer/conf.d

These two groups of options are described briefly below. For a complete description, see the HTML documentation.

Daemon Section

aemon.reader-port=port: Specify the port on which to listen for incoming client database connections for reading activities.

aemon.writer-port=port: Specify the port on which to listen for incoming client database connections for write activities.

: When running in connection pool mode this will be the same as the read port.

aemon.init-threads=num: Specify the number of client connections to set at startup.

aemon.min-threads=num: Do not ever have fewer than this many client connections available.

aemon.max-threads=num: Do not ever have more than this many client connections available.

aemon.init-db-connections=num: Specify the number of connections to the backend database to initialise at startup.

aemon.min-db-connections=num: Do not ever have fewer than this many connections available with the backend database.

aemon.max-db-connections=num: Do not ever have more than this many connections available with the backend database.

aemon.reaper-delay=num: The number of seconds between invocations of the periodic thread that enforces the max / min settings.

aemon.dbname=database: The database name which clients must supply to connect to the daemon.

aemon.user=username: The username which clients must supply to connect to the daemon.

aemon.password=password: The password the client must use to connect to the daemon.

aemon.auth-method=(trust|password): The authentication method used by connectors.

Machine Section

chine.host=hostname: The name (or IP address) of the host on which the database server is running.

chine.dbname=database: The name of the database to connect to.

chine.port=port: The port on which the backend database is listening for connections.

chine.dbuser=username: The database user to connect as.

chine.dbpassword=password: The password to use for connections to the backend database.

AUTHOR

This manual page was written by Andrew McMillan <[email protected]> for the Debian GNU/Linux system (but may be used by others). Permission is granted to copy, distribute and/or modify this document under the terms of the GNU Free Documentation License, Version 1.1 or any later version published by the Free Software Foundation; with no Invariant Sections, no Front-Cover Texts and no Back-Cover Texts.