diff options
| author | Mike Bayer <mike_mp@zzzcomputing.com> | 2016-06-25 11:22:02 -0400 |
|---|---|---|
| committer | Mike Bayer <mike_mp@zzzcomputing.com> | 2017-08-15 10:26:36 -0400 |
| commit | 6634218415906192fca891362b8fa0ac50b66284 (patch) | |
| tree | f8db14271ea2d17e7826aaea05e93b43bed3a1d1 /releasenotes | |
| parent | 92c5091d4c199ef18a8a3572e22ac6870af17c0c (diff) | |
| download | oslo-db-6634218415906192fca891362b8fa0ac50b66284.tar.gz | |
Rename idle_timeout to connection_recycle_time
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
Diffstat (limited to 'releasenotes')
| -rw-r--r-- | releasenotes/notes/deprecate_idle_timeout-029d9f2cb7184b28.yaml | 15 |
1 files changed, 15 insertions, 0 deletions
diff --git a/releasenotes/notes/deprecate_idle_timeout-029d9f2cb7184b28.yaml b/releasenotes/notes/deprecate_idle_timeout-029d9f2cb7184b28.yaml new file mode 100644 index 0000000..4e02e7a --- /dev/null +++ b/releasenotes/notes/deprecate_idle_timeout-029d9f2cb7184b28.yaml @@ -0,0 +1,15 @@ +--- +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. + |