summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorClaude Paroz <claude@2xlibre.net>2024-03-10 20:12:30 +0100
committerMariusz Felisiak <felisiak.mariusz@gmail.com>2024-03-18 09:45:33 +0100
commit10b31eea337261ba724a71839ebc4bd4ddac3675 (patch)
tree11cb8a3abc36bc1f685b4b946c838d1ec90a1de2 /docs
parent7646b9023da7e1f6f3a871959db027b3ea36eebb (diff)
Refs #31014 -- Added srid argument to FromWKB/FromWKT() GIS functions.
Diffstat (limited to 'docs')
-rw-r--r--docs/ref/contrib/gis/functions.txt20
-rw-r--r--docs/releases/5.1.txt5
2 files changed, 21 insertions, 4 deletions
diff --git a/docs/ref/contrib/gis/functions.txt b/docs/ref/contrib/gis/functions.txt
index f55d314b3f..3fff7eeb50 100644
--- a/docs/ref/contrib/gis/functions.txt
+++ b/docs/ref/contrib/gis/functions.txt
@@ -359,24 +359,36 @@ are returned unchanged.
``FromWKB``
===========
-.. class:: FromWKB(expression, **extra)
+.. class:: FromWKB(expression, srid=0, **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.
+Creates geometry from `Well-known binary (WKB)`_ representation. The optional
+``srid`` argument allows to specify the SRID of the resulting geometry.
+``srid`` is ignored on Oracle.
+
+.. versionchanged:: 5.1
+
+ The ``srid`` argument was added.
``FromWKT``
===========
-.. class:: FromWKT(expression, **extra)
+.. class:: FromWKT(expression, srid=0, **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.
+Creates geometry from `Well-known text (WKT)`_ representation. The optional
+``srid`` argument allows to specify the SRID of the resulting geometry.
+``srid`` is ignored on Oracle.
+
+.. versionchanged:: 5.1
+
+ The ``srid`` argument was added.
``GeoHash``
===========
diff --git a/docs/releases/5.1.txt b/docs/releases/5.1.txt
index 5fe2be96c8..2dbacf08f7 100644
--- a/docs/releases/5.1.txt
+++ b/docs/releases/5.1.txt
@@ -101,6 +101,11 @@ Minor features
* :attr:`.OGRGeometry.centroid` is now available on all supported geometry
types.
+* :class:`FromWKB() <django.contrib.gis.db.models.functions.FromWKB>` and
+ :class:`FromWKT() <django.contrib.gis.db.models.functions.FromWKT>` functions
+ now support the optional ``srid`` argument (except for Oracle where it is
+ ignored).
+
:mod:`django.contrib.messages`
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~