GIS QuerySet API-referens¶
Rumsliga uppslagningar¶
De rumsliga uppslagningarna i detta avsnitt är tillgängliga för GeometryField
och RasterField
.
För en introduktion, se :ref:``spatial lookups introduction <spatial-lookups-intro>`. En översikt över vilka uppslagningar som är kompatibla med en viss spatial backend finns i :ref:``spatial lookup compatibility table <spatial-lookup-compatibility>`.
Uppslagningar med raster¶
Alla exempel i referensen nedan ges för geometriska fält och inmatningar, men uppslagningarna kan användas på samma sätt med raster på båda sidor. När en lookup inte stöder rasterinmatning konverteras inmatningen automatiskt till en geometri där så behövs med hjälp av funktionen `ST_Polygon <https://postgis.net/docs/RT_ST_Polygon.html>`_. Se även :ref:``introduktion till rasteruppslagningar <spatial-lookup-raster>`.
De databasoperatörer som används vid uppslagningarna kan delas in i tre kategorier:
Native raster support
N
: operatören accepterar raster på båda sidor av lookupen och rasterdata kan blandas med geometridata.Bilateralt rasterstöd
B
: operatören stöder raster endast om båda sidor av uppslagningen får rasterdata. Rasterdata konverteras automatiskt till geometrier för blandade uppslagningar.Stöd för geometriomvandling
C
. Lookupen har inget inbyggt stöd för raster, alla rasterdata konverteras automatiskt till geometrier.
Exemplen nedan visar SQL-motsvarigheten för uppslagningarna i de olika typerna av rasterstöd. Samma mönster gäller för alla spatiala uppslagningar.
Case |
Uppslag |
SQL-ekvivalent |
---|---|---|
N, B |
|
|
N, B |
|
|
B, C |
|
|
B, C |
|
|
B, C |
|
|
B, C |
|
|
C |
|
|
C |
|
|
C |
|
|
C |
|
|
Rumsliga uppslagningar med raster stöds endast för PostGIS-backends (benämns som PGRaster i detta avsnitt).
bbcontains
¶
Tillgänglighet: PostGIS, MariaDB, MySQL, SpatiaLite, PGRaster (inbyggd)
Testar om geometrins eller rasterfältets begränsningsbox helt och hållet innehåller uppslagsgeometrins begränsningsbox.
Exempel:
Zipcode.objects.filter(poly__bbcontains=geom)
Backend |
SQL-ekvivalent |
---|---|
PostGIS |
|
MariaDB |
|
MySQL |
|
SpatiaLite |
|
bboverlaps
¶
Tillgänglighet: PostGIS, MariaDB, MySQL, SpatiaLite, PGRaster (inbyggd)
Testar om geometrifältets avgränsningsbox överlappar uppslagsgeometrins avgränsningsbox.
Exempel:
Zipcode.objects.filter(poly__bboverlaps=geom)
Backend |
SQL-ekvivalent |
---|---|
PostGIS |
|
MariaDB |
|
MySQL |
|
SpatiaLite |
|
innehållen
¶
Tillgänglighet: PostGIS, MariaDB, MySQL, SpatiaLite, PGRaster (inbyggd)
Testar om geometrifältets avgränsningsbox är helt innesluten i uppslagsgeometrins avgränsningsbox.
Exempel:
Zipcode.objects.filter(poly__contained=geom)
Backend |
SQL-ekvivalent |
---|---|
PostGIS |
|
MariaDB |
|
MySQL |
|
SpatiaLite |
|
innehåller
¶
Tillgänglighet: PostGIS, Oracle, MariaDB, MySQL, SpatiaLite, PGRaster (Bilateral)
Testar om geometrifältet rumsligt innehåller uppslagsgeometrin.
Exempel:
Zipcode.objects.filter(poly__contains=geom)
Backend |
SQL-ekvivalent |
---|---|
PostGIS |
|
Oracle |
|
MariaDB |
|
MySQL |
|
SpatiaLite |
|
innehåller_riktigt
¶
Tillgänglighet: PostGIS, PGRaster (Bilateral)
Returnerar true om uppslagsgeometrin skär geometrins insida, men inte dess gräns (eller utsida).
Exempel:
Zipcode.objects.filter(poly__contains_properly=geom)
Backend |
SQL-ekvivalent |
---|---|
PostGIS |
|
”täckt av¶
Tillgänglighet: PostGIS, Oracle, MySQL, PGRaster (Bilateral), SpatiaLite
Testar om ingen punkt i geometrifältet ligger utanför lookup-geometrin. [3] _
Exempel:
Zipcode.objects.filter(poly__coveredby=geom)
Backend |
SQL-ekvivalent |
---|---|
PostGIS |
|
Oracle |
|
MySQL |
|
SpatiaLite |
|
Stöd för MySQL har lagts till.
överdrag
¶
Tillgänglighet: PostGIS, Oracle, MySQL, PGRaster (Bilateral), SpatiaLite
Testar om ingen punkt i uppslagsgeometrin ligger utanför geometrifältet. [3] _
Exempel:
Zipcode.objects.filter(poly__covers=geom)
Backend |
SQL-ekvivalent |
---|---|
PostGIS |
|
Oracle |
|
MySQL |
|
SpatiaLite |
|
Stöd för MySQL har lagts till.
korsningar
¶
Tillgänglighet: postGIS <https://postgis.net/docs/ST_Crosses.html>`__, MariaDB, MySQL, SpatiaLite, PGRaster (konvertering)
Testar om geometrifältet rumsligt korsar lookup-geometrin.
Exempel:
Zipcode.objects.filter(poly__crosses=geom)
Backend |
SQL-ekvivalent |
---|---|
PostGIS |
|
MariaDB |
|
MySQL |
|
SpatiaLite |
|
disjunkt
¶
Tillgänglighet: PostGIS, Oracle, MariaDB, MySQL, SpatiaLite, PGRaster (Bilateral)
Testar om geometrifältet är rumsligt åtskilt från uppslagsgeometrin.
Exempel:
Zipcode.objects.filter(poly__disjoint=geom)
Backend |
SQL-ekvivalent |
---|---|
PostGIS |
|
Oracle |
|
MariaDB |
|
MySQL |
|
SpatiaLite |
|
likvärdiga
¶
Tillgänglighet: PostGIS, Oracle, MariaDB, MySQL, SpatiaLite, PGRaster (Konvertering)
Testar om geometrifältet är rumsligt lika med uppslagsgeometrin.
Exempel:
Zipcode.objects.filter(poly__equals=geom)
Backend |
SQL-ekvivalent |
---|---|
PostGIS |
|
Oracle |
|
MariaDB |
|
MySQL |
|
SpatiaLite |
|
exakt
, lika_som
¶
Tillgänglighet: PostGIS, Oracle, MariaDB, MySQL, SpatiaLite, PGRaster (Bilateral)
Testar om geometrifältet är ”lika” med uppslagsgeometrin. På Oracle, MySQL och SpatiaLite testar det rumslig likhet, medan det på PostGIS testar likhet mellan begränsningsrutor.
Exempel:
Zipcode.objects.filter(poly=geom)
Backend |
SQL-ekvivalent |
---|---|
PostGIS |
|
Oracle |
|
MariaDB |
|
MySQL |
|
SpatiaLite |
|
skärningspunkter
¶
Tillgänglighet: PostGIS, Oracle, MariaDB, MySQL, SpatiaLite, PGRaster (Bilateral)
Testar om geometrifältet rumsligt korsar uppslagsgeometrin.
Exempel:
Zipcode.objects.filter(poly__intersects=geom)
Backend |
SQL-ekvivalent |
---|---|
PostGIS |
|
Oracle |
|
MariaDB |
|
MySQL |
|
SpatiaLite |
|
isempty
¶
Tillgänglighet: PostGIS
Testar om geometrin är tom.
Exempel:
Zipcode.objects.filter(poly__isempty=True)
isvalid
¶
Tillgänglighet: MySQL, PostGIS, Oracle, SpatiaLite
Testar om geometrin är giltig.
Exempel:
Zipcode.objects.filter(poly__isvalid=True)
Backend |
SQL-ekvivalent |
---|---|
MySQL, PostGIS, SpatiaLite |
|
Oracle |
|
överlappar
¶
Tillgänglighet: PostGIS, Oracle, MariaDB, MySQL, SpatiaLite, PGRaster (Bilateral)
Testar om geometrifältet spatialt överlappar lookup-geometrin.
Backend |
SQL-ekvivalent |
---|---|
PostGIS |
|
Oracle |
|
MariaDB |
|
MySQL |
|
SpatiaLite |
|
förhållande
¶
Tillgänglighet: PostGIS, MariaDB, Oracle, SpatiaLite, PGRaster (Konvertering)
Testar om geometrifältet är rumsligt relaterat till uppslagsgeometrin med de värden som anges i det givna mönstret. Denna sökning kräver en tuple-parameter, (geom, pattern)
; formen av pattern
beror på den spatiala backend:
MariaDB, PostGIS och SpatiaLite¶
I dessa rumsliga backends är intersektionsmönstret en sträng bestående av nio tecken som definierar intersektioner mellan geometrifältets insida, gräns och utsida och uppslagsgeometrin. Matrisen för intersektionsmönstret får endast innehålla följande tecken: 1
, 2
, T
, F
eller *
. Denna uppslagstyp gör det möjligt för användare att ”finjustera” ett specifikt geometriskt förhållande som överensstämmer med DE-9IM-modellen. [#fnde9im] _ _
Geometri exempel:
# A tuple lookup parameter is used to specify the geometry and
# the intersection pattern (the pattern here is for 'contains').
Zipcode.objects.filter(poly__relate=(geom, "T*T***FF*"))
PostGIS och MariaDB SQL motsvarande:
SELECT ... WHERE ST_Relate(poly, geom, 'T*T***FF*')
SpatiaLite SQL-ekvivalent:
SELECT ... WHERE Relate(poly, geom, 'T*T***FF*')
Rasterexempel:
Zipcode.objects.filter(poly__relate=(rast, 1, "T*T***FF*"))
Zipcode.objects.filter(rast__2__relate=(rast, 1, "T*T***FF*"))
PostGIS SQL-ekvivalent:
SELECT ... WHERE ST_Relate(poly, ST_Polygon(rast, 1), 'T*T***FF*')
SELECT ... WHERE ST_Relate(ST_Polygon(rast, 2), ST_Polygon(rast, 1), 'T*T***FF*')
Oracle¶
Här består relationsmönstret av minst en av de nio relationssträngarna: TOUCH
, OVERLAPBDYDISJOINT
, OVERLAPBDYINTERSECT
, EQUAL
, INSIDE
, COVEREDBY
, CONTAINS
, COVERS
, ON
och ANYINTERACT
. Flera strängar kan kombineras med den logiska booleska operatorn OR, till exempel 'inside+touch'
. [2] Relationssträngarna är okänsliga för stora och små bokstäver.
Exempel:
Zipcode.objects.filter(poly__relate=(geom, "anyinteract"))
Oracle SQL motsvarande:
SELECT ... WHERE SDO_RELATE(poly, geom, 'anyinteract')
touches
¶
Tillgänglighet: PostGIS, Oracle, MariaDB, MySQL, SpatiaLite
Testar om geometrifältet rumsligt berör uppslagsgeometrin.
Exempel:
Zipcode.objects.filter(poly__touches=geom)
Backend |
SQL-ekvivalent |
---|---|
PostGIS |
|
MariaDB |
|
MySQL |
|
Oracle |
|
SpatiaLite |
|
inom
¶
Tillgänglighet: PostGIS, Oracle, MariaDB, MySQL, SpatiaLite, PGRaster (Bilateral)
Testar om geometrifältet är rumsligt inom lookup-geometrin.
Exempel:
Zipcode.objects.filter(poly__within=geom)
Backend |
SQL-ekvivalent |
---|---|
PostGIS |
|
MariaDB |
|
MySQL |
|
Oracle |
|
SpatiaLite |
|
vänster
¶
Tillgänglighet: PostGIS, PGRaster (Konvertering)
Testar om geometrifältets avgränsningsbox ligger strikt till vänster om uppslagsgeometrins avgränsningsbox.
Exempel:
Zipcode.objects.filter(poly__left=geom)
PostGIS-ekvivalent:
SELECT ... WHERE poly << geom
höger
¶
Tillgänglighet: PostGIS, PGRaster (Konvertering)
Testar om geometrifältets avgränsningsbox ligger strikt till höger om uppslagsgeometrins avgränsningsbox.
Exempel:
Zipcode.objects.filter(poly__right=geom)
PostGIS-ekvivalent:
SELECT ... WHERE poly >> geom
överlappar_vänster
¶
Tillgänglighet: PostGIS, PGRaster (Bilateral)
Testar om geometrifältets avgränsningsbox överlappar eller är till vänster om uppslagsgeometrins avgränsningsbox.
Exempel:
Zipcode.objects.filter(poly__overlaps_left=geom)
PostGIS-ekvivalent:
SELECT ... WHERE poly &< geom
överlappar_höger
¶
Tillgänglighet: PostGIS, PGRaster (Bilateral)
Testar om geometrifältets avgränsningsbox överlappar eller är till höger om uppslagsgeometrins avgränsningsbox.
Exempel:
Zipcode.objects.filter(poly__overlaps_right=geom)
PostGIS-ekvivalent:
SELECT ... WHERE poly &> geom
överlappningar_över
¶
Tillgänglighet: PostGIS, PGRaster (Konvertering)
Testar om geometrifältets avgränsningsbox överlappar eller ligger ovanför uppslagsgeometrins avgränsningsbox.
Exempel:
Zipcode.objects.filter(poly__overlaps_above=geom)
PostGIS-ekvivalent:
SELECT ... WHERE poly |&> geom
överlappningar_under
¶
Tillgänglighet: PostGIS, PGRaster (Konvertering)
Testar om geometrifältets avgränsningsbox överlappar eller ligger under uppslagsgeometrins avgränsningsbox.
Exempel:
Zipcode.objects.filter(poly__overlaps_below=geom)
PostGIS-ekvivalent:
SELECT ... WHERE poly &<| geom
”strikt ovan¶
Tillgänglighet: PostGIS, PGRaster (Konvertering)
Testar om geometrifältets begränsningsbox är strikt ovanför uppslagsgeometrins begränsningsbox.
Exempel:
Zipcode.objects.filter(poly__strictly_above=geom)
PostGIS-ekvivalent:
SELECT ... WHERE poly |>> geom
strikt_under
¶
Tillgänglighet: PostGIS, PGRaster (Konvertering)
Testar om geometrifältets avgränsningsbox är strikt under uppslagsgeometrins avgränsningsbox.
Exempel:
Zipcode.objects.filter(poly__strictly_below=geom)
PostGIS-ekvivalent:
SELECT ... WHERE poly <<| geom
Uppslagning av avstånd¶
Tillgänglighet: PostGIS, Oracle, MariaDB, MySQL, SpatiaLite, PGRaster (inbyggd)
För en översikt över hur du utför avståndsfrågor, se :ref:introduktion till avståndsfrågor <distance-queries>
.
Distansuppslagningar har följande form:
<field>__<distance lookup>=(<geometry/raster>, <distance value>[, "spheroid"])
<field>__<distance lookup>=(<raster>, <band_index>, <distance value>[, "spheroid"])
<field>__<band_index>__<distance lookup>=(<raster>, <band_index>, <distance value>[, "spheroid"])
Värdet som skickas till en avståndsuppslagning är en tupel; de två första värdena är obligatoriska och är geometrin att beräkna avstånd till och ett avståndsvärde (antingen ett tal i fältets enheter, ett Distance
-objekt eller ett :doc:``query expression </ref/models/expressions>`). Om du vill skicka ett bandindex till uppslagningen använder du en 3-tupel där den andra posten är bandindexet.
För varje avståndsuppslagning utom dwithin
kan ett valfritt element, 'spheroid'
, inkluderas för att använda de mer exakta funktionerna för beräkning av sfäroidavstånd på fält med ett geodetiskt koordinatsystem.
På PostgreSQL använder alternativet 'spheroid'
ST_DistanceSpheroid istället för ST_DistanceSphere. Den enklare funktionen ST_Distance används med projicerade koordinatsystem. Rasters konverteras till geometrier för sfäroidbaserade uppslagningar.
avstånd_gt
¶
Returnerar modeller där avståndet till geometrifältet från uppslagsgeometrin är större än det angivna avståndsvärdet.
Exempel:
Zipcode.objects.filter(poly__distance_gt=(geom, D(m=5)))
Backend |
SQL-ekvivalent |
---|---|
PostGIS |
|
MariaDB |
|
MySQL |
|
Oracle |
|
SpatiaLite |
|
avstånd_gte
¶
Returnerar modeller där avståndet till geometrifältet från uppslagsgeometrin är större än eller lika med det angivna avståndsvärdet.
Exempel:
Zipcode.objects.filter(poly__distance_gte=(geom, D(m=5)))
Backend |
SQL-ekvivalent |
---|---|
PostGIS |
|
MariaDB |
|
MySQL |
|
Oracle |
|
SpatiaLite |
|
avstånd_lt
¶
Returnerar modeller där avståndet till geometrifältet från uppslagsgeometrin är mindre än det angivna avståndsvärdet.
Exempel:
Zipcode.objects.filter(poly__distance_lt=(geom, D(m=5)))
Backend |
SQL-ekvivalent |
---|---|
PostGIS |
|
MariaDB |
|
MySQL |
|
Oracle |
|
SpatiaLite |
|
avstånd_lte
¶
Returnerar modeller där avståndet till geometrifältet från uppslagsgeometrin är mindre än eller lika med det angivna avståndsvärdet.
Exempel:
Zipcode.objects.filter(poly__distance_lte=(geom, D(m=5)))
Backend |
SQL-ekvivalent |
---|---|
PostGIS |
|
MariaDB |
|
MySQL |
|
Oracle |
|
SpatiaLite |
|
inom
¶
Returnerar modeller där avståndet till geometrifältet från uppslagsgeometrin ligger inom det angivna avståndet från varandra. Observera att du endast kan tillhandahålla Distance
-objekt om de riktade geometrierna är i ett projicerat system. För geografiska geometrier bör du använda enheter i geometrifältet (t.ex. grader för WGS84
) .
Exempel:
Zipcode.objects.filter(poly__dwithin=(geom, D(m=5)))
Backend |
SQL-ekvivalent |
---|---|
PostGIS |
|
Oracle |
|
SpatiaLite |
|
Aggregerade funktioner¶
Django tillhandahåller några GIS-specifika aggregeringsfunktioner. För detaljer om hur du använder dessa aggregeringsfunktioner, se ämnesguiden om aggregering.
Sökord Argument |
Beskrivning |
---|---|
”Tolerans |
Detta nyckelord är endast för Oracle. Det är för det toleransvärde som används av proceduren |
Exempel:
>>> from django.contrib.gis.db.models import Extent, Union
>>> WorldBorder.objects.aggregate(Extent("mpoly"), Union("mpoly"))
Samla in
¶
Tillgänglighet: PostGIS, MySQL, SpatiaLite
Returnerar en GEOMETRYCOLLECTION
eller ett MULTI
geometriobjekt från geometrikolumnen. Detta är analogt med en förenklad version av aggregatet Union
, förutom att det kan vara flera storleksordningar snabbare än att utföra en union eftersom det rullar upp geometrier till en samling eller ett multiobjekt, utan att bry sig om att lösa upp gränser.
Stöd för MySQL 8.0.24+ har lagts till.
Extent
¶
Tillgänglighet: PostGIS, Oracle, SpatiaLite
Returnerar omfattningen av alla geo_field
i QuerySet
som en 4-tupel, bestående av den nedre vänstra koordinaten och den övre högra koordinaten.
Exempel:
>>> qs = City.objects.filter(name__in=("Houston", "Dallas")).aggregate(Extent("poly"))
>>> print(qs["poly__extent"])
(-96.8016128540039, 29.7633724212646, -95.3631439208984, 32.782058715820)
Extent3D
¶
Tillgänglighet: PostGIS
Returnerar 3D-utbredningen av alla geo_field
i QuerySet
som en 6-tupel, bestående av den nedre vänstra koordinaten och den övre högra koordinaten (var och en med x-, y- och z-koordinater).
Exempel:
>>> qs = City.objects.filter(name__in=("Houston", "Dallas")).aggregate(Extent3D("poly"))
>>> print(qs["poly__extent3d"])
(-96.8016128540039, 29.7633724212646, 0, -95.3631439208984, 32.782058715820, 0)
MakeLine
¶
Tillgänglighet: PostGIS, SpatiaLite
Returnerar en LineString
som konstruerats från punktfältsgeometrierna i QuerySet
. För närvarande har det ingen effekt att beställa frågeuppsättningen.
Exempel:
>>> qs = City.objects.filter(name__in=("Houston", "Dallas")).aggregate(MakeLine("poly"))
>>> print(qs["poly__makeline"])
LINESTRING (-95.3631510000000020 29.7633739999999989, -96.8016109999999941 32.7820570000000018)
Union
¶
Tillgänglighet: PostGIS, Oracle, SpatiaLite
Denna metod returnerar ett GEOSGeometry
-objekt som består av en sammanslagning av alla geometrier i frågeuppsättningen. Observera att användningen av Union
är processorkrävande och kan ta lång tid på stora frågeuppsättningar.
Observera
Om beräkningstiden för att använda denna metod är för dyr kan du överväga att använda Collect
istället.
Exempel:
>>> u = Zipcode.objects.aggregate(Union(poly)) # This may take a long time.
>>> u = Zipcode.objects.filter(poly__within=bbox).aggregate(
... Union(poly)
... ) # A more sensible approach.
Fotnoter