add st_quadkey

duckdb · Dec 5, 2023 · a7fafe0 · a7fafe0
1 parent b56e9e2
commit a7fafe0
Show file tree

Hide file tree

Showing 4 changed files with 93 additions and 0 deletions.
diff --git a/docs/docs.md b/docs/docs.md
@@ -99,6 +99,7 @@ Note that this will overwrite any existing `spatial` extension installed for the
 | [ST_PointN](##st_pointn) | Returns the n'th vertex from the input geometry as a point geometry |
 | [ST_PointOnSurface](##st_pointonsurface) | Returns a point that is guaranteed to be on the surface of the input geometry. Sometimes a useful alternative to ST_Centroid. |
 | [ST_Polygon2DFromWKB](##st_polygon2dfromwkb) | Deserialize a POLYGON_2D from a WKB encoded blob |
+| [ST_QuadKey](##st_quadkey) | Computes a quadkey from a given lon/lat point. |
 | [ST_ReducePrecision](##st_reduceprecision) | Returns the geometry with all vertices reduced to the target precision |
 | [ST_RemoveRepeatedPoints](##st_removerepeatedpoints) | Returns a new geometry with repeated points removed, optionally within a target distance of eachother. |
 | [ST_Reverse](##st_reverse) | Returns a new version of the input geometry with the order of its vertices reversed |
@@ -1208,6 +1209,31 @@ TODO
 
 TODO
 
+## ST_QuadKey
+
+_Computes a quadkey from a given lon/lat point._
+
+- __VARCHAR__ ST_QuadKey(geom __GEOMETRY__, level __INTEGER__)
+- __VARCHAR__ ST_QuadKey(longitude __DOUBLE__, latitude __DOUBLE__, level __INTEGER__)
+
+### Description
+
+Compute the [quadkey](https://learn.microsoft.com/en-us/bingmaps/articles/bing-maps-tile-system) for a given lon/lat point at a given level.
+Note that the the parameter order is __longitude__, __latitude__.
+
+`level` has to be between 1 and 23, inclusive.
+
+The input coordinates will be clamped to the lon/lat bounds of the earth (longitude between -180 and 180, latitude between -85.05112878 and 85.05112878).
+
+Throws for any geometry that is not a `POINT`
+
+### Examples
+
+```sql
+SELECT ST_QuadKey(st_point(11.08, 49.45), 10);
+-- 1333203202
+```
+
 ## ST_ReducePrecision
 
 _Returns the geometry with all vertices reduced to the target precision_
@@ -1785,6 +1811,7 @@ __property__
 - [ST_NumPoints](##st_numpoints)
 - [ST_Perimeter](##st_perimeter)
 - [ST_Perimeter_Spheroid](##st_perimeter_spheroid)
+- [ST_QuadKey](##st_quadkey)
 - [ST_X](##st_x)
 - [ST_XMax](##st_xmax)
 - [ST_XMin](##st_xmin)

diff --git a/docs/src/functions/scalar/st_quadkey.md b/docs/src/functions/scalar/st_quadkey.md
@@ -0,0 +1,61 @@
+---
+{
+    "id": "st_quadkey",
+    "title": "ST_QuadKey",
+    "type": "scalar_function",
+    "signatures": [
+        {
+            "returns": "VARCHAR",
+            "parameters": [
+                {
+                    "name": "geom",
+                    "type": "GEOMETRY"
+                },
+                {
+                    "name": "level",
+                    "type": "INTEGER"
+                }
+            ]
+        },
+        {
+            "returns": "VARCHAR",
+            "parameters": [
+                {
+                    "name": "longitude",
+                    "type": "DOUBLE"
+                },
+                {
+                    "name": "latitude",
+                    "type": "DOUBLE"
+                },
+                {
+                    "name": "level",
+                    "type": "INTEGER"
+                }
+            ]
+        }
+    ],
+    "aliases": [],
+    "summary": "Computes a quadkey from a given lon/lat point.",
+    "see_also": [ ],
+    "tags": [ "property" ]
+}
+---
+
+### Description
+
+Compute the [quadkey](https://learn.microsoft.com/en-us/bingmaps/articles/bing-maps-tile-system) for a given lon/lat point at a given level.
+Note that the the parameter order is __longitude__, __latitude__.
+
+`level` has to be between 1 and 23, inclusive.
+
+The input coordinates will be clamped to the lon/lat bounds of the earth (longitude between -180 and 180, latitude between -85.05112878 and 85.05112878).
+
+Throws for any geometry that is not a `POINT`
+
+### Examples
+
+```sql
+SELECT ST_QuadKey(st_point(11.08, 49.45), 10);
+-- 1333203202
+```
diff --git a/spatial/include/spatial/core/functions/scalar.hpp b/spatial/include/spatial/core/functions/scalar.hpp
@@ -40,6 +40,7 @@ struct CoreScalarFunctions {
 		RegisterStPerimeter(db);
 		RegisterStPoint(db);
 		RegisterStPointN(db);
+		RegisterStQuadKey(db);
 		RegisterStRemoveRepeatedPoints(db);
 		RegisterStStartPoint(db);
 		RegisterStX(db);
@@ -150,6 +151,9 @@ struct CoreScalarFunctions {
 	// ST_RemoveRepeatedPoints
 	static void RegisterStRemoveRepeatedPoints(DatabaseInstance &db);
 
+	// ST_QuadKey
+	static void RegisterStQuadKey(DatabaseInstance &db);
+
 	// ST_StartPoint
 	static void RegisterStStartPoint(DatabaseInstance &db);
 

diff --git a/spatial/src/spatial/core/functions/scalar/CMakeLists.txt b/spatial/src/spatial/core/functions/scalar/CMakeLists.txt
@@ -31,6 +31,7 @@ set(EXTENSION_SOURCES
     ${CMAKE_CURRENT_SOURCE_DIR}/st_perimeter.cpp
     ${CMAKE_CURRENT_SOURCE_DIR}/st_point.cpp
     ${CMAKE_CURRENT_SOURCE_DIR}/st_pointn.cpp
+    ${CMAKE_CURRENT_SOURCE_DIR}/st_quadkey.cpp
     ${CMAKE_CURRENT_SOURCE_DIR}/st_removerepeatedpoints.cpp
     ${CMAKE_CURRENT_SOURCE_DIR}/st_startpoint.cpp
     ${CMAKE_CURRENT_SOURCE_DIR}/st_xyzm.cpp