6634218415
The "idle_timeout" name and documentation are misleading to users. Rename the option to connection_recycle_time to more closely match that of the underlying SQLAlchemy argument name "pool_recycle", which refers to a time period for which a connection present in the pool for longer than that number of seconds will be closed and replaced with a new one *upon checkout*, to prevent usage of stale connections that may have been closed by server-side reapers. Change-Id: I5e39d5ac81eaa8d85b1dfb18862fe27695ab8b96
16 lines
784 B
YAML
16 lines
784 B
YAML
---
|
|
deprecations:
|
|
- |
|
|
The configuration option ``idle_timeout`` is now deprecated and has been
|
|
renamed to ``connection_recycle_time``, including within the main oslo.db
|
|
options, as well as in the keyword arguments to
|
|
``engines.create_engine()``, ``enginefacade.configure()`` and
|
|
``enginefacade.configure_defaults()``. The new name more accurately
|
|
describes what this option does, in that it is not directly related to the
|
|
"idle" time of the connection itself, nor is the connection disconnected at
|
|
any specific time. It refers to a rule stating that any connection which
|
|
has been present more than N seconds as a member of the connection pool
|
|
will be automatically discarded and replaced the next time it is checked
|
|
out from the pool.
|
|
|