Skip to main content

Add support for PostgreSQL earthdistance extension to Django

Project description

Using PostgreSQL’s EarthDistance extension for django 1.11, 2.2 and 3.2 (for older versions see with_djorm_expressions branch)

Earthdistance allows to do fast geolocalized queries without using PostGIS

Usage

Cube and EarthDistance extensions must be enabled in postgreSQL BD, so log in database using pgsql and install extensions:

=> create extension cube;
=> create extension earthdistance;

Filter by rows inside a circunference of radius r

from django.db import models

from django_earthdistance.models import EarthDistanceQuerySet

class MyModel(models.Model):
    latitute = models.FloatField()
    longitude = models.FloatField()

    objects = EarthDistanceQuerySet.as_manager()

# Define fields to query in DistanceExpression initialization
# search with lat=0.2546 and lon=-38.25 and distance 1500 meters
# use param `annotate` to set a custom field for the distance, `_ed_distance` as default

MyModel.objects.in_distance(1500, fields=['latitude', 'longitude'], points=[0.2546, -38.25])

Annotate each row returned by a query with distance between two points

from django_earthdistance.models import EarthDistance, LlToEarth

MyModel.objects.filter(....).annotate(
    distance=EarthDistance([
        LlToEarth([0.2546, -38.25]),
        LlToEarth(['latitude', 'longitude'])
    ]))

Optimizing perfomance with indexes

PostgreSQL allow to use GiST indexes with functions results, a good perfomance improvement is to store ll_to_earth results in an index, ll_to_earth is a function that calculates the position of a point on the surface of the earth (assuming earth is perfectly spherical)

-- Example MyModel table is app_mymodel and points columns are latitude and longitude
CREATE INDEX mymodel_location ON app_mymodel USING gist (ll_to_earth(latitude, longitude));

For django < 1.7

Also, using south is preferred, just add this migration to migrations/ folder and edit it to your needs, index will be created

class Migration(SchemaMigration):

    def forwards(self, orm):
        cursor = connection.cursor()
        cursor.execute("CREATE INDEX mymodel_location ON app_mymodel USING gist (ll_to_earth(latitude, longitude));")


    def backwards(self, orm):
        # Deleting field 'Venue.coords'
        cursor = connection.cursor()
        cursor.execute("DROP INDEX mymodel_location ON app_mymodel;")

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

django-earthdistance-1.1.3.tar.gz (8.2 kB view details)

Uploaded Source

Built Distribution

django_earthdistance-1.1.3-py3-none-any.whl (9.5 kB view details)

Uploaded Python 3

File details

Details for the file django-earthdistance-1.1.3.tar.gz.

File metadata

  • Download URL: django-earthdistance-1.1.3.tar.gz
  • Upload date:
  • Size: 8.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.0 CPython/3.9.12

File hashes

Hashes for django-earthdistance-1.1.3.tar.gz
Algorithm Hash digest
SHA256 8a167e308a1676a7513fee429dad653065a0e087c5dc8146731a52661bec330a
MD5 44f760a5158c159844ab919891b19d23
BLAKE2b-256 1b237147b745a4c0095db91c273c1acd8a811f6d8800e69579134a8ff3747bd8

See more details on using hashes here.

File details

Details for the file django_earthdistance-1.1.3-py3-none-any.whl.

File metadata

File hashes

Hashes for django_earthdistance-1.1.3-py3-none-any.whl
Algorithm Hash digest
SHA256 23826d6c1b816b8231809bd48f03eec8ae46a6118812e0dc79d86207a257330f
MD5 c48cd1fd16c0e376c92ef8b93c491899
BLAKE2b-256 acb5aa27515ed1b33bdb7457f6990dc32502957e38f0269ad4a4187b81c0abc0

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page