feat: Add support for postgres 'point' type

SindriFr · Sindri Frostason · commit 2c83c50eb058 · 2025-10-02T12:58:54.000Z
diff --git a/Cargo.toml b/Cargo.toml
@@ -41,6 +41,7 @@ time = { version = "0.3.36", default-features = false, optional = true, features
 ipnetwork = { version = "0.20", default-features = false, optional = true }
 mac_address = { version = "1.1", default-features = false, optional = true }
 ordered-float = { version = "4.6", default-features = false, optional = true }
+sqlx = { version = "0.8", default-features = false, optional = true }
 
 [dev-dependencies]
 sea-query = { path = ".", features = ["tests-cfg"] }
@@ -68,6 +69,7 @@ with-uuid = ["uuid"]
 with-time = ["time"]
 with-ipnetwork = ["ipnetwork"]
 with-mac_address = ["mac_address"]
+with-postgres-point = ["sqlx", "sqlx/postgres"]
 tests-cfg = []
 all-features = [
     "backend-mysql",
diff --git a/sea-query-binder/Cargo.toml b/sea-query-binder/Cargo.toml
@@ -3,9 +3,9 @@
 
 [package]
 name = "sea-query-binder"
-version = "0.7.0"
+version = "0.8.0-rc.2"
 authors = [ "Valentin Tolmer <valentin@tolmer.fr>", "Ivan Krivosheev <py.krivosheev@gmail.com>" ]
-edition = "2021"
+edition = "2024"
 description = "Driver library for using SeaQuery with SQLx"
 license = "MIT OR Apache-2.0"
 documentation = "https://docs.rs/sea-query"
@@ -42,6 +42,7 @@ with-uuid = ["sqlx?/uuid", "sea-query/with-uuid", "uuid"]
 with-time = ["sqlx?/time", "sea-query/with-time", "time"]
 with-ipnetwork = ["sqlx?/ipnetwork", "sea-query/with-ipnetwork", "ipnetwork"]
 with-mac_address = ["sqlx?/mac_address", "sea-query/with-mac_address", "mac_address"]
+with-postgres-point = ["sea-query/with-postgres-point"]
 postgres-array = ["sea-query/postgres-array"]
 postgres-vector = ["sea-query/postgres-vector", "pgvector/sqlx"]
 runtime-async-std = ["sqlx?/runtime-async-std"]
diff --git a/sea-query-binder/src/sqlx_postgres.rs b/sea-query-binder/src/sqlx_postgres.rs
@@ -129,6 +129,10 @@ impl sqlx::IntoArguments<'_, sqlx::postgres::Postgres> for SqlxValues {
                 Value::MacAddress(mac) => {
                     let _ = args.add(mac.as_deref());
                 }
+                #[cfg(feature = "with-postgres-point")]
+                Value::Point(point) => {
+                    let _ = args.add(point.as_deref());
+                }
                 #[cfg(feature = "postgres-array")]
                 Value::Array(ty, v) => match ty {
                     ArrayType::Bool => {
diff --git a/sea-query-postgres/Cargo.toml b/sea-query-postgres/Cargo.toml
@@ -39,3 +39,4 @@ postgres-array = ["postgres-types/array-impls", "sea-query/postgres-array"]
 postgres-vector = ["sea-query/postgres-vector", "pgvector/postgres"]
 with-ipnetwork = ["postgres-types/with-cidr-0_2", "sea-query/with-ipnetwork", "ipnetwork", "cidr"]
 with-mac_address = ["postgres-types/with-eui48-1", "sea-query/with-mac_address", "mac_address", "eui48"]
+with-postgres-point = ["sea-query/with-postgres-point"]
diff --git a/sea-query-postgres/src/lib.rs b/sea-query-postgres/src/lib.rs
@@ -137,6 +137,8 @@ impl ToSql for PostgresValue {
                     .map(|v| MacAddress::new(v.bytes()))
                     .to_sql(ty, out)
             }
+            #[cfg(feature = "with-postgres-point")]
+            Value::Point(v) => v.as_deref().to_sql(ty, out),
         }
     }
 
diff --git a/src/backend/mysql/table.rs b/src/backend/mysql/table.rs
@@ -95,6 +95,7 @@ impl TableBuilder for MysqlQueryBuilder {
                 ColumnType::Inet => unimplemented!("Inet is not available in MySQL."),
                 ColumnType::MacAddr => unimplemented!("MacAddr is not available in MySQL."),
                 ColumnType::LTree => unimplemented!("LTree is not available in MySQL."),
+                ColumnType::Point => unimplemented!("Point is not available in MySQL."),
             }
         )
         .unwrap();
diff --git a/src/backend/postgres/table.rs b/src/backend/postgres/table.rs
@@ -82,6 +82,7 @@ impl TableBuilder for PostgresQueryBuilder {
                 ColumnType::MacAddr => "macaddr".into(),
                 ColumnType::Year => unimplemented!("Year is not available in Postgres."),
                 ColumnType::LTree => "ltree".into(),
+                ColumnType::Point => "point".into(),
             }
         )
         .unwrap()
diff --git a/src/backend/query_builder.rs b/src/backend/query_builder.rs
@@ -1110,6 +1110,8 @@ pub trait QueryBuilder:
             Value::Array(_, None) => write!(s, "NULL").unwrap(),
             #[cfg(feature = "postgres-vector")]
             Value::Vector(None) => write!(s, "NULL").unwrap(),
+            #[cfg(feature = "with-postgres-point")]
+            Value::Point(None) => write!(s, "NULL").unwrap(),
             Value::Bool(Some(b)) => write!(s, "{}", if *b { "TRUE" } else { "FALSE" }).unwrap(),
             Value::TinyInt(Some(v)) => write!(s, "{v}").unwrap(),
             Value::SmallInt(Some(v)) => write!(s, "{v}").unwrap(),
@@ -1204,6 +1206,8 @@ pub trait QueryBuilder:
             Value::IpNetwork(Some(v)) => write!(s, "'{v}'").unwrap(),
             #[cfg(feature = "with-mac_address")]
             Value::MacAddress(Some(v)) => write!(s, "'{v}'").unwrap(),
+            #[cfg(feature = "with-postgres-point")]
+            Value::Point(Some(v)) => write!(s, "'({},{})'", v.x, v.y).unwrap(),
         };
         s
     }
diff --git a/src/backend/sqlite/table.rs b/src/backend/sqlite/table.rs
@@ -192,6 +192,7 @@ impl SqliteQueryBuilder {
                 ColumnType::Bit(_) => unimplemented!("Bit is not available in Sqlite."),
                 ColumnType::VarBit(_) => unimplemented!("VarBit is not available in Sqlite."),
                 ColumnType::LTree => unimplemented!("LTree is not available in Sqlite."),
+                ColumnType::Point => unimplemented!("Point is not available in MySQL."),
             }
         )
         .unwrap()
diff --git a/src/table/column.rs b/src/table/column.rs
@@ -57,6 +57,7 @@ pub trait IntoColumnDef {
 /// | Inet                  | N/A               | inet                        | N/A                          |
 /// | MacAddr               | N/A               | macaddr                     | N/A                          |
 /// | LTree                 | N/A               | ltree                       | N/A                          |
+/// | Point                 | N/A               | point                       | N/A                          |
 #[non_exhaustive]
 #[derive(Debug, Clone)]
 pub enum ColumnType {
@@ -102,6 +103,7 @@ pub enum ColumnType {
     Inet,
     MacAddr,
     LTree,
+    Point,
 }
 
 /// Length for var-char/binary; default to 255
diff --git a/src/value.rs b/src/value.rs
@@ -31,6 +31,9 @@ use std::net::IpAddr;
 #[cfg(feature = "with-mac_address")]
 use mac_address::MacAddress;
 
+#[cfg(feature = "with-postgres-point")]
+use sqlx::postgres::types::PgPoint;
+
 use crate::{ColumnType, CommonSqlQueryBuilder, QueryBuilder, StringLen};
 
 /// [`Value`] types variant for Postgres array
@@ -213,6 +216,10 @@ pub enum Value {
     #[cfg(feature = "with-mac_address")]
     #[cfg_attr(docsrs, doc(cfg(feature = "with-mac_address")))]
     MacAddress(Option<Box<MacAddress>>),
+
+    #[cfg(feature = "with-postgres-point")]
+    #[cfg_attr(docsrs, doc(cfg(feature = "with-postgres-point")))]
+    Point(Option<Box<PgPoint>>),
 }
 
 impl std::fmt::Display for Value {
@@ -400,6 +407,10 @@ impl Value {
             #[cfg(feature = "with-mac_address")]
             #[cfg_attr(docsrs, doc(cfg(feature = "with-mac_address")))]
             Self::MacAddress(_) => Self::MacAddress(None),
+
+            #[cfg(feature = "with-postgres-point")]
+            #[cfg_attr(docsrs, doc(cfg(feature = "with-postgres-point")))]
+            Self::Point(_) => Self::Point(None),
         }
     }
 
@@ -504,6 +515,10 @@ impl Value {
             #[cfg(feature = "with-mac_address")]
             #[cfg_attr(docsrs, doc(cfg(feature = "with-mac_address")))]
             Self::MacAddress(_) => Self::MacAddress(Some(Default::default())),
+
+            #[cfg(feature = "with-postgres-point")]
+            #[cfg_attr(docsrs, doc(cfg(feature = "with-postgres-point")))]
+            Self::Point(_) => Self::Point(Some(Box::new(PgPoint { x: 0., y: 0. }))),
         }
     }
 }
@@ -1124,6 +1139,45 @@ pub mod with_vector {
     }
 }
 
+#[cfg(feature = "with-postgres-point")]
+#[cfg_attr(docsrs, doc(cfg(feature = "with-postgres-point")))]
+mod with_postgres_point {
+    use super::*;
+
+    impl From<PgPoint> for Value {
+        fn from(x: PgPoint) -> Value {
+            Value::Point(Some(Box::new(x)))
+        }
+    }
+
+    impl Nullable for PgPoint {
+        fn null() -> Value {
+            Value::Point(None)
+        }
+    }
+
+    impl ValueType for PgPoint {
+        fn try_from(v: Value) -> Result<Self, ValueTypeErr> {
+            match v {
+                Value::Point(Some(x)) => Ok(*x),
+                _ => Err(ValueTypeErr),
+            }
+        }
+
+        fn type_name() -> String {
+            stringify!(Point).to_owned()
+        }
+
+        fn array_type() -> ArrayType {
+            unimplemented!()
+        }
+
+        fn column_type() -> ColumnType {
+            ColumnType::Point
+        }
+    }
+}
+
 #[allow(unused_macros)]
 macro_rules! box_to_opt_ref {
     ( $v: expr ) => {
@@ -1629,6 +1683,8 @@ pub fn sea_value_to_json_value(value: &Value) -> Json {
         Value::IpNetwork(None) => Json::Null,
         #[cfg(feature = "with-mac_address")]
         Value::MacAddress(None) => Json::Null,
+        #[cfg(feature = "with-postgres-point")]
+        Value::Point(None) => Json::Null,
         Value::Bool(Some(b)) => Json::Bool(*b),
         Value::TinyInt(Some(v)) => (*v).into(),
         Value::SmallInt(Some(v)) => (*v).into(),
@@ -1686,6 +1742,8 @@ pub fn sea_value_to_json_value(value: &Value) -> Json {
         Value::IpNetwork(Some(_)) => CommonSqlQueryBuilder.value_to_string(value).into(),
         #[cfg(feature = "with-mac_address")]
         Value::MacAddress(Some(_)) => CommonSqlQueryBuilder.value_to_string(value).into(),
+        #[cfg(feature = "with-postgres-point")]
+        Value::Point(Some(_)) => CommonSqlQueryBuilder.value_to_string(value).into(),
     }
 }
 
@@ -2300,6 +2358,12 @@ mod hashable_value {
 
                 #[cfg(feature = "with-mac_address")]
                 Value::MacAddress(mac_address) => mac_address.hash(state),
+
+                #[cfg(feature = "with-postgres-point")]
+                Value::Point(point) => {
+                    hash_f64(&point.as_ref().map(|p| p.x), state);
+                    hash_f64(&point.as_ref().map(|p| p.y), state);
+                }
             }
         }
     }

Original file line number	Diff line number	Diff line change
`@@ -137,6 +137,8 @@ impl ToSql for PostgresValue {`
`137`	`137`	`.map(\|v\| MacAddress::new(v.bytes()))`
`138`	`138`	`.to_sql(ty, out)`
`139`	`139`	`}`
	`140`	`+ #[cfg(feature = "with-postgres-point")]`
	`141`	`+ Value::Point(v) => v.as_deref().to_sql(ty, out),`
`140`	`142`	`}`
`141`	`143`	`}`
`142`	`144`
Original file line number	Diff line number	Diff line change
`@@ -95,6 +95,7 @@ impl TableBuilder for MysqlQueryBuilder {`
`95`	`95`	`ColumnType::Inet => unimplemented!("Inet is not available in MySQL."),`
`96`	`96`	`ColumnType::MacAddr => unimplemented!("MacAddr is not available in MySQL."),`
`97`	`97`	`ColumnType::LTree => unimplemented!("LTree is not available in MySQL."),`
	`98`	`+ ColumnType::Point => unimplemented!("Point is not available in MySQL."),`
`98`	`99`	`}`
`99`	`100`	`)`
`100`	`101`	`.unwrap();`
Original file line number	Diff line number	Diff line change
`@@ -82,6 +82,7 @@ impl TableBuilder for PostgresQueryBuilder {`
`82`	`82`	`ColumnType::MacAddr => "macaddr".into(),`
`83`	`83`	`ColumnType::Year => unimplemented!("Year is not available in Postgres."),`
`84`	`84`	`ColumnType::LTree => "ltree".into(),`
	`85`	`+ ColumnType::Point => "point".into(),`
`85`	`86`	`}`
`86`	`87`	`)`
`87`	`88`	`.unwrap()`
Original file line number	Diff line number	Diff line change
`@@ -192,6 +192,7 @@ impl SqliteQueryBuilder {`
`192`	`192`	`ColumnType::Bit(_) => unimplemented!("Bit is not available in Sqlite."),`
`193`	`193`	`ColumnType::VarBit(_) => unimplemented!("VarBit is not available in Sqlite."),`
`194`	`194`	`ColumnType::LTree => unimplemented!("LTree is not available in Sqlite."),`
	`195`	`+ ColumnType::Point => unimplemented!("Point is not available in MySQL."),`
`195`	`196`	`}`
`196`	`197`	`)`
`197`	`198`	`.unwrap()`