Fonctions de base de données géographiquesLien vers cette rubrique#

AreaLien vers cette rubrique#

class Area(expression, **extra)Lien vers cette définition#

Disponibilité : MariaDB, MySQL, Oracle, PostGIS, SpatiaLite

Accepte un seul champ ou expression géographique et renvoie l’aire du champ sous forme de mesure Area.

MySQL et SpatiaLite sans LWGEOM/RTTOPO ne prennent pas en charge les calculs d’aire sur des objets à système de référence géographique.

AsGeoJSONLien vers cette rubrique#

class AsGeoJSON(expression, bbox=False, crs=False, precision=8, **extra)Lien vers cette définition#

Disponibilité : MariaDB (≥ 10.2.4), MySQL (≥ 5.7.5), Oracle, PostGIS, SpatiaLite

Accepte un seul champ ou expression géographique et renvoie une représentation GeoJSON de l’objet géométrique. Notez que le résultat ne constitue pas une structure GeoJSON complète, mais seulement le contenu de la clé geometry d’une structure GeoJSON. Voir aussi Sérialisation GeoJSON.

Exemple :

>>> City.objects.annotate(json=AsGeoJSON('point')).get(name='Chicago').json
{"type":"Point","coordinates":[-87.65018,41.85039]}

AsGMLLien vers cette rubrique#

class AsGML(expression, version=2, precision=8, **extra)Lien vers cette définition#

Disponibilité : Oracle, PostGIS, SpatiaLite

Accepte un seul champ ou expression géographique et renvoie une représentation Geographic Markup Language (GML) du champ géométrique.

Exemple :

>>> qs = Zipcode.objects.annotate(gml=AsGML('poly'))
>>> print(qs[0].gml)
<gml:Polygon srsName="EPSG:4326"><gml:OuterBoundaryIs>-147.78711,70.245363 ...
-147.78711,70.245363</gml:OuterBoundaryIs></gml:Polygon>

AsKMLLien vers cette rubrique#

class AsKML(expression, precision=8, **extra)Lien vers cette définition#

Disponibilité : PostGIS, SpatiaLite

Accepte un seul champ ou expression géographique et renvoie une représentation Keyhole Markup Language (KML) du champ géométrique.

Exemple :

>>> qs = Zipcode.objects.annotate(kml=AsKML('poly'))
>>> print(qs[0].kml)
<Polygon><outerBoundaryIs><LinearRing><coordinates>-103.04135,36.217596,0 ...
-103.04135,36.217596,0</coordinates></LinearRing></outerBoundaryIs></Polygon>

AsSVGLien vers cette rubrique#

class AsSVG(expression, relative=False, precision=8, **extra)Lien vers cette définition#

Disponibilité : PostGIS, SpatiaLite

Accepte un seul champ ou expression géographique et renvoie une représentation Scalable Vector Graphics (SVG) du champ géométrique.

AsWKBLien vers cette rubrique#

class AsWKB(expression, **extra)Lien vers cette définition#

Disponibilité : MariaDB, MySQL, Oracle, PostGIS, SpatiaLite

Accepte un seul champ ou expression géographique et renvoie une représentation WKB (Well-known binary) du champ géométrique.

Exemple :

>>> 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@'

AsWKTLien vers cette rubrique#

class AsWKT(expression, **extra)Lien vers cette définition#

Disponibilité : MariaDB, MySQL, Oracle, PostGIS, SpatiaLite

Accepte un seul champ ou expression géographique et renvoie une représentation WKT (Well-known text) du champ géométrique.

Exemple :

>>> City.objects.annotate(wkt=AsWKT('point')).get(name='Chelyabinsk').wkt
'POINT (55.137555 61.451728)'

AzimuthLien vers cette rubrique#

class Azimuth(point_a, point_b, **extra)Lien vers cette définition#

Disponibilité : PostGIS, SpatiaLite (LWGEOM/RTTOPO)

Renvoie l’azimuth en radians du segment défini par les points géométriques donnés, ou None si les deux points coïncident. L’azimuth est un angle partant du nord et est positif dans le sens horaire : nord = 0; est = π/2; sud = π; ouest = 3π/2.

BoundingCircleLien vers cette rubrique#

class BoundingCircle(expression, num_seg=48, **extra)Lien vers cette définition#

Disponibilité : PostGIS, Oracle

Accepte un seul champ ou expression géographique et renvoie le polygone cercle le plus petit pouvant contenir entièrement l’objet géométrique.

Le paramètre num_seg et utilisé uniquement avec PostGIS.

CentroidLien vers cette rubrique#

class Centroid(expression, **extra)Lien vers cette définition#

Disponibilité : MariaDB, MySQL, PostGIS, Oracle, SpatiaLite

Accepte un seul champ ou expression géographique et renvoie la valeur centroïde de l’objet géométrique.

DifferenceLien vers cette rubrique#

class Difference(expr1, expr2, **extra)Lien vers cette définition#

Disponibilité : MariaDB, MySQL, PostGIS, Oracle, SpatiaLite

Accepte deux champs ou expressions géographiques et renvoie la différence géométrique, c’est-à-dire la part de l’objet A qui ne fait pas partie de son intersection avec l’objet B.

DistanceLien vers cette rubrique#

class Distance(expr1, expr2, spheroid=None, **extra)Lien vers cette définition#

Disponibilité : MariaDB, MySQL, PostGIS, Oracle, SpatiaLite

Accepte deux champs ou expressions géographiques et renvoie la distance entre les deux sous forme d’objet Distance. Avec MySQL, un nombre à virgule est renvoyé lorsque les coordonnées sont de type géodétique.

Pour les bases de données qui permettent de calculer des distances avec des coordonnées géodésiques, la bonne fonction de base de données est automatiquement sélectionnée en fonction de la valeur SRID des objets géométriques (par ex. ST_DistanceSphere avec PostGIS).

Lorsque les distances sont calculées avec des coordonnées géodésiques (angles), comme c’est le cas avec le SRID WGS84 (4326) par défaut, vous pouvez définir le paramètre nommé spheroid pour décider si le calcul doit se faire selon une sphère simple (moins précis, moins gourmand en ressources) ou sur un sphéroïde (plus précis, plus gourmand en ressources).

Dans l’exemple suivant, on calcule la distance entre la ville de Hobart vers tous les autres champs PointField du jeu de requête AustraliaCity:

>>> from django.contrib.gis.db.models.functions import Distance
>>> pnt = AustraliaCity.objects.get(name='Hobart').point
>>> for city in AustraliaCity.objects.annotate(distance=Distance('point', pnt)):
...     print(city.name, city.distance)
Wollongong 990071.220408 m
Shellharbour 972804.613941 m
Thirroul 1002334.36351 m
...

EnvelopeLien vers cette rubrique#

class Envelope(expression, **extra)Lien vers cette définition#

Disponibilité : MariaDB, MySQL, Oracle, PostGIS, SpatiaLite

Accepte un seul champ ou expression géographique et renvoie l’objet géométrique représentant le rectangle englobant de l’objet.

ForcePolygonCWLien vers cette rubrique#

class ForcePolygonCW(expression, **extra)Lien vers cette définition#

Disponibilité : PostGIS, SpatiaLite

Accepte un seul champ ou expression géographique et renvoie une version modifiée du (multi)polygone pour lequel tous les chemins extérieurs sont orientés dans le sens horaire et tous les chemins intérieurs sont orientés dans le sens antihoraire. Les géométries qui ne sont pas des polygones sont renvoyées inchangées.

GeoHashLien vers cette rubrique#

class GeoHash(expression, precision=None, **extra)Lien vers cette définition#

Disponibilité : MySQL (≥ 5.7.5), PostGIS, SpatiaLite (LWGEOM/RTTOPO)

Accepte un seul champ ou expression géographique et renvoie une représentation GeoHash du champ géométrique.

Le paramètre nommé precision contrôle le nombre de caractères du résultat.

GeometryDistanceLien vers cette rubrique#

class GeometryDistance(expr1, expr2, **extra)Lien vers cette définition#

Disponibilité : PostGIS

Accepte deux champs ou expressions géographiques et renvoie la distance entre les deux. Lorsqu’on l’utilise dans une clause order_by(), elle fournit des jeux de résultats selon le plus proche voisin sur la base des index.

IntersectionLien vers cette rubrique#

class Intersection(expr1, expr2, **extra)Lien vers cette définition#

Disponibilité : MariaDB, MySQL, PostGIS, Oracle, SpatiaLite

Accepte deux champs ou expressions géographiques et renvoie leur intersection géométrique.

IsValidLien vers cette rubrique#

class IsValid(expr)Lien vers cette définition#

Disponibilité : MySQL (≥ 5.7.5), PostGIS, Oracle, SpatiaLite

Accepte un champ ou une expression géographique et teste si la valeur est bien formée. Renvoie True si la valeur est un objet géométrique valide et False dans le cas contraire.

LengthLien vers cette rubrique#

class Length(expression, spheroid=True, **extra)Lien vers cette définition#

Disponibilité : MariaDB, MySQL, Oracle, PostGIS, SpatiaLite

Accepte un seul champ ou expression ligne ou multiligne géographique et renvoie sa longueur sous forme de mesure Distance.

Avec PostGIS ou SpatiaLite, et lorsque les coordonnées sont géodésiques (angles), vous pouvez définir avec le paramètre nommé spheroid si le calcul doit se faire selon une sphère simple (moins précis, moins gourmand en ressources) ou sur un sphéroïde (plus précis, plus gourmand en ressources).

MySQL ne prend pas en charge les calculs de longueur sur des objets à système de référence géographique.

LineLocatePointLien vers cette rubrique#

class LineLocatePoint(linestring, point, **extra)Lien vers cette définition#

Disponibilité : PostGIS, SpatiaLite

Renvoie un nombre à virgule entre 0 et 1 représentant l’emplacement du point de linestring le plus proche du point indiqué, sous forme de fraction de la longueur de la ligne 2D.

MakeValidLien vers cette rubrique#

class MakeValid(expr)Lien vers cette définition#

Disponibilité : PostGIS, SpatiaLite (LWGEOM/RTTOPO)

Accepte un champ ou une expression géographique et essaye de convertir la valeur en une géométrie valide sans perdre aucun des segments originaux. Les objets déjà valides sont renvoyés tels quels. Des polygones simples peuvent devenir des multipolygones et le résultat peut être d’une dimension inférieure à l’objet en entrée.

MemSizeLien vers cette rubrique#

class MemSize(expression, **extra)Lien vers cette définition#

Disponibilité : PostGIS

Accepte un seul champ ou expression géographique et renvoie la taille mémoire (en octets) consommé par le champ géométrique.

NumGeometriesLien vers cette rubrique#

class NumGeometries(expression, **extra)Lien vers cette définition#

Disponibilité : MariaDB, MySQL, PostGIS, Oracle, SpatiaLite

Accepte un seul champ ou expression géographique et renvoie le nombre d’objets géométriques dans le cas où le champ est une collection (par ex. GEOMETRYCOLLECTION ou un champ MULTI*). Renvoie 1 pour des objets géométriques uniques.

Avec MySQL, renvoie None pour des objets géométriques uniques.

NumPointsLien vers cette rubrique#

class NumPoints(expression, **extra)Lien vers cette définition#

Disponibilité : MariaDB, MySQL, PostGIS, Oracle, SpatiaLite

Accepte un seul champ ou expression géographique et renvoie le nombre de points de l’objet géométrique.

Avec MySQL, renvoie None pour les objets géométriques autres que LINESTRING.

PerimeterLien vers cette rubrique#

class Perimeter(expression, **extra)Lien vers cette définition#

Disponibilité : PostGIS, Oracle, SpatiaLite

Accepte un seul champ ou expression géographique et renvoie le périmètre du champ sous forme de mesure Distance.

PointOnSurfaceLien vers cette rubrique#

class PointOnSurface(expression, **extra)Lien vers cette définition#

Disponibilité : PostGIS, MariaDB, Oracle, SpatiaLite

Accepte un seul champ ou expression géographique et renvoie un objet Point qui se trouve avec certitude dans la surface du champ ; sinon renvoie None.

ReverseLien vers cette rubrique#

class Reverse(expression, **extra)Lien vers cette définition#

Disponibilité : PostGIS, Oracle, SpatiaLite

Accepte un seul champ ou expression géographique et renvoie un objet géométrique avec les coordonnées inversées.

ScaleLien vers cette rubrique#

class Scale(expression, x, y, z=0.0, **extra)Lien vers cette définition#

Disponibilité : PostGIS, SpatiaLite

Accepte un seul champ ou expression géographique et renvoie un objet géométrique avec ses coordonnées mises à l’échelle en les multipliant par les paramètres x, y et facultativement, z.

SnapToGridLien vers cette rubrique#

class SnapToGrid(expression, *args, **extra)Lien vers cette définition#

Disponibilité : PostGIS, SpatiaLite

Accepte un seul champ ou expression géographique et renvoie un objet géométrique dont tous les points sont ajustés à la grille donnée. La manière d’ajuster l’objet géométrique à la grille dépend du nombre de paramètres numériques fournis (des nombres à virgule, entiers ou entiers longs).

SymDifferenceLien vers cette rubrique#

class SymDifference(expr1, expr2, **extra)Lien vers cette définition#

Disponibilité : MariaDB, MySQL, PostGIS, Oracle, SpatiaLite

Accepte deux champs ou expressions géographiques et renvoie la différence géométrique symétrique (union sans l’intersection) entre les paramètres données.

TransformLien vers cette rubrique#

class Transform(expression, srid, **extra)Lien vers cette définition#

Disponibilité : PostGIS, Oracle, SpatiaLite

Accepte un champ ou expression géographique et un code SRID nombre entier, et renvoie l’objet géométrique transformé dans le système de référence spatiale indiqué par le paramètre srid.

TranslateLien vers cette rubrique#

class Translate(expression, x, y, z=0.0, **extra)Lien vers cette définition#

Disponibilité : PostGIS, SpatiaLite

Accepte un seul champ ou expression géographique et renvoie un objet géométrique avec ses coordonnées décalées en fonction des paramètres x, y et facultativement, z.

UnionLien vers cette rubrique#

class Union(expr1, expr2, **extra)Lien vers cette définition#

Disponibilité : MariaDB, MySQL, PostGIS, Oracle, SpatiaLite

Accepte deux champs ou expressions géographiques et renvoie l’union des deux.