summaryrefslogtreecommitdiff
path: root/docs/ref
diff options
context:
space:
mode:
authorMariusz Felisiak <felisiak.mariusz@gmail.com>2023-01-10 11:51:09 +0100
committerGitHub <noreply@github.com>2023-01-10 11:51:09 +0100
commit552384fa977901dcbc33cc999cd38dddcdc0eef1 (patch)
treea3324faee94ed843f55621a30490a2c33bd3d478 /docs/ref
parent72efd840a8cb6ee35a3732d8bb434e7361970b3c (diff)
Refs #31014 -- Added FromWKB and FromWKT GIS database functions.
Co-authored-by: Ondřej Böhm <ondrej.bohm@firma.seznam.cz> Co-authored-by: Mariusz Felisiak <felisiak.mariusz@gmail.com> Co-authored-by: Sergey Fedoseev <fedoseev.sergey@gmail.com>
Diffstat (limited to 'docs/ref')
-rw-r--r--docs/ref/contrib/gis/db-api.txt2
-rw-r--r--docs/ref/contrib/gis/functions.txt59
2 files changed, 44 insertions, 17 deletions
diff --git a/docs/ref/contrib/gis/db-api.txt b/docs/ref/contrib/gis/db-api.txt
index 97f1f6ca6b..d215eb1ecb 100644
--- a/docs/ref/contrib/gis/db-api.txt
+++ b/docs/ref/contrib/gis/db-api.txt
@@ -360,6 +360,8 @@ Function PostGIS Oracle MariaDB MySQL
:class:`Distance` X X X X X
:class:`Envelope` X X X X X
:class:`ForcePolygonCW` X X
+:class:`FromWKB` X X X X X
+:class:`FromWKT` X X X X X
:class:`GeoHash` X X X (LWGEOM/RTTOPO)
:class:`Intersection` X X X X X
:class:`IsEmpty` X
diff --git a/docs/ref/contrib/gis/functions.txt b/docs/ref/contrib/gis/functions.txt
index 1c062515c6..a07feebfb7 100644
--- a/docs/ref/contrib/gis/functions.txt
+++ b/docs/ref/contrib/gis/functions.txt
@@ -20,17 +20,17 @@ get a ``NotImplementedError`` exception.
Function's summary:
-========================= ======================== ====================== ======================= ================== =====================
-Measurement Relationships Operations Editors Output format Miscellaneous
-========================= ======================== ====================== ======================= ================== =====================
-: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:`AsWKB` :class:`NumPoints`
-.. :class:`PointOnSurface` :class:`Transform` :class:`AsWKT`
-.. :class:`Translate` :class:`GeoHash`
-========================= ======================== ====================== ======================= ================== =====================
+========================= ======================== ====================== ======================= ================== ================== ======================
+Measurement Relationships Operations Editors Input format Output format Miscellaneous
+========================= ======================== ====================== ======================= ================== ================== ======================
+: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`
+========================= ======================== ====================== ======================= ================== ================== ======================
``Area``
========
@@ -174,15 +174,13 @@ __ https://www.w3.org/Graphics/SVG/
Oracle, `PostGIS <https://postgis.net/docs/ST_AsBinary.html>`__, SpatiaLite
Accepts a single geographic field or expression and returns a `Well-known
-binary (WKB)`__ representation of the geometry.
+binary (WKB)`_ representation of the geometry.
Example::
>>> bytes(City.objects.annotate(wkb=AsWKB('point')).get(name='Chelyabinsk').wkb)
b'\x01\x01\x00\x00\x00]3\xf9f\x9b\x91K@\x00X\x1d9\xd2\xb9N@'
-__ https://en.wikipedia.org/wiki/Well-known_text_representation_of_geometry#Well-known_binary
-
``AsWKT``
=========
@@ -193,15 +191,13 @@ __ https://en.wikipedia.org/wiki/Well-known_text_representation_of_geometry#Well
Oracle, `PostGIS <https://postgis.net/docs/ST_AsText.html>`__, SpatiaLite
Accepts a single geographic field or expression and returns a `Well-known text
-(WKT)`__ representation of the geometry.
+(WKT)`_ representation of the geometry.
Example::
>>> City.objects.annotate(wkt=AsWKT('point')).get(name='Chelyabinsk').wkt
'POINT (55.137555 61.451728)'
-__ https://en.wikipedia.org/wiki/Well-known_text_representation_of_geometry
-
``Azimuth``
===========
@@ -327,6 +323,32 @@ of the polygon/multipolygon in which all exterior rings are oriented clockwise
and all interior rings are oriented counterclockwise. Non-polygonal geometries
are returned unchanged.
+``FromWKB``
+===========
+
+.. versionadded:: 4.2
+
+.. class:: FromWKB(expression, **extra)
+
+*Availability*: MariaDB, `MySQL
+<https://dev.mysql.com/doc/refman/en/gis-wkb-functions.html#function_st-geomfromwkb>`__,
+Oracle, `PostGIS <https://postgis.net/docs/ST_GeomFromWKB.html>`__, SpatiaLite
+
+Creates geometry from `Well-known binary (WKB)`_ representation.
+
+``FromWKT``
+===========
+
+.. versionadded:: 4.2
+
+.. class:: FromWKT(expression, **extra)
+
+*Availability*: MariaDB, `MySQL
+<https://dev.mysql.com/doc/refman/en/gis-wkt-functions.html#function_st-geomfromtext>`__,
+Oracle, `PostGIS <https://postgis.net/docs/ST_GeomFromText.html>`__, SpatiaLite
+
+Creates geometry from `Well-known text (WKT)`_ representation.
+
``GeoHash``
===========
@@ -596,3 +618,6 @@ parameters.
Accepts two geographic fields or expressions and returns the union of both
geometries.
+
+.. _`Well-known binary (WKB)`: https://en.wikipedia.org/wiki/Well-known_text_representation_of_geometry#Well-known_binary
+.. _`Well-known text (WKT)`: https://en.wikipedia.org/wiki/Well-known_text_representation_of_geometry