diff --git a/docs/ref/contrib/gis/geoquerysets.txt b/docs/ref/contrib/gis/geoquerysets.txt index ff559fc8cca..29856e10ab4 100644 --- a/docs/ref/contrib/gis/geoquerysets.txt +++ b/docs/ref/contrib/gis/geoquerysets.txt @@ -71,7 +71,8 @@ Spatial lookups with rasters are only supported for PostGIS backends ``bbcontains`` -------------- -*Availability*: PostGIS, MySQL, SpatiaLite, PGRaster (Native) +*Availability*: `PostGIS `__, +MySQL, SpatiaLite, PGRaster (Native) Tests if the geometry or raster field's bounding box completely contains the lookup geometry's bounding box. @@ -93,7 +94,8 @@ SpatiaLite ``MbrContains(poly, geom)`` ``bboverlaps`` -------------- -*Availability*: PostGIS, MySQL, SpatiaLite, PGRaster (Native) +*Availability*: `PostGIS `__, +MySQL, SpatiaLite, PGRaster (Native) Tests if the geometry field's bounding box overlaps the lookup geometry's bounding box. @@ -115,7 +117,8 @@ SpatiaLite ``MbrOverlaps(poly, geom)`` ``contained`` ------------- -*Availability*: PostGIS, MySQL, SpatiaLite, PGRaster (Native) +*Availability*: `PostGIS `__, +MySQL, SpatiaLite, PGRaster (Native) Tests if the geometry field's bounding box is completely contained by the lookup geometry's bounding box. @@ -137,7 +140,8 @@ SpatiaLite ``MbrWithin(poly, geom)`` ``contains`` ------------ -*Availability*: PostGIS, Oracle, MySQL, SpatiaLite, PGRaster (Bilateral) +*Availability*: `PostGIS `__, +Oracle, MySQL, SpatiaLite, PGRaster (Bilateral) Tests if the geometry field spatially contains the lookup geometry. @@ -159,10 +163,11 @@ SpatiaLite ``Contains(poly, geom)`` ``contains_properly`` --------------------- -*Availability*: PostGIS, PGRaster (Bilateral) +*Availability*: `PostGIS `__, +PGRaster (Bilateral) Returns true if the lookup geometry intersects the interior of the -geometry field, but not the boundary (or exterior). [#fncontainsproperly]_ +geometry field, but not the boundary (or exterior). Example:: @@ -179,7 +184,8 @@ PostGIS ``ST_ContainsProperly(poly, geom)`` ``coveredby`` ------------- -*Availability*: PostGIS, Oracle, PGRaster (Bilateral) +*Availability*: `PostGIS `__, +Oracle, PGRaster (Bilateral) Tests if no point in the geometry field is outside the lookup geometry. [#fncovers]_ @@ -200,7 +206,8 @@ Oracle ``SDO_COVEREDBY(poly, geom)`` ``covers`` ---------- -*Availability*: PostGIS, Oracle, PGRaster (Bilateral) +*Availability*: `PostGIS `__, +Oracle, PGRaster (Bilateral) Tests if no point in the lookup geometry is outside the geometry field. [#fncovers]_ @@ -221,7 +228,8 @@ Oracle ``SDO_COVERS(poly, geom)`` ``crosses`` ----------- -*Availability*: PostGIS, SpatiaLite, PGRaster (Conversion) +*Availability*: `PostGIS `__, +SpatiaLite, PGRaster (Conversion) Tests if the geometry field spatially crosses the lookup geometry. @@ -241,7 +249,8 @@ SpatiaLite ``Crosses(poly, geom)`` ``disjoint`` ------------ -*Availability*: PostGIS, Oracle, MySQL, SpatiaLite, PGRaster (Bilateral) +*Availability*: `PostGIS `__, +Oracle, MySQL, SpatiaLite, PGRaster (Bilateral) Tests if the geometry field is spatially disjoint from the lookup geometry. @@ -263,7 +272,8 @@ SpatiaLite ``Disjoint(poly, geom)`` ``equals`` ---------- -*Availability*: PostGIS, Oracle, MySQL, SpatiaLite, PGRaster (Conversion) +*Availability*: `PostGIS `__, +Oracle, MySQL, SpatiaLite, PGRaster (Conversion) .. fieldlookup:: exact .. fieldlookup:: same_as @@ -271,14 +281,16 @@ SpatiaLite ``Disjoint(poly, geom)`` ``exact``, ``same_as`` ---------------------- -*Availability*: PostGIS, Oracle, MySQL, SpatiaLite, PGRaster (Bilateral) +*Availability*: `PostGIS `__, +Oracle, MySQL, SpatiaLite, PGRaster (Bilateral) .. fieldlookup:: intersects ``intersects`` -------------- -*Availability*: PostGIS, Oracle, MySQL, SpatiaLite, PGRaster (Bilateral) +*Availability*: `PostGIS `__, +Oracle, MySQL, SpatiaLite, PGRaster (Bilateral) Tests if the geometry field spatially intersects the lookup geometry. @@ -302,7 +314,7 @@ SpatiaLite ``Intersects(poly, geom)`` .. versionadded:: 1.10 -*Availability*: PostGIS +*Availability*: `PostGIS `__ Tests if the geometry is valid. @@ -319,14 +331,16 @@ PostGIS equivalent:: ``overlaps`` ------------ -*Availability*: PostGIS, Oracle, MySQL, SpatiaLite, PGRaster (Bilateral) +*Availability*: `PostGIS `__, +Oracle, MySQL, SpatiaLite, PGRaster (Bilateral) .. fieldlookup:: relate ``relate`` ---------- -*Availability*: PostGIS, Oracle, SpatiaLite, PGRaster (Conversion) +*Availability*: `PostGIS `__, +Oracle, SpatiaLite, PGRaster (Conversion) Tests if the geometry field is spatially related to the lookup geometry by the values given in the given pattern. This lookup requires a tuple parameter, @@ -388,7 +402,8 @@ Oracle SQL equivalent:: ``touches`` ----------- -*Availability*: PostGIS, Oracle, MySQL, SpatiaLite +*Availability*: `PostGIS `__, +Oracle, MySQL, SpatiaLite Tests if the geometry field spatially touches the lookup geometry. @@ -410,7 +425,8 @@ SpatiaLite ``Touches(poly, geom)`` ``within`` ---------- -*Availability*: PostGIS, Oracle, MySQL, SpatiaLite, PGRaster (Bilateral) +*Availability*: `PostGIS `__, +Oracle, MySQL, SpatiaLite, PGRaster (Bilateral) Tests if the geometry field is spatially within the lookup geometry. @@ -432,7 +448,8 @@ SpatiaLite ``Within(poly, geom)`` ``left`` -------- -*Availability*: PostGIS, PGRaster (Conversion) +*Availability*: `PostGIS `__, +PGRaster (Conversion) Tests if the geometry field's bounding box is strictly to the left of the lookup geometry's bounding box. @@ -450,7 +467,8 @@ PostGIS equivalent:: ``right`` --------- -*Availability*: PostGIS, PGRaster (Conversion) +*Availability*: `PostGIS `__, +PGRaster (Conversion) Tests if the geometry field's bounding box is strictly to the right of the lookup geometry's bounding box. @@ -468,7 +486,8 @@ PostGIS equivalent:: ``overlaps_left`` ----------------- -*Availability*: PostGIS, PGRaster (Bilateral) +*Availability*: `PostGIS `__, +PGRaster (Bilateral) Tests if the geometry field's bounding box overlaps or is to the left of the lookup geometry's bounding box. @@ -487,7 +506,8 @@ PostGIS equivalent:: ``overlaps_right`` ------------------ -*Availability*: PostGIS, PGRaster (Bilateral) +*Availability*: `PostGIS `__, +PGRaster (Bilateral) Tests if the geometry field's bounding box overlaps or is to the right of the lookup geometry's bounding box. @@ -505,7 +525,8 @@ PostGIS equivalent:: ``overlaps_above`` ------------------ -*Availability*: PostGIS, PGRaster (Conversion) +*Availability*: `PostGIS `__, +PGRaster (Conversion) Tests if the geometry field's bounding box overlaps or is above the lookup geometry's bounding box. @@ -523,7 +544,8 @@ PostGIS equivalent:: ``overlaps_below`` ------------------ -*Availability*: PostGIS, PGRaster (Conversion) +*Availability*: `PostGIS `__, +PGRaster (Conversion) Tests if the geometry field's bounding box overlaps or is below the lookup geometry's bounding box. @@ -541,7 +563,8 @@ PostGIS equivalent:: ``strictly_above`` ------------------ -*Availability*: PostGIS, PGRaster (Conversion) +*Availability*: `PostGIS `__, +PGRaster (Conversion) Tests if the geometry field's bounding box is strictly above the lookup geometry's bounding box. @@ -559,7 +582,8 @@ PostGIS equivalent:: ``strictly_below`` ------------------ -*Availability*: PostGIS, PGRaster (Conversion) +*Availability*: `PostGIS `__, +PGRaster (Conversion) Tests if the geometry field's bounding box is strictly below the lookup geometry's bounding box. @@ -600,10 +624,12 @@ On every distance lookup except :lookup:`dwithin`, an optional element, ``'spheroid'``, may be included to use the more accurate spheroid distance calculation functions on fields with a geodetic coordinate system. -On PostgreSQL, the ``'spheroid'`` option uses ``ST_Distance_Spheroid`` instead -of ``ST_Distance_Sphere``. The simpler ``ST_Distance`` function is used with -projected coordinate systems. Rasters are converted to geometries for spheroid -based lookups. +On PostgreSQL, the ``'spheroid'`` option uses `ST_DistanceSpheroid +`__ instead of +`ST_DistanceSphere `__. The +simpler `ST_Distance `__ function is +used with projected coordinate systems. Rasters are converted to geometries for +spheroid based lookups. .. versionadded:: 1.10 @@ -1335,7 +1361,8 @@ Example:: .. class:: Collect(geo_field) -*Availability*: PostGIS, SpatiaLite +*Availability*: `PostGIS `__, +SpatiaLite Returns a ``GEOMETRYCOLLECTION`` or a ``MULTI`` geometry object from the geometry column. This is analogous to a simplified version of the :class:`Union` @@ -1348,7 +1375,8 @@ not caring about dissolving boundaries. .. class:: Extent(geo_field) -*Availability*: PostGIS, Oracle, SpatiaLite +*Availability*: `PostGIS `__, +Oracle, SpatiaLite Returns the extent of all ``geo_field`` in the ``QuerySet`` as a four-tuple, comprising the lower left coordinate and the upper right coordinate. @@ -1364,7 +1392,7 @@ Example:: .. class:: Extent3D(geo_field) -*Availability*: PostGIS +*Availability*: `PostGIS `__ Returns the 3D extent of all ``geo_field`` in the ``QuerySet`` as a six-tuple, comprising the lower left coordinate and upper right coordinate (each with x, y, @@ -1381,7 +1409,8 @@ Example:: .. class:: MakeLine(geo_field) -*Availability*: PostGIS, SpatiaLite +*Availability*: `PostGIS `__, +SpatiaLite Returns a ``LineString`` constructed from the point field geometries in the ``QuerySet``. Currently, ordering the queryset has no effect. @@ -1401,7 +1430,8 @@ Example:: .. class:: Union(geo_field) -*Availability*: PostGIS, Oracle, SpatiaLite +*Availability*: `PostGIS `__, +Oracle, SpatiaLite This method returns a :class:`~django.contrib.gis.geos.GEOSGeometry` object comprising the union of every geometry in the queryset. Please note that use of @@ -1422,4 +1452,3 @@ Example:: .. [#fnde9im] *See* `OpenGIS Simple Feature Specification For SQL `_, at Ch. 2.1.13.2, p. 2-13 (The Dimensionally Extended Nine-Intersection Model). .. [#fnsdorelate] *See* `SDO_RELATE documentation `_, from the Oracle Spatial and Graph Developer's Guide. .. [#fncovers] For an explanation of this routine, read `Quirks of the "Contains" Spatial Predicate `_ by Martin Davis (a PostGIS developer). -.. [#fncontainsproperly] Refer to the PostGIS ``ST_ContainsProperly`` `documentation `_ for more details.