readyset-data: Add DfType::Point

Add a new `DfType` to support an initial spatial data type, which is
`Point`. This CL also adds basic MySQL support in
replicator (snapshot, replication).

A logictest is provided to test the output is correct (matches the
upstream's output). It is expected, though, that real-world queries
will use one of the `ST_*` spatial functions to select the data; those
functions are inplemented in a follow-up CL.

Fixes: REA-5697
Release-Core-Note: Basic support for `Point` spatial type in mysql.
Change-Id: If79e5385ec32d9f58be601c0366312b4ddfad6a6
Reviewed-on: https://gerrit.readyset.name/c/readyset/+/9320
Reviewed-by: Michael Zink <michael.z@readyset.io>
Tested-by: Buildkite CI

Author: jasobrown-rs

data-generator/src/lib.rs

@@ -475,6 +475,7 @@ pub fn value_of_type(typ: &SqlType) -> DfValue {
         SqlType::Interval { .. } => unimplemented!(),
         SqlType::Array(_) => unimplemented!(),
         SqlType::Other(_) => unimplemented!(),
+        SqlType::Point => unimplemented!(),
     }
 }
 
@@ -614,6 +615,7 @@ where
         SqlType::Interval { .. } => unimplemented!(),
         SqlType::Array(_) => unimplemented!(),
         SqlType::Other(_) => unimplemented!(),
+        SqlType::Point => unimplemented!(),
     }
 }
 
@@ -758,5 +760,6 @@ pub fn unique_value_of_type(typ: &SqlType, idx: u32) -> DfValue {
         SqlType::Interval { .. } => unimplemented!(),
         SqlType::Array(_) => unimplemented!(),
         SqlType::Other(_) => unimplemented!(),
+        SqlType::Point => unimplemented!(),
     }
 }

logictests/replicated/mysql/point_spatial_type.test

@@ -0,0 +1,43 @@
+statement ok
+create table locations (id int primary key, loc point);
+
+statement ok
+insert into locations values
+  (1, ST_PointFromText('POINT(1 2)')),
+  (2, ST_PointFromText('POINT(8.123 9.3145732)'));
+
+query B nosort
+select loc from locations where id = ?
+? = 1
+----
+0x000000000101000000000000000000F03F0000000000000040
+
+query B nosort
+select loc from locations where id = ?
+? = 2
+----
+0x000000000101000000E5D022DBF93E204069650CBD0FA12240
+
+
+
+# now test tables that explicitly set the SRID
+
+statement ok
+create table locations2 (id int primary key, loc point srid 4326);
+
+statement ok
+insert into locations2 values
+  (1, ST_PointFromText('POINT(1 2)', 4326)),
+  (2, ST_PointFromText('POINT(8.123 9.3145732)', 4326));
+
+query B nosort
+select loc from locations2 where id = ?
+? = 1
+----
+0xE610000001010000000000000000000040000000000000F03F
+
+query B nosort
+select loc from locations2 where id = ?
+? = 2
+----
+0xE6100000010100000069650CBD0FA12240E5D022DBF93E2040

nom-sql/src/sql_type.rs

@@ -454,6 +454,18 @@ fn type_identifier_part3(
             map(tag_no_case("bigserial"), |_| SqlType::BigSerial),
             map(tag_no_case("citext"), |_| SqlType::Citext),
             map(tag("\"char\""), |_| SqlType::QuotedChar),
+            // if a point is followed by an optional srid attribute, we need to ignore it but
+            // we need to parse it out.
+            map(
+                tuple((
+                    tag_no_case("point"),
+                    opt(preceded(
+                        tuple((whitespace1, tag_no_case("srid"), whitespace1)),
+                        digit1,
+                    )),
+                )),
+                |_| SqlType::Point,
+            ),
             map(other_type(dialect), SqlType::Other),
         ))(i)
     }
@@ -767,6 +779,18 @@ mod tests {
             assert_eq!(res, SqlType::Jsonb);
         }
 
+        #[test]
+        fn point_type() {
+            let res = test_parse!(type_identifier(Dialect::PostgreSQL), b"point");
+            assert_eq!(res, SqlType::Point);
+        }
+
+        #[test]
+        fn point_type_with_srid() {
+            let res = test_parse!(type_identifier(Dialect::PostgreSQL), b"point srid 4326");
+            assert_eq!(res, SqlType::Point);
+        }
+
         #[test]
         fn bit_type() {
             let res = test_parse!(type_identifier(Dialect::PostgreSQL), b"bit");

readyset-data/src/float.rs

@@ -175,7 +175,8 @@ pub(crate) fn coerce_f64(val: f64, to_ty: &DfType, from_ty: &DfType) -> ReadySet
         | DfType::Bit(_)
         | DfType::VarBit(_)
         | DfType::Array(_)
-        | DfType::Row => Err(err("not allowed")),
+        | DfType::Row
+        | DfType::Point => Err(err("not allowed")),
     }
 }
 
@@ -282,6 +283,7 @@ pub(crate) fn coerce_decimal(
         | DfType::Bit(_)
         | DfType::VarBit(_)
         | DfType::Array(_)
+        | DfType::Point
         | DfType::Row => Err(ReadySetError::DfValueConversionError {
             src_type: "Decimal".to_string(),
             target_type: to_ty.to_string(),

readyset-data/src/integer.rs

@@ -205,7 +205,8 @@ where
         | DfType::Uuid
         | DfType::VarBit(_)
         | DfType::Array(_)
-        | DfType::Row => Err(ReadySetError::DfValueConversionError {
+        | DfType::Row
+        | DfType::Point => Err(ReadySetError::DfValueConversionError {
             src_type: from_ty.to_string(),
             target_type: to_ty.to_string(),
             details: "Not allowed".to_string(),

readyset-data/src/lib.rs

@@ -2579,7 +2579,8 @@ mod arbitrary {
             | Some(DfType::MacAddr)
             | Some(DfType::Uuid)
             | Some(DfType::Inet)
-            | Some(DfType::Row) => Just(DfValue::None).boxed(),
+            | Some(DfType::Row)
+            | Some(DfType::Point) => Just(DfValue::None).boxed(),
         }
     }
 }

readyset-data/src/text.rs

@@ -597,7 +597,7 @@ pub(crate) trait TextCoerce: Sized + Clone + Into<DfValue> {
                 }
             }
 
-            DfType::Bit(_) | DfType::VarBit(_) | DfType::Row => {
+            DfType::Bit(_) | DfType::VarBit(_) | DfType::Row | DfType::Point => {
                 Err(Self::coerce_err(to_ty, "Not allowed"))
             }
         }

readyset-data/src/timestamp.rs

@@ -567,7 +567,8 @@ impl TimestampTz {
             | DfType::Bit(_)
             | DfType::VarBit(_)
             | DfType::Array(_)
-            | DfType::Row => Err(ReadySetError::DfValueConversionError {
+            | DfType::Row
+            | DfType::Point => Err(ReadySetError::DfValueConversionError {
                 src_type: "DfValue::TimestampTz".to_string(),
                 target_type: format!("{:?}", to_ty),
                 details: "Not allowed".to_string(),

readyset-data/src/type.rs

@@ -204,6 +204,11 @@ pub enum DfType {
 
     /// [PostgreSQL `jsonb`](https://www.postgresql.org/docs/current/datatype-json.html).
     Jsonb,
+
+    /// [MySQL `point`](https://dev.mysql.com/doc/refman/8.4/en/gis-class-point.html)
+    /// Note: We aren't supporting the old, legacy `point`/geometry data types that
+    /// are native to postgres. Instead, we'll support the postgis spatial types.
+    Point,
 }
 
 /// Defaults.
@@ -317,6 +322,7 @@ impl DfType {
             MacAddr => unsupported!("Unsupported type: MacAddr"),
             Inet => unsupported!("Unsupported type: Inet"),
             Citext => Self::Text(Collation::Citext),
+            Point => Self::Point,
             Other(ref id) => resolve_custom_type(id.clone()).ok_or_else(|| {
                 let id_upper = format!("{}", id.display_unquoted()).to_uppercase();
                 unsupported_err!("Unsupported type: {}", id_upper)
@@ -373,9 +379,11 @@ impl DfType {
             | DfType::Timestamp { .. }
             | DfType::TimestampTz { .. } => PgTypeCategory::DateTime,
             DfType::MacAddr | DfType::Inet => PgTypeCategory::NetworkAddress,
-            DfType::Uuid | DfType::Enum { .. } | DfType::Json | DfType::Jsonb => {
-                PgTypeCategory::UserDefined
-            }
+            DfType::Uuid
+            | DfType::Enum { .. }
+            | DfType::Json
+            | DfType::Jsonb
+            | DfType::Point => PgTypeCategory::UserDefined,
         }
     }
 
@@ -820,6 +828,7 @@ impl fmt::Display for DfType {
                 write!(f, "({})", variants.iter().join(", "))
             }
             Self::Numeric { prec, scale } => write!(f, "{kind:?}({prec}, {scale})"),
+            Self::Point => write!(f, "Point"),
         }
     }
 }

readyset-e2e-tests/tests/types_mysql.rs

@@ -319,6 +319,7 @@ fn arbitrary_mysql_value_for_type(sql_type: SqlType) -> impl Strategy<Value = Va
         SqlType::Signed | SqlType::Unsigned | SqlType::UnsignedInteger | SqlType::SignedInteger => {
             unimplemented!("This type is only valid in `CAST` and can't be used as a Column Def")
         }
+        SqlType::Point => unimplemented!("Points aren't implemented yet"),
     }
 }