diff options
| author | Niccolò Mineo <niccolo@20tab.com> | 2023-01-13 17:48:27 +0100 |
|---|---|---|
| committer | Mariusz Felisiak <felisiak.mariusz@gmail.com> | 2023-01-20 08:13:43 +0100 |
| commit | 79c298c9ceb8e386f172330236f04bb0ae4f7fdd (patch) | |
| tree | 2b251b25196c27ab07e8e0bc84c34b7ea06903aa /docs | |
| parent | 4b066bde692078b194709d517b27e55defae787c (diff) | |
Fixed #34266 -- Added ClosestPoint GIS database functions.
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/ref/contrib/gis/db-api.txt | 1 | ||||
| -rw-r--r-- | docs/ref/contrib/gis/functions.txt | 21 | ||||
| -rw-r--r-- | docs/releases/5.0.txt | 5 |
3 files changed, 22 insertions, 5 deletions
diff --git a/docs/ref/contrib/gis/db-api.txt b/docs/ref/contrib/gis/db-api.txt index d215eb1ecb..f8c0d83960 100644 --- a/docs/ref/contrib/gis/db-api.txt +++ b/docs/ref/contrib/gis/db-api.txt @@ -356,6 +356,7 @@ Function PostGIS Oracle MariaDB MySQL :class:`Azimuth` X X (LWGEOM/RTTOPO) :class:`BoundingCircle` X X :class:`Centroid` X X X X X +:class:`ClosestPoint` X X :class:`Difference` X X X X X :class:`Distance` X X X X X :class:`Envelope` X X X X X diff --git a/docs/ref/contrib/gis/functions.txt b/docs/ref/contrib/gis/functions.txt index a07feebfb7..963e9ed4bd 100644 --- a/docs/ref/contrib/gis/functions.txt +++ b/docs/ref/contrib/gis/functions.txt @@ -26,10 +26,10 @@ Measurement Relationships Operations Edi :class:`Area` :class:`Azimuth` :class:`Difference` :class:`ForcePolygonCW` :class:`AsGeoJSON` :class:`IsEmpty` :class:`Distance` :class:`BoundingCircle` :class:`Intersection` :class:`MakeValid` :class:`AsGML` :class:`IsValid` :class:`GeometryDistance` :class:`Centroid` :class:`SymDifference` :class:`Reverse` :class:`AsKML` :class:`MemSize` -:class:`Length` :class:`Envelope` :class:`Union` :class:`Scale` :class:`AsSVG` :class:`NumGeometries` -:class:`Perimeter` :class:`LineLocatePoint` :class:`SnapToGrid` :class:`FromWKB` :class:`AsWKB` :class:`NumPoints` - :class:`PointOnSurface` :class:`Transform` :class:`FromWKT` :class:`AsWKT` - :class:`Translate` :class:`GeoHash` +:class:`Length` :class:`ClosestPoint` :class:`Union` :class:`Scale` :class:`AsSVG` :class:`NumGeometries` +:class:`Perimeter` :class:`Envelope` :class:`SnapToGrid` :class:`FromWKB` :class:`AsWKB` :class:`NumPoints` + :class:`LineLocatePoint` :class:`Transform` :class:`FromWKT` :class:`AsWKT` + :class:`PointOnSurface` :class:`Translate` :class:`GeoHash` ========================= ======================== ====================== ======================= ================== ================== ====================== ``Area`` @@ -237,6 +237,19 @@ The ``num_seg`` parameter is used only on PostGIS. Accepts a single geographic field or expression and returns the ``centroid`` value of the geometry. +``ClosestPoint`` +================ + +.. versionadded:: 5.0 + +.. class:: ClosestPoint(expr1, expr2, **extra) + +*Availability*: `PostGIS <https://postgis.net/docs/ST_ClosestPoint.html>`__, +SpatiaLite + +Accepts two geographic fields or expressions and returns the 2-dimensional +point on geometry A that is closest to geometry B. + ``Difference`` ============== diff --git a/docs/releases/5.0.txt b/docs/releases/5.0.txt index a1dc6a1c1c..d1a4cba870 100644 --- a/docs/releases/5.0.txt +++ b/docs/releases/5.0.txt @@ -64,7 +64,10 @@ Minor features :mod:`django.contrib.gis` ~~~~~~~~~~~~~~~~~~~~~~~~~ -* ... +* The new + :class:`ClosestPoint() <django.contrib.gis.db.models.functions.ClosestPoint>` + function returns a 2-dimensional point on the geometry that is closest to + another geometry. :mod:`django.contrib.messages` ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ |