Configuration Options
oslo.db uses oslo.config to define and manage configuration
options to allow the deployer to control how an application uses the
underlying database.
database
- 
sqlite_db
- 
| Type: | string | 
|---|
 | Default: | oslo.sqlite | 
|---|
 
 - The file name to use with SQLite. - 
Deprecated Variations
| Group | Name | 
|---|
 | DEFAULT | sqlite_db |  
 
- 
sqlite_synchronous
- 
| Type: | boolean | 
|---|
 | Default: | true | 
|---|
 
 - If True, SQLite uses synchronous mode. - 
Deprecated Variations
| Group | Name | 
|---|
 | DEFAULT | sqlite_synchronous |  
 
- 
backend
- 
| Type: | string | 
|---|
 | Default: | sqlalchemy | 
|---|
 
 - The back end to use for the database. - 
Deprecated Variations
| Group | Name | 
|---|
 | DEFAULT | db_backend |  
 
- 
connection
- 
| Type: | string | 
|---|
 | Default: | <None> | 
|---|
 
 - The SQLAlchemy connection string to use to connect to the database. - 
Deprecated Variations
| Group | Name | 
|---|
 | DEFAULT | sql_connection |  | DATABASE | sql_connection |  | sql | connection |  
 
- 
slave_connection
- 
| Type: | string | 
|---|
 | Default: | <None> | 
|---|
 
 - The SQLAlchemy connection string to use to connect to the slave database. 
- 
mysql_sql_mode
- 
| Type: | string | 
|---|
 | Default: | TRADITIONAL | 
|---|
 
 - 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= 
- 
idle_timeout
- 
| Type: | integer | 
|---|
 | Default: | 3600 | 
|---|
 
 - Timeout before idle SQL connections are reaped. - 
Deprecated Variations
| Group | Name | 
|---|
 | DEFAULT | sql_idle_timeout |  | DATABASE | sql_idle_timeout |  | sql | idle_timeout |  
 
- 
min_pool_size
- 
Minimum number of SQL connections to keep open in a pool. 
Deprecated Variations
| Group | Name | 
|---|
 | DEFAULT | sql_min_pool_size |  | DATABASE | sql_min_pool_size |  
 
- 
max_pool_size
- 
| Type: | integer | 
|---|
 | Default: | <None> | 
|---|
 
 - Maximum number of SQL connections to keep open in a pool. - 
Deprecated Variations
| Group | Name | 
|---|
 | DEFAULT | sql_max_pool_size |  | DATABASE | sql_max_pool_size |  
 
- 
max_retries
- 
Maximum number of database connection retries during startup. Set to -1 to specify an infinite retry count. 
Deprecated Variations
| Group | Name | 
|---|
 | DEFAULT | sql_max_retries |  | DATABASE | sql_max_retries |  
 
- 
retry_interval
- 
Interval between retries of opening a SQL connection. 
Deprecated Variations
| Group | Name | 
|---|
 | DEFAULT | sql_retry_interval |  | DATABASE | reconnect_interval |  
 
- 
max_overflow
- 
If set, use this value for max_overflow with SQLAlchemy. 
Deprecated Variations
| Group | Name | 
|---|
 | DEFAULT | sql_max_overflow |  | DATABASE | sqlalchemy_max_overflow |  
 
- 
connection_debug
- 
Verbosity of SQL debugging information: 0=None, 100=Everything. 
Deprecated Variations
| Group | Name | 
|---|
 | DEFAULT | sql_connection_debug |  
 
- 
connection_trace
- 
| Type: | boolean | 
|---|
 | Default: | false | 
|---|
 
 - Add Python stack traces to SQL as comment strings. - 
Deprecated Variations
| Group | Name | 
|---|
 | DEFAULT | sql_connection_trace |  
 
- 
pool_timeout
- 
| Type: | integer | 
|---|
 | Default: | <None> | 
|---|
 
 - If set, use this value for pool_timeout with SQLAlchemy. - 
Deprecated Variations
| Group | Name | 
|---|
 | DATABASE | sqlalchemy_pool_timeout |  
 
- 
use_db_reconnect
- 
| Type: | boolean | 
|---|
 | Default: | false | 
|---|
 
 - Enable the experimental use of database reconnect on connection lost. 
- 
db_retry_interval
- 
Seconds between retries of a database transaction. 
- 
db_inc_retry_interval
- 
| Type: | boolean | 
|---|
 | Default: | true | 
|---|
 
 - If True, increases the interval between retries of a database operation up to db_max_retry_interval. 
- 
db_max_retry_interval
- 
If db_inc_retry_interval is set, the maximum seconds between retries of a database operation. 
- 
db_max_retries
- 
Maximum retries in case of connection error or deadlock error before error is raised. Set to -1 to specify an infinite retry count.