Implement MySqlGeometry. Fixes #677

Author: bgrainger

docs/content/tutorials/migrating-from-connector-net.md

@@ -192,3 +192,6 @@ The following bugs in Connector/NET are fixed by switching to MySqlConnector. (~
 * [#95436](https://bugs.mysql.com/bug.php?id=95436): Client doesn't authenticate with PEM certificate
 * [#95984](https://bugs.mysql.com/bug.php?id=95984): “Incorrect arguments to mysqld_stmt_execute” using prepared statement with `MySqlDbType.JSON`
 * [#95986](https://bugs.mysql.com/bug.php?id=95986): “Incorrect integer value” using prepared statement with `MySqlDbType.Int24`
+* [#96498](https://bugs.mysql.com/bug.php?id=96498): `WHERE` clause using `MySqlGeometry` as parameter finds no rows
+* [#96499](https://bugs.mysql.com/bug.php?id=96499): `MySqlException` when inserting a `MySqlGeometry` value
+* [#96500](https://bugs.mysql.com/bug.php?id=96500): `MySqlDataReader.GetFieldValue<MySqlGeometry>` throws `InvalidCastException`

src/MySqlConnector/Core/Row.cs

@@ -313,6 +313,14 @@ public MySqlDateTime GetMySqlDateTime(int ordinal)
 			return (MySqlDateTime) value;
 		}
 
+		public MySqlGeometry GetMySqlGeometry(int ordinal)
+		{
+			var value = GetValue(ordinal);
+			if (value is byte[] bytes && ResultSet.ColumnDefinitions[ordinal].ColumnType == ColumnType.Geometry)
+				return new MySqlGeometry(bytes);
+			throw new InvalidCastException("Can't convert {0} to MySqlGeometry.".FormatInvariant(ResultSet.ColumnDefinitions[ordinal].ColumnType));
+		}
+
 		public int GetValues(object[] values)
 		{
 			int count = Math.Min(values.Length, ResultSet.ColumnDefinitions.Length);
@@ -372,9 +380,9 @@ private void CheckBinaryColumn(int ordinal)
 			var column = ResultSet.ColumnDefinitions[ordinal];
 			var columnType = column.ColumnType;
 			if ((column.ColumnFlags & ColumnFlags.Binary) == 0 ||
-			    (columnType != ColumnType.String && columnType != ColumnType.VarString && columnType != ColumnType.TinyBlob &&
-			     columnType != ColumnType.Blob && columnType != ColumnType.MediumBlob && columnType != ColumnType.LongBlob &&
-			     columnType != ColumnType.Geometry))
+				(columnType != ColumnType.String && columnType != ColumnType.VarString && columnType != ColumnType.TinyBlob &&
+				columnType != ColumnType.Blob && columnType != ColumnType.MediumBlob && columnType != ColumnType.LongBlob &&
+				columnType != ColumnType.Geometry))
 			{
 				throw new InvalidCastException("Can't convert {0} to bytes.".FormatInvariant(columnType));
 			}

src/MySqlConnector/MySql.Data.MySqlClient/MySqlDataReader.cs

@@ -234,6 +234,9 @@ public override long GetChars(int ordinal, long dataOffset, char[] buffer, int b
 		public MySqlDateTime GetMySqlDateTime(int ordinal) => GetResultSet().GetCurrentRow().GetMySqlDateTime(ordinal);
 		public MySqlDateTime GetMySqlDateTime(string name) => GetMySqlDateTime(GetOrdinal(name));
 
+		public MySqlGeometry GetMySqlGeometry(int ordinal) => GetResultSet().GetCurrentRow().GetMySqlGeometry(ordinal);
+		public MySqlGeometry GetMySqlGeometry(string name) => GetMySqlGeometry(GetOrdinal(name));
+
 		public TimeSpan GetTimeSpan(int ordinal) => (TimeSpan) GetValue(ordinal);
 		public TimeSpan GetTimeSpan(string name) => GetTimeSpan(GetOrdinal(name));
 
@@ -295,6 +298,8 @@ public override T GetFieldValue<T>(int ordinal)
 				return (T) (object) GetTextReader(ordinal);
 			if (typeof(T) == typeof(Stream))
 				return (T) (object) GetStream(ordinal);
+			if (typeof(T) == typeof(MySqlGeometry))
+				return (T) (object) GetMySqlGeometry(ordinal);
 
 			return base.GetFieldValue<T>(ordinal);
 		}

src/MySqlConnector/MySql.Data.MySqlClient/MySqlParameter.cs

@@ -254,11 +254,12 @@ internal void AppendSqlString(ByteBufferWriter writer, StatementPreparerOptions
 			{
 				writer.WriteString(ulongValue);
 			}
-			else if (Value is byte[] || Value is ReadOnlyMemory<byte> || Value is Memory<byte> || Value is ArraySegment<byte>)
+			else if (Value is byte[] || Value is ReadOnlyMemory<byte> || Value is Memory<byte> || Value is ArraySegment<byte> || Value is MySqlGeometry)
 			{
 				var inputSpan = Value is byte[] byteArray ? byteArray.AsSpan() :
 					Value is ArraySegment<byte> arraySegment ? arraySegment.AsSpan() :
 					Value is Memory<byte> memory ? memory.Span :
+					Value is MySqlGeometry geometry ? geometry.Value :
 					((ReadOnlyMemory<byte>) Value).Span;
 
 				// determine the number of bytes to be written
@@ -475,6 +476,11 @@ internal void AppendBinary(ByteBufferWriter writer, StatementPreparerOptions opt
 				writer.WriteLengthEncodedInteger(unchecked((ulong) arraySegmentValue.Count));
 				writer.Write(arraySegmentValue);
 			}
+			else if (Value is MySqlGeometry geometry)
+			{
+				writer.WriteLengthEncodedInteger(unchecked((ulong) geometry.Value.Length));
+				writer.Write(geometry.Value);
+			}
 			else if (Value is float floatValue)
 			{
 				writer.Write(BitConverter.GetBytes(floatValue));

src/MySqlConnector/MySql.Data.Types/MySqlGeometry.cs

@@ -0,0 +1,52 @@
+using System;
+using System.Buffers.Binary;
+
+namespace MySql.Data.Types
+{
+	/// <summary>
+	/// Represents MySQL's internal GEOMETRY format: https://dev.mysql.com/doc/refman/8.0/en/gis-data-formats.html#gis-internal-format
+	/// </summary>
+	public sealed class MySqlGeometry
+	{
+		/// <summary>
+		/// Constructs a <see cref="MySqlGeometry"/> from a SRID and Well-known Binary bytes.
+		/// </summary>
+		/// <param name="srid">The SRID (Spatial Reference System ID).</param>
+		/// <param name="wkb">The Well-known Binary serialization of the geometry.</param>
+		/// <returns>A new <see cref="MySqlGeometry"/> containing the specified geometry.</returns>
+		public static MySqlGeometry FromWkb(int srid, ReadOnlySpan<byte> wkb)
+		{
+			var bytes = new byte[wkb.Length + 4];
+			BinaryPrimitives.WriteInt32LittleEndian(bytes, srid);
+			wkb.CopyTo(bytes.AsSpan().Slice(4));
+			return new MySqlGeometry(bytes);
+		}
+
+		/// <summary>
+		/// Constructs a <see cref="MySqlGeometry"/> from MySQL's internal format.
+		/// </summary>
+		/// <param name="value">The raw bytes of MySQL's internal GEOMETRY format.</param>
+		/// <returns>A new <see cref="MySqlGeometry"/> containing the specified geometry.</returns>
+		/// <remarks>See <a href="https://dev.mysql.com/doc/refman/8.0/en/gis-data-formats.html#gis-internal-format">Internal Geometry Storage Format</a>.</remarks>
+		public static MySqlGeometry FromMySql(ReadOnlySpan<byte> value) => new MySqlGeometry(value.ToArray());
+
+		/// <summary>
+		/// The Spatial Reference System ID of this geometry.
+		/// </summary>
+		public int SRID => BinaryPrimitives.ReadInt32LittleEndian(m_bytes);
+
+		/// <summary>
+		/// The Well-known Binary serialization of this geometry.
+		/// </summary>
+		public ReadOnlySpan<byte> WKB => Value.Slice(4);
+
+		/// <summary>
+		/// The internal MySQL form of this geometry.
+		/// </summary>
+		public ReadOnlySpan<byte> Value => m_bytes;
+
+		internal MySqlGeometry(byte[] bytes) => m_bytes = bytes;
+
+		readonly byte[] m_bytes;
+	}
+}