Support DateTimeKind connection option.

ejball · ejball · commit 64496ac4ed30 · 2018-04-14T15:09:06.000-07:00
Fixes #477.
diff --git a/docs/content/connection-options.md b/docs/content/connection-options.md
@@ -189,6 +189,13 @@ These are the other options that MySqlConnector supports. They are set to sensib
     <td>false</td>
     <td>True to have MySqlDataReader.GetValue() and MySqlDataReader.GetDateTime() return DateTime.MinValue for date or datetime columns that have disallowed values.</td>
   </tr>
+  <tr>
+    <td>DateTimeKind</td>
+    <td>Unspecified</td>
+    <td>The <code>DateTimeKind</code> used when <code>MySqlDataReader</code> returns a <code>DateTime</code>. If set to <code>Utc</code> or <code>Local</code>,
+    a <code>MySqlException</code> will be thrown if a <code>DateTime</code> command parameter has a <code>Kind</code> of <code>Local</code> or <code>Utc</code>,
+    respectively.</td>
+  </tr>
   <tr>
     <td>Default Command Timeout, Command Timeout, DefaultCommandTimeout</td>
     <td>30</td>
diff --git a/src/MySqlConnector/Core/ConnectionSettings.cs b/src/MySqlConnector/Core/ConnectionSettings.cs
@@ -55,6 +55,7 @@ public ConnectionSettings(MySqlConnectionStringBuilder csb)
 			AutoEnlist = csb.AutoEnlist;
 			ConnectionTimeout = (int) csb.ConnectionTimeout;
 			ConvertZeroDateTime = csb.ConvertZeroDateTime;
+			DateTimeKind = (DateTimeKind) csb.DateTimeKind;
 			DefaultCommandTimeout = (int) csb.DefaultCommandTimeout;
 			ForceSynchronous = csb.ForceSynchronous;
 			IgnoreCommandTransaction = csb.IgnoreCommandTransaction;
@@ -105,6 +106,7 @@ public ConnectionSettings(MySqlConnectionStringBuilder csb)
 		public bool AutoEnlist { get; }
 		public int ConnectionTimeout { get; }
 		public bool ConvertZeroDateTime { get; }
+		public DateTimeKind DateTimeKind { get; }
 		public int DefaultCommandTimeout { get; }
 		public bool ForceSynchronous { get; }
 		public bool IgnoreCommandTransaction { get; }
diff --git a/src/MySqlConnector/Core/Row.cs b/src/MySqlConnector/Core/Row.cs
@@ -456,7 +456,7 @@ private DateTime ParseDateTime(ArraySegment<byte> value)
 				return new DateTime(year, month, day, hour, minute, second);
 
 			var microseconds = int.Parse(parts[6] + new string('0', 6 - parts[6].Length), CultureInfo.InvariantCulture);
-			return new DateTime(year, month, day, hour, minute, second, microseconds / 1000).AddTicks(microseconds % 1000 * 10);
+			return new DateTime(year, month, day, hour, minute, second, microseconds / 1000, Connection.DateTimeKind).AddTicks(microseconds % 1000 * 10);
 		}
 
 		private static TimeSpan ParseTimeSpan(ArraySegment<byte> value)
diff --git a/src/MySqlConnector/Core/StatementPreparer.cs b/src/MySqlConnector/Core/StatementPreparer.cs
@@ -73,7 +73,7 @@ private void DoAppendParameter(int parameterIndex, int textIndex, int textLength
 				var parameter = m_preparer.m_parameters[parameterIndex];
 				if (parameter.Direction != ParameterDirection.Input && (m_preparer.m_options & StatementPreparerOptions.AllowOutputParameters) == 0)
 					throw new MySqlException("Only ParameterDirection.Input is supported when CommandType is Text (parameter name: {0})".FormatInvariant(parameter.ParameterName));
-				m_preparer.m_parameters[parameterIndex].AppendSqlString(m_writer, m_preparer.m_options);
+				m_preparer.m_parameters[parameterIndex].AppendSqlString(m_writer, m_preparer.m_options, parameter.ParameterName);
 				m_lastIndex = textIndex + textLength;
 			}
 
diff --git a/src/MySqlConnector/Core/StatementPreparerOptions.cs b/src/MySqlConnector/Core/StatementPreparerOptions.cs
@@ -9,5 +9,7 @@ internal enum StatementPreparerOptions
 		AllowUserVariables = 1,
 		OldGuids = 2,
 		AllowOutputParameters = 4,
+		DateTimeUtc = 8,
+		DateTimeLocal = 16,
 	}
 }
diff --git a/src/MySqlConnector/Core/TextCommandExecutor.cs b/src/MySqlConnector/Core/TextCommandExecutor.cs
@@ -94,6 +94,10 @@ private PayloadData CreateQueryPayload(string commandText, MySqlParameterCollect
 				statementPreparerOptions |= StatementPreparerOptions.AllowUserVariables;
 			if (m_command.Connection.OldGuids)
 				statementPreparerOptions |= StatementPreparerOptions.OldGuids;
+			if (m_command.Connection.DateTimeKind == DateTimeKind.Utc)
+				statementPreparerOptions |= StatementPreparerOptions.DateTimeUtc;
+			else if (m_command.Connection.DateTimeKind == DateTimeKind.Local)
+				statementPreparerOptions |= StatementPreparerOptions.DateTimeLocal;
 			if (m_command.CommandType == CommandType.StoredProcedure)
 				statementPreparerOptions |= StatementPreparerOptions.AllowOutputParameters;
 			var preparer = new StatementPreparer(commandText, parameterCollection, statementPreparerOptions);
diff --git a/src/MySqlConnector/MySql.Data.MySqlClient/MySqlConnection.cs b/src/MySqlConnector/MySql.Data.MySqlClient/MySqlConnection.cs
@@ -348,6 +348,7 @@ internal async Task<CachedProcedure> GetCachedProcedure(IOBehavior ioBehavior, s
 		internal MySqlTransaction CurrentTransaction { get; set; }
 		internal bool AllowUserVariables => m_connectionSettings.AllowUserVariables;
 		internal bool ConvertZeroDateTime => m_connectionSettings.ConvertZeroDateTime;
+		internal DateTimeKind DateTimeKind => m_connectionSettings.DateTimeKind;
 		internal int DefaultCommandTimeout => GetConnectionSettings().DefaultCommandTimeout;
 		internal bool IgnoreCommandTransaction => m_connectionSettings.IgnoreCommandTransaction;
 		internal bool OldGuids => m_connectionSettings.OldGuids;
diff --git a/src/MySqlConnector/MySql.Data.MySqlClient/MySqlConnectionStringBuilder.cs b/src/MySqlConnector/MySql.Data.MySqlClient/MySqlConnectionStringBuilder.cs
@@ -159,6 +159,12 @@ public bool ConvertZeroDateTime
 			set => MySqlConnectionStringOption.ConvertZeroDateTime.SetValue(this, value);
 		}
 
+		public MySqlDateTimeKind DateTimeKind
+		{
+			get => MySqlConnectionStringOption.DateTimeKind.GetValue(this);
+			set => MySqlConnectionStringOption.DateTimeKind.SetValue(this, value);
+		}
+
 		public uint DefaultCommandTimeout
 		{
 			get => MySqlConnectionStringOption.DefaultCommandTimeout.GetValue(this);
@@ -294,6 +300,7 @@ internal abstract class MySqlConnectionStringOption
 		public static readonly MySqlConnectionStringOption<string> CharacterSet;
 		public static readonly MySqlConnectionStringOption<uint> ConnectionTimeout;
 		public static readonly MySqlConnectionStringOption<bool> ConvertZeroDateTime;
+		public static readonly MySqlConnectionStringOption<MySqlDateTimeKind> DateTimeKind;
 		public static readonly MySqlConnectionStringOption<uint> DefaultCommandTimeout;
 		public static readonly MySqlConnectionStringOption<bool> ForceSynchronous;
 		public static readonly MySqlConnectionStringOption<bool> IgnoreCommandTransaction;
@@ -427,6 +434,10 @@ static MySqlConnectionStringOption()
 				keys: new[] { "Convert Zero Datetime", "ConvertZeroDateTime" },
 				defaultValue: false));
 
+			AddOption(DateTimeKind = new MySqlConnectionStringOption<MySqlDateTimeKind>(
+				keys: new[] { "DateTimeKind" },
+				defaultValue: MySqlDateTimeKind.Unspecified));
+
 			AddOption(DefaultCommandTimeout = new MySqlConnectionStringOption<uint>(
 				keys: new[] { "Default Command Timeout", "DefaultCommandTimeout", "Command Timeout" },
 				defaultValue: 30u));
@@ -505,21 +516,11 @@ private static T ChangeType(object objectValue)
 					return (T) (object) false;
 			}
 
-			if (typeof(T) == typeof(MySqlLoadBalance) && objectValue is string loadBalanceString)
-			{
-				foreach (var val in Enum.GetValues(typeof(T)))
-				{
-					if (string.Equals(loadBalanceString, val.ToString(), StringComparison.OrdinalIgnoreCase))
-						return (T) val;
-				}
-				throw new InvalidOperationException("Value '{0}' not supported for option '{1}'.".FormatInvariant(objectValue, typeof(T).Name));
-			}
-
-			if (typeof(T) == typeof(MySqlSslMode) && objectValue is string sslModeString)
+			if ((typeof(T) == typeof(MySqlLoadBalance) || typeof(T) == typeof(MySqlSslMode) || typeof(T) == typeof(MySqlDateTimeKind)) && objectValue is string enumString)
 			{
 				foreach (var val in Enum.GetValues(typeof(T)))
 				{
-					if (string.Equals(sslModeString, val.ToString(), StringComparison.OrdinalIgnoreCase))
+					if (string.Equals(enumString, val.ToString(), StringComparison.OrdinalIgnoreCase))
 						return (T) val;
 				}
 				throw new InvalidOperationException("Value '{0}' not supported for option '{1}'.".FormatInvariant(objectValue, typeof(T).Name));
diff --git a/src/MySqlConnector/MySql.Data.MySqlClient/MySqlDateTimeKind.cs b/src/MySqlConnector/MySql.Data.MySqlClient/MySqlDateTimeKind.cs
@@ -0,0 +1,25 @@
+using System;
+
+namespace MySql.Data.MySqlClient
+{
+	/// <summary>
+	/// The <see cref="DateTimeKind" /> used when reading <see cref="DateTime" /> from the databsae.
+	/// </summary>
+	public enum MySqlDateTimeKind
+	{
+		/// <summary>
+		/// Use <see cref="DateTimeKind.Unspecified" /> when reading; allow any <see cref="DateTimeKind" /> in command parameters.
+		/// </summary>
+		Unspecified = DateTimeKind.Unspecified,
+
+		/// <summary>
+		/// Use <see cref="DateTimeKind.Utc" /> when reading; reject <see cref="DateTimeKind.Local" /> in command parameters.
+		/// </summary>
+		Utc = DateTimeKind.Utc,
+
+		/// <summary>
+		/// Use <see cref="DateTimeKind.Local" /> when reading; reject <see cref="DateTimeKind.Utc" /> in command parameters.
+		/// </summary>
+		Local = DateTimeKind.Local,
+	}
+}
diff --git a/src/MySqlConnector/MySql.Data.MySqlClient/MySqlParameter.cs b/src/MySqlConnector/MySql.Data.MySqlClient/MySqlParameter.cs
@@ -173,7 +173,7 @@ private MySqlParameter(MySqlParameter other, string parameterName)
 
 		internal string NormalizedParameterName { get; private set; }
 
-		internal void AppendSqlString(BinaryWriter writer, StatementPreparerOptions options)
+		internal void AppendSqlString(BinaryWriter writer, StatementPreparerOptions options, string parameterName)
 		{
 			if (Value == null || Value == DBNull.Value)
 			{
@@ -236,9 +236,14 @@ internal void AppendSqlString(BinaryWriter writer, StatementPreparerOptions opti
 			{
 				writer.WriteUtf8("{0:R}".FormatInvariant(Value));
 			}
-			else if (Value is DateTime)
+			else if (Value is DateTime dateTimeValue)
 			{
-				writer.WriteUtf8("timestamp('{0:yyyy'-'MM'-'dd' 'HH':'mm':'ss'.'ffffff}')".FormatInvariant(Value));
+				if ((options & StatementPreparerOptions.DateTimeUtc) != 0 && dateTimeValue.Kind == DateTimeKind.Local)
+					throw new MySqlException("DateTime.Kind must not be Local when DateTimeKind setting is Utc (parameter name: {0})".FormatInvariant(parameterName));
+				else if ((options & StatementPreparerOptions.DateTimeLocal) != 0 && dateTimeValue.Kind == DateTimeKind.Utc)
+					throw new MySqlException("DateTime.Kind must not be Utc when DateTimeKind setting is Local (parameter name: {0})".FormatInvariant(parameterName));
+
+				writer.WriteUtf8("timestamp('{0:yyyy'-'MM'-'dd' 'HH':'mm':'ss'.'ffffff}')".FormatInvariant(dateTimeValue));
 			}
 			else if (Value is DateTimeOffset dateTimeOffsetValue)
 			{
diff --git a/tests/MySqlConnector.Tests/MySqlConnectionStringBuilderTests.cs b/tests/MySqlConnector.Tests/MySqlConnectionStringBuilderTests.cs
@@ -26,6 +26,9 @@ public void Defaults()
 #endif
 			Assert.Equal(15u, csb.ConnectionTimeout);
 			Assert.False(csb.ConvertZeroDateTime);
+#if !BASELINE
+			Assert.Equal(MySqlDateTimeKind.Unspecified, csb.DateTimeKind);
+#endif
 			Assert.Equal("", csb.Database);
 			Assert.Equal(30u, csb.DefaultCommandTimeout);
 #if !BASELINE
@@ -76,6 +79,9 @@ public void ParseConnectionString()
 					"connection lifetime=15;" +
 					"ConnectionReset=false;" +
 					"Convert Zero Datetime=true;" +
+#if !BASELINE
+					"datetimekind=utc;" +
+#endif
 					"default command timeout=123;" +
 #if !BASELINE
 					"connection idle ping time=60;" +
@@ -109,6 +115,9 @@ public void ParseConnectionString()
 			Assert.False(csb.ConnectionReset);
 			Assert.Equal(30u, csb.ConnectionTimeout);
 			Assert.True(csb.ConvertZeroDateTime);
+#if !BASELINE
+			Assert.Equal(MySqlDateTimeKind.Utc, csb.DateTimeKind);
+#endif
 			Assert.Equal("schema_name", csb.Database);
 			Assert.Equal(123u, csb.DefaultCommandTimeout);
 #if !BASELINE
diff --git a/tests/SideBySide/DataTypes.cs b/tests/SideBySide/DataTypes.cs
@@ -549,6 +549,51 @@ public void QueryZeroDateTime(bool convertZeroDateTime)
 			}
 		}
 
+#if !BASELINE
+		[Theory]
+		[InlineData(MySqlDateTimeKind.Unspecified, DateTimeKind.Unspecified, true)]
+		[InlineData(MySqlDateTimeKind.Unspecified, DateTimeKind.Local, true)]
+		[InlineData(MySqlDateTimeKind.Unspecified, DateTimeKind.Utc, true)]
+		[InlineData(MySqlDateTimeKind.Utc, DateTimeKind.Unspecified, true)]
+		[InlineData(MySqlDateTimeKind.Utc, DateTimeKind.Local, false)]
+		[InlineData(MySqlDateTimeKind.Utc, DateTimeKind.Utc, true)]
+		[InlineData(MySqlDateTimeKind.Local, DateTimeKind.Unspecified, true)]
+		[InlineData(MySqlDateTimeKind.Local, DateTimeKind.Local, true)]
+		[InlineData(MySqlDateTimeKind.Local, DateTimeKind.Utc, false)]
+		public void QueryDateTimeKind(MySqlDateTimeKind kindOption, DateTimeKind kindIn, bool success)
+		{
+			var csb = AppConfig.CreateConnectionStringBuilder();
+			csb.DateTimeKind = kindOption;
+			using (var connection = new MySqlConnection(csb.ConnectionString))
+			{
+				connection.Open();
+
+				var dateTimeIn = new DateTime(2002, 3, 4, 5, 6, 7, 890, kindIn);
+				using (var cmd = new MySqlCommand(@"drop table if exists date_time_kind;
+create table date_time_kind(rowid integer not null primary key auto_increment, dt datetime(3) not null);
+insert into date_time_kind(dt) values(?)", connection)
+				{
+					Parameters = { new MySqlParameter { Value = dateTimeIn } }
+				})
+				{
+					if (success)
+					{
+						cmd.ExecuteNonQuery();
+						long lastInsertId = cmd.LastInsertedId;
+						cmd.CommandText = $"select dt from date_time_kind where rowid = {lastInsertId};";
+						var dateTimeOut = (DateTime?) cmd.ExecuteScalar();
+						Assert.Equal(dateTimeIn, dateTimeOut);
+						Assert.Equal(kindOption, (MySqlDateTimeKind) dateTimeOut.Value.Kind);
+					}
+					else
+					{
+						Assert.Throws<MySqlException>(() => cmd.ExecuteNonQuery());
+					}
+				}
+			}
+		}
+#endif
+
 		[Theory]
 		[InlineData("`Time`", "TIME", new object[] { null, "-838 -59 -59", "838 59 59", "0 0 0", "0 14 3 4 567890" })]
 		public void QueryTime(string column, string dataTypeName, object[] expected)

Original file line number	Diff line number	Diff line change
`@@ -456,7 +456,7 @@ private DateTime ParseDateTime(ArraySegment<byte> value)`
`456`	`456`	`return new DateTime(year, month, day, hour, minute, second);`
`457`	`457`
`458`	`458`	`var microseconds = int.Parse(parts[6] + new string('0', 6 - parts[6].Length), CultureInfo.InvariantCulture);`
`459`		`- return new DateTime(year, month, day, hour, minute, second, microseconds / 1000).AddTicks(microseconds % 1000 * 10);`
	`459`	`+ return new DateTime(year, month, day, hour, minute, second, microseconds / 1000, Connection.DateTimeKind).AddTicks(microseconds % 1000 * 10);`
`460`	`460`	`}`
`461`	`461`
`462`	`462`	`private static TimeSpan ParseTimeSpan(ArraySegment<byte> value)`
Original file line number	Diff line number	Diff line change
`@@ -73,7 +73,7 @@ private void DoAppendParameter(int parameterIndex, int textIndex, int textLength`
`73`	`73`	`var parameter = m_preparer.m_parameters[parameterIndex];`
`74`	`74`	`if (parameter.Direction != ParameterDirection.Input && (m_preparer.m_options & StatementPreparerOptions.AllowOutputParameters) == 0)`
`75`	`75`	`throw new MySqlException("Only ParameterDirection.Input is supported when CommandType is Text (parameter name: {0})".FormatInvariant(parameter.ParameterName));`
`76`		`- m_preparer.m_parameters[parameterIndex].AppendSqlString(m_writer, m_preparer.m_options);`
	`76`	`+ m_preparer.m_parameters[parameterIndex].AppendSqlString(m_writer, m_preparer.m_options, parameter.ParameterName);`
`77`	`77`	`m_lastIndex = textIndex + textLength;`
`78`	`78`	`}`
`79`	`79`
Original file line number	Diff line number	Diff line change
`@@ -9,5 +9,7 @@ internal enum StatementPreparerOptions`
`9`	`9`	`AllowUserVariables = 1,`
`10`	`10`	`OldGuids = 2,`
`11`	`11`	`AllowOutputParameters = 4,`
	`12`	`+ DateTimeUtc = 8,`
	`13`	`+ DateTimeLocal = 16,`
`12`	`14`	`}`
`13`	`15`	`}`
Original file line number	Diff line number	Diff line change
`@@ -173,7 +173,7 @@ private MySqlParameter(MySqlParameter other, string parameterName)`
`173`	`173`
`174`	`174`	`internal string NormalizedParameterName { get; private set; }`
`175`	`175`
`176`		`- internal void AppendSqlString(BinaryWriter writer, StatementPreparerOptions options)`
	`176`	`+ internal void AppendSqlString(BinaryWriter writer, StatementPreparerOptions options, string parameterName)`
`177`	`177`	`{`
`178`	`178`	`if (Value == null \|\| Value == DBNull.Value)`
`179`	`179`	`{`
`@@ -236,9 +236,14 @@ internal void AppendSqlString(BinaryWriter writer, StatementPreparerOptions opti`
`236`	`236`	`{`
`237`	`237`	`writer.WriteUtf8("{0:R}".FormatInvariant(Value));`
`238`	`238`	`}`
`239`		`- else if (Value is DateTime)`
	`239`	`+ else if (Value is DateTime dateTimeValue)`
`240`	`240`	`{`
`241`		`- writer.WriteUtf8("timestamp('{0:yyyy'-'MM'-'dd' 'HH':'mm':'ss'.'ffffff}')".FormatInvariant(Value));`
	`241`	`+ if ((options & StatementPreparerOptions.DateTimeUtc) != 0 && dateTimeValue.Kind == DateTimeKind.Local)`
	`242`	`+ throw new MySqlException("DateTime.Kind must not be Local when DateTimeKind setting is Utc (parameter name: {0})".FormatInvariant(parameterName));`
	`243`	`+ else if ((options & StatementPreparerOptions.DateTimeLocal) != 0 && dateTimeValue.Kind == DateTimeKind.Utc)`
	`244`	`+ throw new MySqlException("DateTime.Kind must not be Utc when DateTimeKind setting is Local (parameter name: {0})".FormatInvariant(parameterName));`
	`245`	`+`
	`246`	`+ writer.WriteUtf8("timestamp('{0:yyyy'-'MM'-'dd' 'HH':'mm':'ss'.'ffffff}')".FormatInvariant(dateTimeValue));`
`242`	`247`	`}`
`243`	`248`	`else if (Value is DateTimeOffset dateTimeOffsetValue)`
`244`	`249`	`{`