Acuan API QuerySet GISLink to this heading
Pencarian SpasialLink to this heading
Pencarian spasial dalam bagian ini tersedia untuk GeometryField dan RasterField.
For an introduction, see the spatial lookups introduction. For an overview of what lookups are compatible with a particular spatial backend, refer to the spatial lookup compatibility table.
Pencarian dengan rasterLink to this heading
Semua contoh dalam acuan dibawah diberikan untuk bidang-bidang dan masukan geometri, tetapi pencarian dapat menggunakan cara sama dengan raster pada kedua sisi. Kapanpun pencarian tidak mendukung amsukan raster, masukan otomatis dirubah ke geometri dimana dibutuhkan menggunakan fungsi ST_Polygon. Lihat juga introduction to raster lookups.
Penghubung basisdata digunakan oleh pencarian dapat dibagi menjadi tiga kategori:
Raster asli mendukung
N: penghubung menerima raster secara asli pada kedua sisi dari pencarian, dan masukan raster dapat dicampur dengan masukan geometri.Dukungan raster timbal balik
B: penghubung mendukung hanya raster jika kedua sisi dari pencarian menerima masukan raster. Data raster otomatis dirubah menjadi geometri untuk pencarian campuran.Dukungan perubahan geometri
C. Pencarian tidak memiliku dukungan raster asli, semua data raster otomatis dirubah ke geometri.
Contoh-contoh dibawah menunjukkan SQL setara untuk pencarian dalam jenis berbeda dari dukungan raster. Pola sama berlaku pada semua pencarian spasial.
Kasus |
Cari |
Setara SQL |
|---|---|---|
N, B |
|
|
N, B |
|
|
B, C |
|
|
B, C |
|
|
B, C |
|
|
B, C |
|
|
C |
|
|
C |
|
|
C |
|
|
C |
|
|
Pencarian spasial dengan raster hanya didukung untuk backend PostGIS (dinamai sebagai PGRaster dalam bagian ini).
bbcontainsLink to this heading
Ketersediaan: PostGIS, MariaDB, MySQL, SpatiaLite, PGRaster (Asli)
Coba jika geometri atau kotak pembatas bidang raster sepenuhnya mengandung pencarian kotak pembatas geometri.
Contoh:
Zipcode.objects.filter(poly__bbcontains=geom)
Backend |
Setara SQL |
|---|---|
PostGIS |
|
MariaDB |
|
MySQL |
|
SpatiaLite |
|
bboverlapsLink to this heading
Ketersediaan: PostGIS, MariaDB, MySQL, SpatiaLite, PGRaster (Asli)
Coba jika kotak pembatas bidang geometri tumpang tindih pencarian kotak pembatas geometri.
Contoh:
Zipcode.objects.filter(poly__bboverlaps=geom)
Backend |
Setara SQL |
|---|---|
PostGIS |
|
MariaDB |
|
MySQL |
|
SpatiaLite |
|
containedLink to this heading
Ketersediaan: PostGIS, MariaDB, MySQL, SpatiaLite, PGRaster (Asli)
Coba jika kotak pembatas bidang geometri sepenuhnya terkandung oleh pencarian kotak pembatas geometri.
Contoh:
Zipcode.objects.filter(poly__contained=geom)
Backend |
Setara SQL |
|---|---|
PostGIS |
|
MariaDB |
|
MySQL |
|
SpatiaLite |
|
containsLink to this heading
Ketersediaan: PostGIS, Oracle, MariaDB, MySQL, SpatiaLite, PGRaster (Timbal balik)
Dicoba jika bidang geometri secara spasial mengandung pencarian geometri.
Contoh:
Zipcode.objects.filter(poly__contains=geom)
Backend |
Setara SQL |
|---|---|
PostGIS |
|
Oracle |
|
MariaDB |
|
MySQL |
|
SpatiaLite |
|
contains_properlyLink to this heading
Tersedia: PostGIS, PGRaster (Timbal balik)
Mengembalikan true jika pencarian geometri memotong interior dari bidang geometri, tetapi bukan batas (atau eksterior).
Contoh:
Zipcode.objects.filter(poly__contains_properly=geom)
Backend |
Setara SQL |
|---|---|
PostGIS |
|
coveredbyLink to this heading
Availability: PostGIS, Oracle, MariaDB, MySQL, PGRaster (Bilateral), SpatiaLite
Uji jika tidak ada titik dalam bidang geometri diluar pencarian geometri. [3]
Contoh:
Zipcode.objects.filter(poly__coveredby=geom)
Backend |
Setara SQL |
|---|---|
PostGIS |
|
Oracle |
|
MariaDB |
|
MySQL |
|
SpatiaLite |
|
coversLink to this heading
Ketersediaan: PostGIS, Oracle, MySQL, PGRaster (Bilateral), SpatiaLite
Uji jika tidak ada titik dalam pencarian geometri diluar bidang geometri. [3]
Contoh:
Zipcode.objects.filter(poly__covers=geom)
Backend |
Setara SQL |
|---|---|
PostGIS |
|
Oracle |
|
MySQL |
|
SpatiaLite |
|
crossesLink to this heading
Ketersediaan: PostGIS, MariaDB, MySQL, SpatiaLite, PGRaster (Perubahan)
Uji jika bidang geometri secara spasial menyebrangi pencarian geometri.
Contoh:
Zipcode.objects.filter(poly__crosses=geom)
Backend |
Setara SQL |
|---|---|
PostGIS |
|
MariaDB |
|
MySQL |
|
SpatiaLite |
|
disjointLink to this heading
Ketersediaan: PostGIS, Oracle, MariaDB, MySQL, SpatiaLite, PGRaster (Timbal balik)
Coba jika bidang geometri secara spasial diuraikan dari pencarian geometri.
Contoh:
Zipcode.objects.filter(poly__disjoint=geom)
Backend |
Setara SQL |
|---|---|
PostGIS |
|
Oracle |
|
MariaDB |
|
MySQL |
|
SpatiaLite |
|
equalsLink to this heading
Ketersediaan: PostGIS, Oracle, MariaDB, MySQL, SpatiaLite, PGRaster (Perubahan)
Coba jika bidang geometri secara spasial setara pada pencarian geometri.
Contoh:
Zipcode.objects.filter(poly__equals=geom)
Backend |
Setara SQL |
|---|---|
PostGIS |
|
Oracle |
|
MariaDB |
|
MySQL |
|
SpatiaLite |
|
exact, same_asLink to this heading
Ketersediaan: PostGIS, Oracle, MariaDB, MySQL, SpatiaLite, PGRaster (Timbal balik)
Tests if the geometry field is "equal" to the lookup geometry. On Oracle, MySQL, and SpatiaLite, it tests spatial equality, while on PostGIS it tests equality of bounding boxes.
Contoh:
Zipcode.objects.filter(poly=geom)
Backend |
Setara SQL |
|---|---|
PostGIS |
|
Oracle |
|
MariaDB |
|
MySQL |
|
SpatiaLite |
|
intersectsLink to this heading
Ketersediaan: PostGIS, Oracle, MariaDB, MySQL, SpatiaLite, PGRaster (Timbal balik)
Coba jika bidang geometri secara spasial memotong pencarian geometri.
Contoh:
Zipcode.objects.filter(poly__intersects=geom)
Backend |
Setara SQL |
|---|---|
PostGIS |
|
Oracle |
|
MariaDB |
|
MySQL |
|
SpatiaLite |
|
isemptyLink to this heading
Ketersediaan: PostGIS
Tests if the geometry is empty.
Contoh:
Zipcode.objects.filter(poly__isempty=True)
isvalidLink to this heading
Availability: MariaDB, MySQL, PostGIS, Oracle, SpatiaLite
Coba jika geometri adalah sah.
Contoh:
Zipcode.objects.filter(poly__isvalid=True)
Backend |
Setara SQL |
|---|---|
MariaDB, MySQL, PostGIS, SpatiaLite |
|
Oracle |
|
geom_typeLink to this heading
Availability: PostGIS, Oracle 23c+, MariaDB, MySQL, SpatiaLite
Returns the geometry type of the geometry field.
Contoh:
Zipcode.objects.filter(poly__geom_type="POLYGON")
Backend |
Setara SQL |
|---|---|
PostGIS |
|
MariaDB |
|
MySQL |
|
Oracle |
|
SpatiaLite |
|
overlapsLink to this heading
Ketersediaan: PostGIS, Oracle, MariaDB, MySQL, SpatiaLite, PGRaster (Timbal balik)
Coba jika bidang geometri spasial tumpang tindih pencarian geometri.
Backend |
Setara SQL |
|---|---|
PostGIS |
|
Oracle |
|
MariaDB |
|
MySQL |
|
SpatiaLite |
|
relateLink to this heading
Ketersediaan: PostGIS, MariaDB, 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,
(geom, pattern); the form of pattern will depend on the spatial
backend:
MariaDB, PostGIS, and SpatiaLiteLink to this heading
On these spatial backends the intersection pattern is a string comprising nine
characters, which define intersections between the interior, boundary, and
exterior of the geometry field and the lookup geometry. The intersection
pattern matrix may only use the following characters: 1, 2, T,
F, or *. This lookup type allows users to "fine tune" a specific
geometric relationship consistent with the DE-9IM model. [1]
Contoh geometri:
# 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 and MariaDB SQL equivalent:
SELECT ... WHERE ST_Relate(poly, geom, 'T*T***FF*')
SpatiaLite SQL setara:
SELECT ... WHERE Relate(poly, geom, 'T*T***FF*')
Contoh raster:
Zipcode.objects.filter(poly__relate=(rast, 1, "T*T***FF*"))
Zipcode.objects.filter(rast__2__relate=(rast, 1, "T*T***FF*"))
PostGIS SQL setara:
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*')
OracleLink to this heading
Here the relation pattern is comprised of at least one of the nine relation
strings: TOUCH, OVERLAPBDYDISJOINT, OVERLAPBDYINTERSECT,
EQUAL, INSIDE, COVEREDBY, CONTAINS, COVERS, ON, and
ANYINTERACT. Multiple strings may be combined with the logical Boolean
operator OR, for example, 'inside+touch'. [2] The relation
strings are case-insensitive.
Contoh:
Zipcode.objects.filter(poly__relate=(geom, "anyinteract"))
Oracle SQL setara:
SELECT ... WHERE SDO_RELATE(poly, geom, 'anyinteract')
touchesLink to this heading
Ketersediaan: PostGIS, Oracle, MariaDB, MySQL, SpatiaLite
Coba jika bidang geometri secara spasial menyentuh pencarian geometri.
Contoh:
Zipcode.objects.filter(poly__touches=geom)
Backend |
Setara SQL |
|---|---|
PostGIS |
ST_Touches(poly, geom)`` |
MariaDB |
ST_Touches(poly, geom)`` |
MySQL |
ST_Touches(poly, geom)`` |
Oracle |
|
SpatiaLite |
|
withinLink to this heading
Ketersediaan: PostGIS, Oracle, MariaDB, MySQL, SpatiaLite, PGRaster (Timbal balik)
Coba jika bidang geomrtri secara spasial dalam pencarian geometri.
Contoh:
Zipcode.objects.filter(poly__within=geom)
Backend |
Setara SQL |
|---|---|
PostGIS |
|
MariaDB |
|
MySQL |
|
Oracle |
|
SpatiaLite |
|
leftLink to this heading
Tersedia: PostGIS, PGRaster (Perubahan)
Coba jika kotak pembatas bidang geometri ketat ke kiri dari pencarian kotak pembatas geometri.
Contoh:
Zipcode.objects.filter(poly__left=geom)
PostGIS setara:
SELECT ... WHERE poly << geom
rightLink to this heading
Tersedia: PostGIS, PGRaster (Perubahan)
Coba jika kotak pembatas bidang geometri tegas ke kanan dari pencarian kotak pembatas geometri.
Contoh:
Zipcode.objects.filter(poly__right=geom)
PostGIS setara:
SELECT ... WHERE poly >> geom
overlaps_leftLink to this heading
Tersedia: PostGIS, PGRaster (Timbal balik)
Coba jika kotak pencarian bidang geometri tumpang tindih atau ke kiri dari pencarian kotak pembatas geometri.
Contoh:
Zipcode.objects.filter(poly__overlaps_left=geom)
PostGIS setara:
SELECT ... WHERE poly &< geom
overlaps_rightLink to this heading
Tersedia: PostGIS, PGRaster (Timbal balik)
Coba jika kotak pencarian bidang geometri tumpang tindih atau ke kanan dari pencarian kotak pembatas geometri.
Contoh:
Zipcode.objects.filter(poly__overlaps_right=geom)
PostGIS setara:
SELECT ... WHERE poly &> geom
overlaps_aboveLink to this heading
Tersedia: PostGIS, PGRaster (Perubahan)
Coba jika kotak pembatas bidang geometri tumpang tindih atau diatas pencarian kotak pembatas geometri.
Contoh:
Zipcode.objects.filter(poly__overlaps_above=geom)
PostGIS setara:
SELECT ... WHERE poly |&> geom
overlaps_belowLink to this heading
Tersedia: PostGIS, PGRaster (Perubahan)
Coba jika kotak pembatas bidang geometri tumpang tindih atau dibawah pencarian kotak pembatas geometri.
Contoh:
Zipcode.objects.filter(poly__overlaps_below=geom)
PostGIS setara:
SELECT ... WHERE poly &<| geom
strictly_aboveLink to this heading
Tersedia: PostGIS, PGRaster (Perubahan)
Coba jika kotak pembatas bidang geometri ketat diatas pencarian kotak pembatas geometri.
Contoh:
Zipcode.objects.filter(poly__strictly_above=geom)
PostGIS setara:
SELECT ... WHERE poly |>> geom
strictly_belowLink to this heading
Tersedia: PostGIS, PGRaster (Perubahan)
Coba jika kotak pembatas bidang geometri ketat dibawah pencarian kotak pembatas geometri.
Contoh:
Zipcode.objects.filter(poly__strictly_below=geom)
PostGIS setara:
SELECT ... WHERE poly <<| geom
Pencarian JarakLink to this heading
Ketersediaan: PostGIS, Oracle, MariaDB, MySQL, SpatiaLite, PGRaster (Asli)
Untuk sebuah tinjauan pada melakukan permintaan jarak, hrap mengacu pada distance queries introduction.
Distance lookups take the following 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"])
The value passed into a distance lookup is a tuple; the first two
values are mandatory, and are the geometry to calculate distances to,
and a distance value (either a number in units of the field, a
Distance object, or a query
expression). To pass a band index to the lookup, use
a 3-tuple where the second entry is the band index.
Pada setiap pencarian jarak kecuali dwithin, sebuah unsur pilihan, 'spheroid', mungkin disertakan untuk digunakan lebih akurat fungsi perhitungan jarak bulatan dengan sistem kordinat geodetik.
Pada PostgreSQL, pilihan 'spheroid' menggunakan ST_DistanceSpheroid daripada ST_DistanceSphere. Fungsi ST_Distance paling sederhana digunakan dengan sistem kordinat yang sudah dihitung. Raster dirubah ke geometri untuk pencarian berdasarkan spheroid.
distance_gtLink to this heading
Mengembalikan model-model dimana jarak pada bidang geometri dari geometri pencarian lebih besar dari nilai jarak yang diberikan.
Contoh:
Zipcode.objects.filter(poly__distance_gt=(geom, D(m=5)))
Backend |
Setara SQL |
|---|---|
PostGIS |
|
MariaDB |
|
MySQL |
|
Oracle |
|
SpatiaLite |
|
distance_gteLink to this heading
Mengembalikan model-model dimana jarak pada bidang geometri dari geometri pencarian lebih besar dari atau setara pada nilai jarak diberikan.
Contoh:
Zipcode.objects.filter(poly__distance_gte=(geom, D(m=5)))
Backend |
Setara SQL |
|---|---|
PostGIS |
|
MariaDB |
|
MySQL |
|
Oracle |
|
SpatiaLite |
|
distance_ltLink to this heading
Mengembalikan model-model dimana jarak pada bidang geometri dari geometri pencarian kurang dari nilai jarak yang diberikan.
Contoh:
Zipcode.objects.filter(poly__distance_lt=(geom, D(m=5)))
Backend |
Setara SQL |
|---|---|
PostGIS |
|
MariaDB |
|
MySQL |
|
Oracle |
|
SpatiaLite |
|
distance_lteLink to this heading
Mengembalikan model-model dimana jarak pada bidang geometri dari geometri pencarian kurang dari atau setara pada nilai jarak yang diberikan.
Contoh:
Zipcode.objects.filter(poly__distance_lte=(geom, D(m=5)))
Backend |
Setara SQL |
|---|---|
PostGIS |
|
MariaDB |
|
MySQL |
|
Oracle |
|
SpatiaLite |
|
dwithinLink to this heading
Mengembalikan model-model dimana jarak pada bidang geometri dari geometri pencarian dalam jarak yang diberikan dari satu lainnya. Catat bahwa anda hanya dapat menyediakan obyek Distance jika geometri tersasar dalam sistem diperhitungkan. Untuk geometri geografis, anda harus menggunakan satuan dari bidang geometri (misalnya tingkatan untuk WGS84) .
Contoh:
Zipcode.objects.filter(poly__dwithin=(geom, D(m=5)))
Backend |
Setara SQL |
|---|---|
PostGIS |
|
Oracle |
|
SpatiaLite |
|
Fungsi KumpulanLink to this heading
Django menyediakan beberapa fungsi pengumpulan khusus-GIS. Untuk rincian pada bagaimana menggunakan fungsi-fungsi pengumpulan ini, lihat the topic guide on aggregation.
Argumen Katakunci |
Deskripsi |
|---|---|
|
This keyword is for Oracle only. It is for the
tolerance value used by the |
Example:
>>> from django.contrib.gis.db.models import Extent, Union
>>> WorldBorder.objects.aggregate(Extent("mpoly"), Union("mpoly"))
CollectLink to this heading
- class Collect(geo_field, filter=None)Link to this definition
Availability: PostGIS, MariaDB, MySQL, SpatiaLite
Returns a GEOMETRYCOLLECTION or a MULTI geometry object from the
geometry column. This is analogous to a simplified version of the
Union aggregate, except it can be several orders of magnitude faster
than performing a union because it rolls up geometries into a collection or
multi object, not caring about dissolving boundaries.
ExtentLink to this heading
- class Extent(geo_field, filter=None)Link to this definition
Tersedia: PostGIS, Oracle, SpatiaLite
Returns the extent of all geo_field in the QuerySet as a 4-tuple,
comprising the lower left coordinate and the upper right coordinate.
Example:
>>> qs = City.objects.filter(name__in=("Houston", "Dallas")).aggregate(Extent("poly"))
>>> print(qs["poly__extent"])
(-96.8016128540039, 29.7633724212646, -95.3631439208984, 32.782058715820)
Extent3DLink to this heading
- class Extent3D(geo_field, filter=None)Link to this definition
Tersedia: PostGIS
Returns the 3D extent of all geo_field in the QuerySet as a 6-tuple,
comprising the lower left coordinate and upper right coordinate (each with x,
y, and z coordinates).
Example:
>>> 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)
MakeLineLink to this heading
- class MakeLine(geo_field, filter=None)Link to this definition
Tersedia: PostGIS, SpatiaLite
Mengembalikan LineString dibangun dari geometri bidang titik dalam QuerySet. Saat ini pengurutan queryset tidak mempunyai pengaruh.
Example:
>>> qs = City.objects.filter(name__in=("Houston", "Dallas")).aggregate(MakeLine("poly"))
>>> print(qs["poly__makeline"])
LINESTRING (-95.3631510000000020 29.7633739999999989, -96.8016109999999941 32.7820570000000018)
UnionLink to this heading
- class Union(geo_field, filter=None)Link to this definition
Tersedia: PostGIS, Oracle, SpatiaLite
Metode ini mengembalikan obyek GEOSGeometry terdiri dari gabungan dari setiap geometri dalam queryset. Harap catat bahwa penggunaan dari Union diolah secara intensif dan mungkin mengambil jumlah signifikan waktu pada queryset besar.
Example:
>>> 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.
Catatan kaki