ConnectionIdleTimeout connection string option

Author: caleblloyd

docs/content/connection-options.md

@@ -106,18 +106,28 @@ Connection pooling is enabled by default.  These options are used to configure i
   <tr>
     <td>Connection Lifetime, ConnectionLifeTime</td>
     <td>0</td>
-    <td>When a connection is returned to the pool, its creation time is compared with the current time, and the connection is destroyed if that time span (in seconds) exceeds the value specified by Connection Lifetime. This is useful in clustered configurations to force load balancing between a running server and a server just brought online. A value of zero (0) causes pooled connections to have the maximum connection timeout.</td>
+    <td>When a connection is returned to the pool, its creation time is compared with the current time, and the connection is destroyed if that time span (in seconds) exceeds the value specified by Connection Lifetime. This is useful in clustered configurations to force load balancing between a running server and a server just brought online. A value of zero (0) means pooled connections will never incur a ConnectionLifeTime timeout.</td>
   </tr>
   <tr>
     <td>Connection Reset, ConnectionReset	</td>
     <td>false</td>
     <td>If true, the connection state is reset when it is retrieved from the pool. The default value of false avoids making an additional server round trip when obtaining a connection, but the connection state is not reset.</td>
   </tr>
+  <tr>
+    <td>Connection Idle Timeout, ConnectionIdleTimeout</td>
+    <td>180</td>
+    <td>The amount of time in seconds that a connection can remain idle in the pool. Any connection that is idle for longer is subject to being closed by a background task that runs every minute, unless there are only MinimumPoolSize connections left in the pool. A value of zero (0) means pooled connections will never incur a ConnectionIdleTimeout.</td>
+  </tr>
   <tr>
     <td>Maximum Pool Size, Max Pool Size, MaximumPoolsize, maxpoolsize</td>
     <td>100</td>
     <td>The maximum number of connections allowed in the pool.</td>
   </tr>
+  <tr>
+    <td>Minimum Pool Size, Min Pool Size, MinimumPoolSize, minpoolsize</td>
+    <td>0</td>
+    <td>The minimum number of connections to leave in the pool if ConnectionIdleTimeout is reached.</td>
+  </tr>
 </table>
 
 Other Options

src/MySqlConnector/MySqlClient/MySqlConnectionStringBuilder.cs

@@ -85,6 +85,12 @@ public bool ConnectionReset
 			set => MySqlConnectionStringOption.ConnectionReset.SetValue(this, value);
 		}
 
+		public uint ConnectionIdleTimeout
+		{
+			get => MySqlConnectionStringOption.ConnectionIdleTimeout.GetValue(this);
+			set => MySqlConnectionStringOption.ConnectionIdleTimeout.SetValue(this, value);
+		}
+
 		public uint MinimumPoolSize
 		{
 			get => MySqlConnectionStringOption.MinimumPoolSize.GetValue(this);
@@ -231,6 +237,7 @@ internal abstract class MySqlConnectionStringOption
 		public static readonly MySqlConnectionStringOption<bool> Pooling;
 		public static readonly MySqlConnectionStringOption<uint> ConnectionLifeTime;
 		public static readonly MySqlConnectionStringOption<bool> ConnectionReset;
+		public static readonly MySqlConnectionStringOption<uint> ConnectionIdleTimeout;
 		public static readonly MySqlConnectionStringOption<uint> MinimumPoolSize;
 		public static readonly MySqlConnectionStringOption<uint> MaximumPoolSize;
 
@@ -321,6 +328,10 @@ static MySqlConnectionStringOption()
 				keys: new[] { "Connection Reset", "ConnectionReset" },
 				defaultValue: true));
 
+			AddOption(ConnectionIdleTimeout = new MySqlConnectionStringOption<uint>(
+				keys: new[] { "Connection Idle Timeout", "ConnectionIdleTimeout" },
+				defaultValue: 180));
+
 			AddOption(MinimumPoolSize = new MySqlConnectionStringOption<uint>(
 				keys: new[] { "Minimum Pool Size", "Min Pool Size", "MinimumPoolSize", "minpoolsize" },
 				defaultValue: 0));

src/MySqlConnector/Serialization/ConnectionSettings.cs

@@ -38,6 +38,7 @@ public ConnectionSettings(MySqlConnectionStringBuilder csb)
 			Pooling = csb.Pooling;
 			ConnectionLifeTime = (int)csb.ConnectionLifeTime;
 			ConnectionReset = csb.ConnectionReset;
+			ConnectionIdleTimeout = (int)csb.ConnectionIdleTimeout;
 			if (csb.MinimumPoolSize > csb.MaximumPoolSize)
 				throw new MySqlException("MaximumPoolSize must be greater than or equal to MinimumPoolSize");
 			MinimumPoolSize = (int)csb.MinimumPoolSize;
@@ -80,6 +81,7 @@ private ConnectionSettings(ConnectionSettings other, bool? useCompression)
 			Pooling = other.Pooling;
 			ConnectionLifeTime = other.ConnectionLifeTime;
 			ConnectionReset = other.ConnectionReset;
+			ConnectionIdleTimeout = other.ConnectionIdleTimeout;
 			MinimumPoolSize = other.MinimumPoolSize;
 			MaximumPoolSize = other.MaximumPoolSize;
 
@@ -116,6 +118,7 @@ private ConnectionSettings(ConnectionSettings other, bool? useCompression)
 		internal readonly bool Pooling;
 		internal readonly int ConnectionLifeTime;
 		internal readonly bool ConnectionReset;
+		internal readonly int ConnectionIdleTimeout;
 		internal readonly int MinimumPoolSize;
 		internal readonly int MaximumPoolSize;
 
@@ -134,4 +137,3 @@ private ConnectionSettings(ConnectionSettings other, bool? useCompression)
 	}
 
 }
-

tests/MySqlConnector.Tests/MySqlConnectionStringBuilderTests.cs

@@ -25,6 +25,7 @@ public void Defaults()
 			Assert.Equal("", csb.Database);
 #if !BASELINE
 			Assert.Equal(false, csb.BufferResultSets);
+			Assert.Equal(180u, csb.ConnectionIdleTimeout);
 			Assert.Equal(false, csb.ForceSynchronous);
 #endif
 			Assert.Equal(0u, csb.Keepalive);
@@ -64,6 +65,7 @@ public void ParseConnectionString()
 				                   "ConnectionReset=false;" +
 				                   "Convert Zero Datetime=true;" +
 #if !BASELINE
+				                   "connectionidletimeout=30;" +
 				                   "bufferresultsets=true;" +
 				                   "forcesynchronous=true;" +
 #endif
@@ -91,6 +93,7 @@ public void ParseConnectionString()
 			Assert.Equal("schema_name", csb.Database);
 #if !BASELINE
 			Assert.Equal(true, csb.BufferResultSets);
+			Assert.Equal(30u, csb.ConnectionIdleTimeout);
 			Assert.Equal(true, csb.ForceSynchronous);
 #endif
 			Assert.Equal(90u, csb.Keepalive);