{"title":"GIS QuerySet API Reference","version":"3.1","locale":"ko","docname":"ref/contrib/gis/geoquerysets","url":"/ko/3.1/ref/contrib/gis/geoquerysets/","canonical":"https://djangodocs.dev/ko/3.1/ref/contrib/gis/geoquerysets/","summary":"Spatial Lookups Link to this heading # The spatial lookups in this section are available for GeometryField and RasterField . For an introduction, see the spatial…","html":"

GIS QuerySet API ReferenceLink to this heading#

\n
\n

Spatial LookupsLink to this heading#

\n

The spatial lookups in this section are available for GeometryField\nand RasterField.

\n

For an introduction, see the spatial lookups introduction. For an overview of what lookups are\ncompatible with a particular spatial backend, refer to the\nspatial lookup compatibility table.

\n
\n

Lookups with rastersLink to this heading#

\n

All examples in the reference below are given for geometry fields and inputs,\nbut the lookups can be used the same way with rasters on both sides. Whenever\na lookup doesn’t support raster input, the input is automatically\nconverted to a geometry where necessary using the ST_Polygon function. See also the\nintroduction to raster lookups.

\n

The database operators used by the lookups can be divided into three categories:

\n\n

The examples below show the SQL equivalent for the lookups in the different\ntypes of raster support. The same pattern applies to all spatial lookups.

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Case

Lookup

SQL Equivalent

N, B

rast__contains=rst

ST_Contains(rast, rst)

N, B

rast__1__contains=(rst, 2)

ST_Contains(rast, 1, rst, 2)

B, C

rast__contains=geom

ST_Contains(ST_Polygon(rast), geom)

B, C

rast__1__contains=geom

ST_Contains(ST_Polygon(rast, 1), geom)

B, C

poly__contains=rst

ST_Contains(poly, ST_Polygon(rst))

B, C

poly__contains=(rst, 1)

ST_Contains(poly, ST_Polygon(rst, 1))

C

rast__crosses=rst

ST_Crosses(ST_Polygon(rast), ST_Polygon(rst))

C

rast__1__crosses=(rst, 2)

ST_Crosses(ST_Polygon(rast, 1), ST_Polygon(rst, 2))

C

rast__crosses=geom

ST_Crosses(ST_Polygon(rast), geom)

C

poly__crosses=rst

ST_Crosses(poly, ST_Polygon(rst))

\n
\n

Spatial lookups with rasters are only supported for PostGIS backends\n(denominated as PGRaster in this section).

\n
\n
\n

bbcontainsLink to this heading#

\n

Availability: PostGIS,\nMariaDB, MySQL, SpatiaLite, PGRaster (Native)

\n

Tests if the geometry or raster field’s bounding box completely contains the\nlookup geometry’s bounding box.

\n

Example:

\n
Code
Zipcode.objects.filter(poly__bbcontains=geom)\n
\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Backend

SQL Equivalent

PostGIS

poly ~ geom

MariaDB

MBRContains(poly, geom)

MySQL

MBRContains(poly, geom)

SpatiaLite

MbrContains(poly, geom)

\n
\n
\n
\n

bboverlapsLink to this heading#

\n

Availability: PostGIS,\nMariaDB, MySQL, SpatiaLite, PGRaster (Native)

\n

Tests if the geometry field’s bounding box overlaps the lookup geometry’s\nbounding box.

\n

Example:

\n
Code
Zipcode.objects.filter(poly__bboverlaps=geom)\n
\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Backend

SQL Equivalent

PostGIS

poly && geom

MariaDB

MBROverlaps(poly, geom)

MySQL

MBROverlaps(poly, geom)

SpatiaLite

MbrOverlaps(poly, geom)

\n
\n
\n
\n

containedLink to this heading#

\n

Availability: PostGIS,\nMariaDB, MySQL, SpatiaLite, PGRaster (Native)

\n

Tests if the geometry field’s bounding box is completely contained by the\nlookup geometry’s bounding box.

\n

Example:

\n
Code
Zipcode.objects.filter(poly__contained=geom)\n
\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Backend

SQL Equivalent

PostGIS

poly @ geom

MariaDB

MBRWithin(poly, geom)

MySQL

MBRWithin(poly, geom)

SpatiaLite

MbrWithin(poly, geom)

\n
\n
\n
\n

containsLink to this heading#

\n

Availability: PostGIS,\nOracle, MariaDB, MySQL, SpatiaLite, PGRaster (Bilateral)

\n

Tests if the geometry field spatially contains the lookup geometry.

\n

Example:

\n
Code
Zipcode.objects.filter(poly__contains=geom)\n
\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Backend

SQL Equivalent

PostGIS

ST_Contains(poly, geom)

Oracle

SDO_CONTAINS(poly, geom)

MariaDB

ST_Contains(poly, geom)

MySQL

ST_Contains(poly, geom)

SpatiaLite

Contains(poly, geom)

\n
\n\n
\n
\n

contains_properlyLink to this heading#

\n

Availability: PostGIS,\nPGRaster (Bilateral)

\n

Returns true if the lookup geometry intersects the interior of the\ngeometry field, but not the boundary (or exterior).

\n

Example:

\n
Code
Zipcode.objects.filter(poly__contains_properly=geom)\n
\n
\n\n\n\n\n\n\n\n\n\n\n

Backend

SQL Equivalent

PostGIS

ST_ContainsProperly(poly, geom)

\n
\n
\n
\n

coveredbyLink to this heading#

\n

Availability: PostGIS,\nOracle, PGRaster (Bilateral), SpatiaLite

\n

Tests if no point in the geometry field is outside the lookup geometry.\n[3]

\n

Example:

\n
Code
Zipcode.objects.filter(poly__coveredby=geom)\n
\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Backend

SQL Equivalent

PostGIS

ST_CoveredBy(poly, geom)

Oracle

SDO_COVEREDBY(poly, geom)

SpatiaLite

CoveredBy(poly, geom)

\n
\n
\n
\n

coversLink to this heading#

\n

Availability: PostGIS,\nOracle, PGRaster (Bilateral), SpatiaLite

\n

Tests if no point in the lookup geometry is outside the geometry field.\n[3]

\n

Example:

\n
Code
Zipcode.objects.filter(poly__covers=geom)\n
\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Backend

SQL Equivalent

PostGIS

ST_Covers(poly, geom)

Oracle

SDO_COVERS(poly, geom)

SpatiaLite

Covers(poly, geom)

\n
\n
\n
\n

crossesLink to this heading#

\n

Availability: PostGIS,\nMariaDB, MySQL, SpatiaLite, PGRaster (Conversion)

\n

Tests if the geometry field spatially crosses the lookup geometry.

\n

Example:

\n
Code
Zipcode.objects.filter(poly__crosses=geom)\n
\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Backend

SQL Equivalent

PostGIS

ST_Crosses(poly, geom)

MariaDB

ST_Crosses(poly, geom)

MySQL

ST_Crosses(poly, geom)

SpatiaLite

Crosses(poly, geom)

\n
\n\n
\n
\n

disjointLink to this heading#

\n

Availability: PostGIS,\nOracle, MariaDB, MySQL, SpatiaLite, PGRaster (Bilateral)

\n

Tests if the geometry field is spatially disjoint from the lookup geometry.

\n

Example:

\n
Code
Zipcode.objects.filter(poly__disjoint=geom)\n
\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Backend

SQL Equivalent

PostGIS

ST_Disjoint(poly, geom)

Oracle

SDO_GEOM.RELATE(poly, 'DISJOINT', geom, 0.05)

MariaDB

ST_Disjoint(poly, geom)

MySQL

ST_Disjoint(poly, geom)

SpatiaLite

Disjoint(poly, geom)

\n
\n\n
\n
\n

equalsLink to this heading#

\n

Availability: PostGIS,\nOracle, MariaDB, MySQL, SpatiaLite, PGRaster (Conversion)

\n

Tests if the geometry field is spatially equal to the lookup geometry.

\n

Example:

\n
Code
Zipcode.objects.filter(poly__equals=geom)\n
\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Backend

SQL Equivalent

PostGIS

ST_Equals(poly, geom)

Oracle

SDO_EQUAL(poly, geom)

MariaDB

ST_Equals(poly, geom)

MySQL

ST_Equals(poly, geom)

SpatiaLite

Equals(poly, geom)

\n
\n\n
\n
\n

exact, same_asLink to this heading#

\n

Availability: PostGIS,\nOracle, MariaDB, MySQL, SpatiaLite, PGRaster (Bilateral)

\n

Tests if the geometry field is “equal” to the lookup geometry. On Oracle,\nMySQL, and SpatiaLite, it tests spatial equality, while on PostGIS it tests\nequality of bounding boxes.

\n

Example:

\n
Code
Zipcode.objects.filter(poly=geom)\n
\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Backend

SQL Equivalent

PostGIS

poly ~= geom

Oracle

SDO_EQUAL(poly, geom)

MariaDB

ST_Equals(poly, geom)

MySQL

ST_Equals(poly, geom)

SpatiaLite

Equals(poly, geom)

\n
\n\n
\n
\n

intersectsLink to this heading#

\n

Availability: PostGIS,\nOracle, MariaDB, MySQL, SpatiaLite, PGRaster (Bilateral)

\n

Tests if the geometry field spatially intersects the lookup geometry.

\n

Example:

\n
Code
Zipcode.objects.filter(poly__intersects=geom)\n
\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Backend

SQL Equivalent

PostGIS

ST_Intersects(poly, geom)

Oracle

SDO_OVERLAPBDYINTERSECT(poly, geom)

MariaDB

ST_Intersects(poly, geom)

MySQL

ST_Intersects(poly, geom)

SpatiaLite

Intersects(poly, geom)

\n
\n\n
\n
\n

isvalidLink to this heading#

\n

Availability: MySQL (≥ 5.7.5), PostGIS, Oracle, SpatiaLite

\n

Tests if the geometry is valid.

\n

Example:

\n
Code
Zipcode.objects.filter(poly__isvalid=True)\n
\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Backend

SQL Equivalent

MySQL, PostGIS, SpatiaLite

ST_IsValid(poly)

Oracle

SDO_GEOM.VALIDATE_GEOMETRY_WITH_CONTEXT(poly, 0.05) = 'TRUE'

\n
\n
\n
\n

overlapsLink to this heading#

\n

Availability: PostGIS,\nOracle, MariaDB, MySQL, SpatiaLite, PGRaster (Bilateral)

\n

Tests if the geometry field spatially overlaps the lookup geometry.

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Backend

SQL Equivalent

PostGIS

ST_Overlaps(poly, geom)

Oracle

SDO_OVERLAPS(poly, geom)

MariaDB

ST_Overlaps(poly, geom)

MySQL

ST_Overlaps(poly, geom)

SpatiaLite

Overlaps(poly, geom)

\n
\n\n
\n
\n

relateLink to this heading#

\n

Availability: PostGIS,\nMariaDB, Oracle, SpatiaLite, PGRaster (Conversion)

\n

Tests if the geometry field is spatially related to the lookup geometry by\nthe values given in the given pattern. This lookup requires a tuple parameter,\n(geom, pattern); the form of pattern will depend on the spatial backend:

\n
\n

MariaDB, PostGIS, and SpatiaLiteLink to this heading#

\n

On these spatial backends the intersection pattern is a string comprising\nnine characters, which define intersections between the interior, boundary,\nand exterior of the geometry field and the lookup geometry.\nThe intersection pattern matrix may only use the following characters:\n1, 2, T, F, or *. This lookup type allows users to “fine tune”\na specific geometric relationship consistent with the DE-9IM model. [1]

\n

Geometry example:

\n
Code
# A tuple lookup parameter is used to specify the geometry and\n# the intersection pattern (the pattern here is for 'contains').\nZipcode.objects.filter(poly__relate=(geom, 'T*T***FF*'))\n
\n

PostGIS and MariaDB SQL equivalent:

\n
SQL
SELECT ... WHERE ST_Relate(poly, geom, 'T*T***FF*')\n
\n

SpatiaLite SQL equivalent:

\n
SQL
SELECT ... WHERE Relate(poly, geom, 'T*T***FF*')\n
\n

Raster example:

\n
Code
Zipcode.objects.filter(poly__relate=(rast, 1, 'T*T***FF*'))\nZipcode.objects.filter(rast__2__relate=(rast, 1, 'T*T***FF*'))\n
\n

PostGIS SQL equivalent:

\n
SQL
SELECT ... WHERE ST_Relate(poly, ST_Polygon(rast, 1), 'T*T***FF*')\nSELECT ... WHERE ST_Relate(ST_Polygon(rast, 2), ST_Polygon(rast, 1), 'T*T***FF*')\n
\n\n
\n
\n

OracleLink to this heading#

\n

Here the relation pattern is comprised of at least one of the nine relation\nstrings: TOUCH, OVERLAPBDYDISJOINT, OVERLAPBDYINTERSECT,\nEQUAL, INSIDE, COVEREDBY, CONTAINS, COVERS, ON, and\nANYINTERACT. Multiple strings may be combined with the logical Boolean\noperator OR, for example, 'inside+touch'. [2] The relation\nstrings are case-insensitive.

\n

Example:

\n
Code
Zipcode.objects.filter(poly__relate=(geom, 'anyinteract'))\n
\n

Oracle SQL equivalent:

\n
SQL
SELECT ... WHERE SDO_RELATE(poly, geom, 'anyinteract')\n
\n
\n
\n
\n

touchesLink to this heading#

\n

Availability: PostGIS,\nOracle, MariaDB, MySQL, SpatiaLite

\n

Tests if the geometry field spatially touches the lookup geometry.

\n

Example:

\n
Code
Zipcode.objects.filter(poly__touches=geom)\n
\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Backend

SQL Equivalent

PostGIS

ST_Touches(poly, geom)

MariaDB

ST_Touches(poly, geom)

MySQL

ST_Touches(poly, geom)

Oracle

SDO_TOUCH(poly, geom)

SpatiaLite

Touches(poly, geom)

\n
\n\n
\n
\n

withinLink to this heading#

\n

Availability: PostGIS,\nOracle, MariaDB, MySQL, SpatiaLite, PGRaster (Bilateral)

\n

Tests if the geometry field is spatially within the lookup geometry.

\n

Example:

\n
Code
Zipcode.objects.filter(poly__within=geom)\n
\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Backend

SQL Equivalent

PostGIS

ST_Within(poly, geom)

MariaDB

ST_Within(poly, geom)

MySQL

ST_Within(poly, geom)

Oracle

SDO_INSIDE(poly, geom)

SpatiaLite

Within(poly, geom)

\n
\n\n
\n
\n

leftLink to this heading#

\n

Availability: PostGIS,\nPGRaster (Conversion)

\n

Tests if the geometry field’s bounding box is strictly to the left of the\nlookup geometry’s bounding box.

\n

Example:

\n
Code
Zipcode.objects.filter(poly__left=geom)\n
\n

PostGIS equivalent:

\n
SQL
SELECT ... WHERE poly << geom\n
\n
\n
\n

rightLink to this heading#

\n

Availability: PostGIS,\nPGRaster (Conversion)

\n

Tests if the geometry field’s bounding box is strictly to the right of the\nlookup geometry’s bounding box.

\n

Example:

\n
Code
Zipcode.objects.filter(poly__right=geom)\n
\n

PostGIS equivalent:

\n
SQL
SELECT ... WHERE poly >> geom\n
\n
\n
\n

overlaps_leftLink to this heading#

\n

Availability: PostGIS,\nPGRaster (Bilateral)

\n

Tests if the geometry field’s bounding box overlaps or is to the left of the lookup\ngeometry’s bounding box.

\n

Example:

\n
Code
Zipcode.objects.filter(poly__overlaps_left=geom)\n
\n

PostGIS equivalent:

\n
SQL
SELECT ... WHERE poly &< geom\n
\n
\n
\n

overlaps_rightLink to this heading#

\n

Availability: PostGIS,\nPGRaster (Bilateral)

\n

Tests if the geometry field’s bounding box overlaps or is to the right of the lookup\ngeometry’s bounding box.

\n

Example:

\n
Code
Zipcode.objects.filter(poly__overlaps_right=geom)\n
\n

PostGIS equivalent:

\n
SQL
SELECT ... WHERE poly &> geom\n
\n
\n
\n

overlaps_aboveLink to this heading#

\n

Availability: PostGIS,\nPGRaster (Conversion)

\n

Tests if the geometry field’s bounding box overlaps or is above the lookup\ngeometry’s bounding box.

\n

Example:

\n
Code
Zipcode.objects.filter(poly__overlaps_above=geom)\n
\n

PostGIS equivalent:

\n
SQL
SELECT ... WHERE poly |&> geom\n
\n
\n
\n

overlaps_belowLink to this heading#

\n

Availability: PostGIS,\nPGRaster (Conversion)

\n

Tests if the geometry field’s bounding box overlaps or is below the lookup\ngeometry’s bounding box.

\n

Example:

\n
Code
Zipcode.objects.filter(poly__overlaps_below=geom)\n
\n

PostGIS equivalent:

\n
SQL
SELECT ... WHERE poly &<| geom\n
\n
\n
\n

strictly_aboveLink to this heading#

\n

Availability: PostGIS,\nPGRaster (Conversion)

\n

Tests if the geometry field’s bounding box is strictly above the lookup\ngeometry’s bounding box.

\n

Example:

\n
Code
Zipcode.objects.filter(poly__strictly_above=geom)\n
\n

PostGIS equivalent:

\n
SQL
SELECT ... WHERE poly |>> geom\n
\n
\n
\n

strictly_belowLink to this heading#

\n

Availability: PostGIS,\nPGRaster (Conversion)

\n

Tests if the geometry field’s bounding box is strictly below the lookup\ngeometry’s bounding box.

\n

Example:

\n
Code
Zipcode.objects.filter(poly__strictly_below=geom)\n
\n

PostGIS equivalent:

\n
SQL
SELECT ... WHERE poly <<| geom\n
\n
\n
\n
\n

Distance LookupsLink to this heading#

\n

Availability: PostGIS, Oracle, MariaDB, MySQL, SpatiaLite, PGRaster (Native)

\n

For an overview on performing distance queries, please refer to\nthe distance queries introduction.

\n

Distance lookups take the following form:

\n
Code
<field>__<distance lookup>=(<geometry/raster>, <distance value>[, 'spheroid'])\n<field>__<distance lookup>=(<raster>, <band_index>, <distance value>[, 'spheroid'])\n<field>__<band_index>__<distance lookup>=(<raster>, <band_index>, <distance value>[, 'spheroid'])\n
\n

The value passed into a distance lookup is a tuple; the first two\nvalues are mandatory, and are the geometry to calculate distances to,\nand a distance value (either a number in units of the field, a\nDistance object, or a query\nexpression). To pass a band index to the lookup, use\na 3-tuple where the second entry is the band index.

\n

On every distance lookup except dwithin, an optional element,\n'spheroid', may be included to use the more accurate spheroid distance\ncalculation functions on fields with a geodetic coordinate system.

\n

On PostgreSQL, the 'spheroid' option uses ST_DistanceSpheroid instead of\nST_DistanceSphere. The\nsimpler ST_Distance function is\nused with projected coordinate systems. Rasters are converted to geometries for\nspheroid based lookups.

\n
\n

distance_gtLink to this heading#

\n

Returns models where the distance to the geometry field from the lookup\ngeometry is greater than the given distance value.

\n

Example:

\n
Code
Zipcode.objects.filter(poly__distance_gt=(geom, D(m=5)))\n
\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Backend

SQL Equivalent

PostGIS

ST_Distance/ST_Distance_Sphere(poly, geom) > 5

MariaDB

ST_Distance(poly, geom) > 5

MySQL

ST_Distance(poly, geom) > 5

Oracle

SDO_GEOM.SDO_DISTANCE(poly, geom, 0.05) > 5

SpatiaLite

Distance(poly, geom) > 5

\n
\n
\n
\n

distance_gteLink to this heading#

\n

Returns models where the distance to the geometry field from the lookup\ngeometry is greater than or equal to the given distance value.

\n

Example:

\n
Code
Zipcode.objects.filter(poly__distance_gte=(geom, D(m=5)))\n
\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Backend

SQL Equivalent

PostGIS

ST_Distance/ST_Distance_Sphere(poly, geom) >= 5

MariaDB

ST_Distance(poly, geom) >= 5

MySQL

ST_Distance(poly, geom) >= 5

Oracle

SDO_GEOM.SDO_DISTANCE(poly, geom, 0.05) >= 5

SpatiaLite

Distance(poly, geom) >= 5

\n
\n
\n
\n

distance_ltLink to this heading#

\n

Returns models where the distance to the geometry field from the lookup\ngeometry is less than the given distance value.

\n

Example:

\n
Code
Zipcode.objects.filter(poly__distance_lt=(geom, D(m=5)))\n
\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Backend

SQL Equivalent

PostGIS

ST_Distance/ST_Distance_Sphere(poly, geom) < 5

MariaDB

ST_Distance(poly, geom) < 5

MySQL

ST_Distance(poly, geom) < 5

Oracle

SDO_GEOM.SDO_DISTANCE(poly, geom, 0.05) < 5

SpatiaLite

Distance(poly, geom) < 5

\n
\n
\n
\n

distance_lteLink to this heading#

\n

Returns models where the distance to the geometry field from the lookup\ngeometry is less than or equal to the given distance value.

\n

Example:

\n
Code
Zipcode.objects.filter(poly__distance_lte=(geom, D(m=5)))\n
\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Backend

SQL Equivalent

PostGIS

ST_Distance/ST_Distance_Sphere(poly, geom) <= 5

MariaDB

ST_Distance(poly, geom) <= 5

MySQL

ST_Distance(poly, geom) <= 5

Oracle

SDO_GEOM.SDO_DISTANCE(poly, geom, 0.05) <= 5

SpatiaLite

Distance(poly, geom) <= 5

\n
\n
\n
\n

dwithinLink to this heading#

\n

Returns models where the distance to the geometry field from the lookup\ngeometry are within the given distance from one another. Note that you can only\nprovide Distance objects if the targeted\ngeometries are in a projected system. For geographic geometries, you should use\nunits of the geometry field (e.g. degrees for WGS84) .

\n

Example:

\n
Code
Zipcode.objects.filter(poly__dwithin=(geom, D(m=5)))\n
\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Backend

SQL Equivalent

PostGIS

ST_DWithin(poly, geom, 5)

Oracle

SDO_WITHIN_DISTANCE(poly, geom, 5)

SpatiaLite

PtDistWithin(poly, geom, 5)

\n
\n
\n
\n

Aggregate FunctionsLink to this heading#

\n

Django provides some GIS-specific aggregate functions. For details on how to\nuse these aggregate functions, see the topic guide on aggregation.

\n
\n\n\n\n\n\n\n\n\n\n\n

Keyword Argument

Description

tolerance

This keyword is for Oracle only. It is for the\ntolerance value used by the SDOAGGRTYPE\nprocedure; the Oracle documentation has more\ndetails.

\n
\n

Example:

\n
Code
>>> from django.contrib.gis.db.models import Extent, Union\n>>> WorldBorder.objects.aggregate(Extent('mpoly'), Union('mpoly'))\n
\n
\n

CollectLink to this heading#

\n
\n
\nclass Collect(geo_field)Link to this definition#
\n
\n\n

Availability: PostGIS,\nSpatiaLite

\n

Returns a GEOMETRYCOLLECTION or a MULTI geometry object from the geometry\ncolumn. This is analogous to a simplified version of the Union\naggregate, except it can be several orders of magnitude faster than performing\na union because it rolls up geometries into a collection or multi object, not\ncaring about dissolving boundaries.

\n
\n
\n

ExtentLink to this heading#

\n
\n
\nclass Extent(geo_field)Link to this definition#
\n
\n\n

Availability: PostGIS,\nOracle, SpatiaLite

\n

Returns the extent of all geo_field in the QuerySet as a four-tuple,\ncomprising the lower left coordinate and the upper right coordinate.

\n

Example:

\n
Code
>>> qs = City.objects.filter(name__in=('Houston', 'Dallas')).aggregate(Extent('poly'))\n>>> print(qs['poly__extent'])\n(-96.8016128540039, 29.7633724212646, -95.3631439208984, 32.782058715820)\n
\n
\n
\n

Extent3DLink to this heading#

\n
\n
\nclass Extent3D(geo_field)Link to this definition#
\n
\n\n

Availability: PostGIS

\n

Returns the 3D extent of all geo_field in the QuerySet as a six-tuple,\ncomprising the lower left coordinate and upper right coordinate (each with x, y,\nand z coordinates).

\n

Example:

\n
Code
>>> qs = City.objects.filter(name__in=('Houston', 'Dallas')).aggregate(Extent3D('poly'))\n>>> print(qs['poly__extent3d'])\n(-96.8016128540039, 29.7633724212646, 0, -95.3631439208984, 32.782058715820, 0)\n
\n
\n
\n

MakeLineLink to this heading#

\n
\n
\nclass MakeLine(geo_field)Link to this definition#
\n
\n\n

Availability: PostGIS,\nSpatiaLite

\n

Returns a LineString constructed from the point field geometries in the\nQuerySet. Currently, ordering the queryset has no effect.

\n

Example:

\n
Code
>>> qs = City.objects.filter(name__in=('Houston', 'Dallas')).aggregate(MakeLine('poly'))\n>>> print(qs['poly__makeline'])\nLINESTRING (-95.3631510000000020 29.7633739999999989, -96.8016109999999941 32.7820570000000018)\n
\n
\n
\n

UnionLink to this heading#

\n
\n
\nclass Union(geo_field)Link to this definition#
\n
\n\n

Availability: PostGIS,\nOracle, SpatiaLite

\n

This method returns a GEOSGeometry object\ncomprising the union of every geometry in the queryset. Please note that use of\nUnion is processor intensive and may take a significant amount of time on\nlarge querysets.

\n\n

Example:

\n
Code
>>> u = Zipcode.objects.aggregate(Union(poly))  # This may take a long time.\n>>> u = Zipcode.objects.filter(poly__within=bbox).aggregate(Union(poly))  # A more sensible approach.\n
\n

Footnotes

\n\n
\n
\n
","rootId":"gis-queryset-api-reference","toc":[{"title":"Spatial Lookups","anchor":"spatial-lookups","children":[{"title":"Lookups with rasters","anchor":"lookups-with-rasters","children":[]},{"title":"bbcontains","anchor":"bbcontains","children":[]},{"title":"bboverlaps","anchor":"bboverlaps","children":[]},{"title":"contained","anchor":"contained","children":[]},{"title":"contains","anchor":"contains","children":[]},{"title":"contains_properly","anchor":"contains-properly","children":[]},{"title":"coveredby","anchor":"coveredby","children":[]},{"title":"covers","anchor":"covers","children":[]},{"title":"crosses","anchor":"crosses","children":[]},{"title":"disjoint","anchor":"disjoint","children":[]},{"title":"equals","anchor":"equals","children":[]},{"title":"exact, same_as","anchor":"exact-same-as","children":[]},{"title":"intersects","anchor":"intersects","children":[]},{"title":"isvalid","anchor":"isvalid","children":[]},{"title":"overlaps","anchor":"overlaps","children":[]},{"title":"relate","anchor":"relate","children":[{"title":"MariaDB, PostGIS, and SpatiaLite","anchor":"mariadb-postgis-and-spatialite","children":[]},{"title":"Oracle","anchor":"oracle","children":[]}]},{"title":"touches","anchor":"touches","children":[]},{"title":"within","anchor":"within","children":[]},{"title":"left","anchor":"left","children":[]},{"title":"right","anchor":"right","children":[]},{"title":"overlaps_left","anchor":"overlaps-left","children":[]},{"title":"overlaps_right","anchor":"overlaps-right","children":[]},{"title":"overlaps_above","anchor":"overlaps-above","children":[]},{"title":"overlaps_below","anchor":"overlaps-below","children":[]},{"title":"strictly_above","anchor":"strictly-above","children":[]},{"title":"strictly_below","anchor":"strictly-below","children":[]}]},{"title":"Distance Lookups","anchor":"distance-lookups","children":[{"title":"distance_gt","anchor":"distance-gt","children":[]},{"title":"distance_gte","anchor":"distance-gte","children":[]},{"title":"distance_lt","anchor":"distance-lt","children":[]},{"title":"distance_lte","anchor":"distance-lte","children":[]},{"title":"dwithin","anchor":"dwithin","children":[]},{"title":"Aggregate Functions","anchor":"aggregate-functions","children":[{"title":"Collect","anchor":"collect","children":[]},{"title":"Extent","anchor":"extent","children":[]},{"title":"Extent3D","anchor":"extent3d","children":[]},{"title":"MakeLine","anchor":"makeline","children":[]},{"title":"Union","anchor":"union","children":[]}]}]}],"breadcrumbs":[{"docname":"ref/index","title":"API Reference","url":"/ko/3.1/ref/"},{"docname":"ref/contrib/index","title":"contrib packages","url":"/ko/3.1/ref/contrib/"},{"docname":"ref/contrib/gis/index","title":"GeoDjango","url":"/ko/3.1/ref/contrib/gis/"}],"prev":{"docname":"ref/contrib/gis/forms-api","title":"GeoDjango Forms API","url":"/ko/3.1/ref/contrib/gis/forms-api/"},"next":{"docname":"ref/contrib/gis/functions","title":"Geographic Database Functions","url":"/ko/3.1/ref/contrib/gis/functions/"},"formats":{"html":"/ko/3.1/ref/contrib/gis/geoquerysets/","markdown":"/ko/3.1/ref/contrib/gis/geoquerysets.md","json":"/ko/3.1/ref/contrib/gis/geoquerysets.json"},"source":"https://github.com/django/django/blob/stable/3.1.x/docs/ref/contrib/gis/geoquerysets.txt","official":"https://docs.djangoproject.com/ko/3.1/ref/contrib/gis/geoquerysets/","inVersions":["6.1","6.0","5.2","5.1","5.0","4.2","4.1","4.0","3.2","3.1","3.0","2.2","2.1","2.0","1.11"],"inLocales":["en","zh-hans","fr","ja","id","pt-br","ko","es","el","pl"]}