openstack-manuals/doc/common/tables/ceilometer-database.xml
Gauvain Pocentek e8fc05fce7 update ceilometer flags and tables
Change-Id: Ia25386391ffc1f626c958fce110f8c8042ffab7d
2014-03-19 07:40:55 +01:00

95 lines
4.1 KiB
XML

<?xml version="1.0" encoding="UTF-8"?>
<!-- Warning: Do not edit this file. It is automatically
generated and your changes will be overwritten.
The tool to do so lives in the tools directory of this
repository -->
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
<table rules="all" xml:id="config_table_ceilometer_database">
<caption>Description of configuration options for database</caption>
<col width="50%"/>
<col width="50%"/>
<thead>
<tr>
<th>Configuration option = Default value</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<th colspan="2">[DEFAULT]</th>
</tr>
<tr>
<td>database_connection = None</td>
<td>(StrOpt) DEPRECATED - Database connection string.</td>
</tr>
<tr>
<td>mysql_engine = InnoDB</td>
<td>(StrOpt) MySQL engine to use.</td>
</tr>
<tr>
<td>sqlite_db = ceilometer.sqlite</td>
<td>(StrOpt) The file name to use with SQLite</td>
</tr>
<tr>
<td>sqlite_synchronous = True</td>
<td>(BoolOpt) If True, SQLite uses synchronous mode</td>
</tr>
<tr>
<th colspan="2">[database]</th>
</tr>
<tr>
<td>backend = sqlalchemy</td>
<td>(StrOpt) The backend to use for db</td>
</tr>
<tr>
<td>connection = sqlite:////usr/lib/python/site-packages/ceilometer/openstack/common/db/$sqlite_db</td>
<td>(StrOpt) The SQLAlchemy connection string used to connect to the database</td>
</tr>
<tr>
<td>connection_debug = 0</td>
<td>(IntOpt) Verbosity of SQL debugging information. 0=None, 100=Everything</td>
</tr>
<tr>
<td>connection_trace = False</td>
<td>(BoolOpt) Add python stack traces to SQL as comment strings</td>
</tr>
<tr>
<td>idle_timeout = 3600</td>
<td>(IntOpt) Timeout before idle sql connections are reaped</td>
</tr>
<tr>
<td>max_overflow = None</td>
<td>(IntOpt) If set, use this value for max_overflow with sqlalchemy</td>
</tr>
<tr>
<td>max_pool_size = None</td>
<td>(IntOpt) Maximum number of SQL connections to keep open in a pool</td>
</tr>
<tr>
<td>max_retries = 10</td>
<td>(IntOpt) Maximum db connection retries during startup. (setting -1 implies an infinite retry count)</td>
</tr>
<tr>
<td>min_pool_size = 1</td>
<td>(IntOpt) Minimum number of SQL connections to keep open in a pool</td>
</tr>
<tr>
<td>pool_timeout = None</td>
<td>(IntOpt) If set, use this value for pool_timeout with sqlalchemy</td>
</tr>
<tr>
<td>retry_interval = 10</td>
<td>(IntOpt) Interval between retries of opening a sql connection</td>
</tr>
<tr>
<td>slave_connection = </td>
<td>(StrOpt) The SQLAlchemy connection string used to connect to the slave database</td>
</tr>
<tr>
<td>time_to_live = -1</td>
<td>(IntOpt) Number of seconds that samples are kept in the database for (&lt;= 0 means forever).</td>
</tr>
</tbody>
</table>
</para>