openstack-manuals/doc/common/tables/cinder-database.xml

<?xml version='1.0' encoding='UTF-8'?>
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
  <!-- Warning: Do not edit this file. It is automatically
     generated and your changes will be overwritten.
     The tool to do so lives in openstack-doc-tools repository. -->
  <table rules="all" xml:id="config_table_cinder_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>db_backend = sqlalchemy</td>
        <td>(StrOpt) The backend to use for db</td>
      </tr>
      <tr>
        <td>db_driver = cinder.db</td>
        <td>(StrOpt) Driver to use for database access</td>
      </tr>
      <tr>
        <th colspan="2">[database]</th>
      </tr>
      <tr>
        <td>backend = sqlalchemy</td>
        <td>(StrOpt) The back end to use for the database.</td>
      </tr>
      <tr>
        <td>connection = None</td>
        <td>(StrOpt) The SQLAlchemy connection string to use 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>db_inc_retry_interval = True</td>
        <td>(BoolOpt) If True, increases the interval between database connection retries up to db_max_retry_interval.</td>
      </tr>
      <tr>
        <td>db_max_retries = 20</td>
        <td>(IntOpt) Maximum database connection retries before error is raised. Set to -1 to specify an infinite retry count.</td>
      </tr>
      <tr>
        <td>db_max_retry_interval = 10</td>
        <td>(IntOpt) If db_inc_retry_interval is set, the maximum seconds between database connection retries.</td>
      </tr>
      <tr>
        <td>db_retry_interval = 1</td>
        <td>(IntOpt) Seconds between database connection retries.</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. Set to -1 to specify 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>mysql_sql_mode = TRADITIONAL</td>
        <td>(StrOpt) The SQL mode to be used for MySQL sessions. This option, including the default, overrides any server-set SQL mode. To use whatever SQL mode is set by the server configuration, set this to no value. Example: mysql_sql_mode=</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 = None</td>
        <td>(StrOpt) The SQLAlchemy connection string to use to connect to the slave database.</td>
      </tr>
      <tr>
        <td>sqlite_db = oslo.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>
        <td>use_db_reconnect = False</td>
        <td>(BoolOpt) Enable the experimental use of database reconnect on connection lost.</td>
      </tr>
      <tr>
        <td>use_tpool = False</td>
        <td>(BoolOpt) Enable the experimental use of thread pooling for all DB API calls</td>
      </tr>
    </tbody>
  </table>
</para>