Changeset 6919

Timestamp:

12/14/07 18:30:48 (10 months ago)

Author:

jbronn

Message:

gis: Applied DRY to spatial SQL generation in anticipation of queryset-refactor; fixed gml function for PostGIS 1.3.2 parameter ordering.

Files:

• django/branches/gis/django/contrib/gis/db/backend/__init__.py (modified) (3 diffs)
• django/branches/gis/django/contrib/gis/db/backend/mysql/query.py (modified) (3 diffs)
• django/branches/gis/django/contrib/gis/db/backend/oracle/field.py (modified) (1 diff)
• django/branches/gis/django/contrib/gis/db/backend/oracle/models.py (modified) (2 diffs)
• django/branches/gis/django/contrib/gis/db/backend/oracle/query.py (modified) (6 diffs)
• django/branches/gis/django/contrib/gis/db/backend/postgis/creation.py (modified) (2 diffs)
• django/branches/gis/django/contrib/gis/db/backend/postgis/field.py (modified) (1 diff)
• django/branches/gis/django/contrib/gis/db/backend/postgis/models.py (modified) (2 diffs)
• django/branches/gis/django/contrib/gis/db/backend/postgis/query.py (modified) (7 diffs)
• django/branches/gis/django/contrib/gis/db/backend/util.py (modified) (1 diff)
• django/branches/gis/django/contrib/gis/db/models/query.py (modified) (2 diffs)

django/branches/gis/django/contrib/gis/db/backend/__init__.py

@@ -27 +27 @@
-
-# These routines (needed by GeoManager), default to False.
-= (
+, VERSION = (False, 
-
-if settings.DATABASE_ENGINE == 'postgresql_psycopg2':
@@ -35 +35 @@
-        PostGISField as GeoBackendField, POSTGIS_TERMS as GIS_TERMS, \
-        create_spatial_db, get_geo_where_clause, \
-
+
+
+
-    SPATIAL_BACKEND = 'postgis'
-elif settings.DATABASE_ENGINE == 'oracle':
@@ -284 +286 @@
-            
-            # Getting the adapted geometry from the field.
- + '.'
+
-
-            # Substituting in the the where parameters into the geographic where

django/branches/gis/django/contrib/gis/db/backend/mysql/query.py

@@ -5 +5 @@
-from django.db import connection
-qn = connection.ops.quote_name
+
+# To ease implementation, WKT is passed to/from MySQL.
+GEOM_FROM_TEXT = 'GeomFromText'
+GEOM_FROM_WKB = 'GeomFromWKB'
+GEOM_SELECT = 'AsText(%s)'
-
-# WARNING: MySQL is NOT compliant w/the OpenGIS specification and
@@ -32 +37 @@
-def get_geo_where_clause(lookup_type, table_prefix, field_name, value):
-    "Returns the SQL WHERE clause for use in MySQL spatial SQL construction."
-
-
-
+
+
-
-    # See if a MySQL Geometry function matches the lookup type next
-    lookup_info = MYSQL_GIS_FUNCTIONS.get(lookup_type, False)
-    if lookup_info:
-table_prefix + field_name
+geo_col
-    
-    # Handling 'isnull' lookup type
@@ -45 +49 @@
-    # geometries in its spatial indices.
-    if lookup_type == 'isnull':
-%s IS %sNULL" % (table_prefix, field_name
+ IS %sNULL" % (geo_col
-
-    raise TypeError("Got invalid lookup_type: %s" % repr(lookup_type))
-
-# To ease implementation, WKT is passed to/from MySQL.
-GEOM_FROM_TEXT = 'GeomFromText'
-GEOM_FROM_WKB = 'GeomFromWKB'
-GEOM_SELECT = 'AsText(%s)'

django/branches/gis/django/contrib/gis/db/backend/oracle/field.py

@@ -5 +5 @@
-from django.db.models.fields import Field # Django base Field class
-from django.contrib.gis.geos import GEOSGeometry
-get_srid, 
+
-from django.contrib.gis.db.backend.oracle.adaptor import OracleSpatialAdaptor
-from django.contrib.gis.db.backend.oracle.query import ORACLE_SPATIAL_TERMS, DISTANCE_FUNCTIONS, TRANSFORM

django/branches/gis/django/contrib/gis/db/backend/oracle/models.py

@@ -13 +13 @@
-class GeometryColumns(models.Model):
-    "Maps to the Oracle USER_SDO_GEOM_METADATA table."
-
-
+_
+_
-    srid = models.IntegerField(primary_key=True)
-    # TODO: Add support for `diminfo` column (type MDSYS.SDO_DIM_ARRAY).
@@ -29 +29 @@
-class SpatialRefSys(models.Model, SpatialRefSysMixin):
-    "Maps to the Oracle MDSYS.CS_SRS table."
-
+_
-    srid = models.IntegerField(primary_key=True)
-    auth_srid = models.IntegerField()
-
-
+_
+_
-    #cs_bounds = models.GeometryField()
-

django/branches/gis/django/contrib/gis/db/backend/oracle/query.py

@@ -6 +6 @@
-from decimal import Decimal
-from django.db import connection
+from django.contrib.gis.db.backend.util import SpatialFunction
-from django.contrib.gis.measure import Distance
-qn = connection.ops.quote_name
@@ -15 +16 @@
-UNION = 'SDO_AGGR_UNION'
-
-
+
+
+
+
+
+
+
+
+
-    "Base class for SDO* Oracle operations."
+    def __init__(self, func, end_subst=") %s '%s'"):
+        super(SDOOperation, self).__init__(func, end_subst=end_subst, operator='=', result='TRUE')
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+
-    "Class for Distance queries."
-    def __init__(self, op, tolerance=0.05):
-subst=", %s", operator=op, result='%%s')
-self.tolerance = tolerance
+end_subst=', %s) %%s %%s' % tolerance, 
+                                  operator=op, result='%%s')
-
-
-
-
-
+
-    "Class for using SDO_GEOM.RELATE."
-    def __init__(self, mask, tolerance=0.05):
-
-
-
-
+
+
+
+
+
-
-
-
-
-
+
-    "Class for using SDO_RELATE."
-    masks = 'TOUCH|OVERLAPBDYDISJOINT|OVERLAPBDYINTERSECT|EQUAL|INSIDE|COVEREDBY|CONTAINS|COVERS|ANYINTERACT|ON'
-    mask_regex = re.compile(r'^(%s)(\+(%s))*$' % (masks, masks), re.I)
-
-
-
+
-        if not self.mask_regex.match(mask):
-            raise ValueError('Invalid %s mask: "%s"' % (self.lookup, mask))
-elf.mask = mask
+uper(SDORelate, self).__init__('SDO_RELATE', end_subst=", 'mask=%s') = 'TRUE'" % mask)
-
-
-
+
-
-# Valid distance types and substitutions
@@ -85 +69 @@
-    'covers' : SDOOperation('SDO_COVERS'),
-    'disjoint' : SDOGeomRelate('DISJOINT'),
-"%%s, 'distance=%
+end_subst=", %%s, 'distance=%%s') %s '
-    'intersects' : SDOOperation('SDO_OVERLAPBDYINTERSECT'), # TODO: Is this really the same as ST_Intersects()?
-    'equals' : SDOOperation('SDO_EQUAL'),
@@ -105 +89 @@
-ORACLE_SPATIAL_TERMS = tuple(ORACLE_SPATIAL_TERMS) # Making immutable
-
+#### The `get_geo_where_clause` function for Oracle ####
-def get_geo_where_clause(lookup_type, table_prefix, field_name, value):
-    "Returns the SQL WHERE clause for use in Oracle spatial SQL construction."
-
-
-
+
+
-
-    # See if a Oracle Geometry function matches the lookup type next
@@ -115 +99 @@
-    if lookup_info:
-        # Lookup types that are tuples take tuple arguments, e.g., 'relate' and 
- 
+
-        if isinstance(lookup_info, tuple):
-            # First element of tuple is lookup type, second element is the type
- 
+
-            sdo_op, arg_type = lookup_info
-
@@ -132 +116 @@
-
-            if lookup_type == 'relate':
-
-
-
-
-
-
-
+
+
+
-            else:
-
+
+
-        else:
-            # Lookup info is a SDOOperation instance, whos `as_sql` method returns
-            # the SQL necessary for the geometry function call. For example:  
-            #  SDO_CONTAINS("geoapp_country"."poly", SDO_GEOMTRY('POINT(5 23)', 4326)) = 'TRUE'
-
-
-
-
-
+
+
+
+
-
-    raise TypeError("Got invalid lookup_type: %s" % repr(lookup_type))
-
-# Want to get SDO Geometries as WKT (much easier to instantiate GEOS proxies
-# from WKT than SDO_GEOMETRY(...) strings ;)
-GEOM_SELECT = 'SDO_UTIL.TO_WKTGEOMETRY(%s)'

django/branches/gis/django/contrib/gis/db/backend/postgis/creation.py

@@ -46 +46 @@
-        # Trying to create the database first.
-        cursor.execute(create_sql)
+        #print create_sql
-    except Exception, e:
-        # Drop and recreate, if necessary.
@@ -57 +58 @@
-        else:
-            raise Exception('Spatial Database Creation canceled.')
+foo = _create_with_cursor
-    
-created_regex = re.compile(r'^createdb: database creation failed: ERROR:  database ".+" already exists')

django/branches/gis/django/contrib/gis/db/backend/postgis/field.py

@@ -2 +2 @@
-from django.db import connection
-from django.db.models.fields import Field # Django base Field class
-, GEOSException 
-get_srid, 
+
+
-from django.contrib.gis.db.backend.postgis.adaptor import PostGISAdaptor
-from django.contrib.gis.db.backend.postgis.query import \
-, DISTANCE
+
-
-# Quotename & geographic quotename, respectively

django/branches/gis/django/contrib/gis/db/backend/postgis/models.py

@@ -15 +15 @@
-    documentation at Ch. 4.2.2.
-    """
-
-
-
-
+_
+_
+_
+_
-    coord_dimension = models.IntegerField()
-    srid = models.IntegerField(primary_key=True)
-
+_
-
-    class Meta:
@@ -42 +42 @@
-    """
-    srid = models.IntegerField(primary_key=True)
-
+_
-    auth_srid = models.IntegerField()
-
-
+_
+_
-
-    class Meta:

django/branches/gis/django/contrib/gis/db/backend/postgis/query.py

@@ -3 +3 @@
- routine for PostGIS.
-"""
+import re
-from decimal import Decimal
-from django.db import connection
-from django.contrib.gis.measure import Distance
-from django.contrib.gis.db.backend.postgis.management import postgis_version_tuple
+from django.contrib.gis.db.backend.util import SpatialOperation, SpatialFunction
-qn = connection.ops.quote_name
-
@@ -18 +20 @@
-    raise Exception('PostGIS version %s not supported.' % POSTGIS_VERSION)
-
-# PostGIS-specific operators. The commented descriptions of these
-# operators come from Section 6.2.2 of the official PostGIS documentation.
-POSTGIS_OPERATORS = {
-    # The "&<" operator returns true if A's bounding box overlaps or
-    #  is to the left of B's bounding box.
-    'overlaps_left' : '&<',
-    # The "&>" operator returns true if A's bounding box overlaps or
-    #  is to the right of B's bounding box.
-    'overlaps_right' : '&>',
-    # The "<<" operator returns true if A's bounding box is strictly
-    #  to the left of B's bounding box.
-    'left' : '<<',
-    # The ">>" operator returns true if A's bounding box is strictly
-    #  to the right of B's bounding box.
-    'right' : '>>',
-    # The "&<|" operator returns true if A's bounding box overlaps or
-    #  is below B's bounding box.
-    'overlaps_below' : '&<|',
-    # The "|&>" operator returns true if A's bounding box overlaps or
-    #  is above B's bounding box.
-    'overlaps_above' : '|&>',
-    # The "<<|" operator returns true if A's bounding box is strictly
-    #  below B's bounding box.
-    'strictly_below' : '<<|',
-    # The "|>>" operator returns true if A's bounding box is strictly
-    # above B's bounding box.
-    'strictly_above' : '|>>',
-    # The "~=" operator is the "same as" operator. It tests actual
-    #  geometric equality of two features. So if A and B are the same feature,
-    #  vertex-by-vertex, the operator returns true.
-    'same_as' : '~=',
-    'exact' : '~=',
-    # The "@" operator returns true if A's bounding box is completely contained
-    #  by B's bounding box.
-    'contained' : '@',
-    # The "~" operator returns true if A's bounding box completely contains
-    #  by B's bounding box.
-    'bbcontains' : '~',
-    # The "&&" operator returns true if A's bounding box overlaps
-    #  B's bounding box.
-    'bboverlaps' : '&&',
-    }
-
-# Versions of PostGIS >= 1.2.2 changed their naming convention to be
- 
+
-#  means that 'ST_' is prefixes geometry function names.
-GEOM_FUNC_PREFIX = ''
-if MAJOR_VERSION >= 1:
- 
+
-        (MINOR_VERSION1 == 2 and MINOR_VERSION2 >= 2)):
-        GEOM_FUNC_PREFIX = 'ST_'
-
+
-    def get_func(func): return '%s%s' % (GEOM_FUNC_PREFIX, func)
+
+    # Custom selection not needed for PostGIS since GEOS geometries may be
+    # instantiated directly from the HEXEWKB returned by default.  If
+    # WKT is needed for some reason in the future, this value may be changed,
+    # 'AsText(%s)'
+    GEOM_SELECT = None
-
-    # Functions used by the GeoManager & GeoQuerySet
@@ -91 +56 @@
-    raise NotImplementedError('PostGIS versions < 1.0 are not supported.')
-
+#### Classes used in constructing PostGIS spatial SQL ####
+class PostGISOperator(SpatialOperation):
+    "For PostGIS operators (e.g. `&&`, `~`)."
+    def __init__(self, operator):
+        super(PostGISOperator, self).__init__(operator=operator, beg_subst='%s %s %%s')
+
+class PostGISFunction(SpatialFunction):
+    "For PostGIS function calls (e.g., `ST_Contains(table, geom)`)."
+    def __init__(self, function, **kwargs):
+        super(PostGISFunction, self).__init__(get_func(function), **kwargs)
+
+class PostGISFunctionParam(PostGISFunction):
+    "For PostGIS functions that take another parameter (e.g. DWithin, Relate)."
+    def __init__(self, func):
+        super(PostGISFunctionParam, self).__init__(func, end_subst=', %%s)')
+
+class PostGISDistance(PostGISFunction):
+    "For PostGIS distance operations."
+    def __init__(self, operator):
+        super(PostGISDistance, self).__init__('Distance', end_subst=') %s %s', operator=operator, result='%%s')
+
+class PostGISRelate(PostGISFunctionParam):
+    "For PostGIS Relate(<geom>, <pattern>) calls."
+    pattern_regex = re.compile(r'^[012TF\*]{9}$')
+    def __init__(self, pattern):
+        if not self.pattern_regex.match(pattern):
+            raise ValueError('Invalid intersection matrix pattern "%s".' % pattern)
+        super(PostGISRelate, self).__init__('Relate')
+
+#### Lookup type mapping dictionaries of PostGIS operations. ####
+
+# PostGIS-specific operators. The commented descriptions of these
+# operators come from Section 6.2.2 of the official PostGIS documentation.
+POSTGIS_OPERATORS = {
+    # The "&<" operator returns true if A's bounding box overlaps or
+    #  is to the left of B's bounding box.
+    'overlaps_left' : PostGISOperator('&<'),
+    # The "&>" operator returns true if A's bounding box overlaps or
+    #  is to the right of B's bounding box.
+    'overlaps_right' : PostGISOperator('&>'),
+    # The "<<" operator returns true if A's bounding box is strictly
+    #  to the left of B's bounding box.
+    'left' : PostGISOperator('<<'),
+    # The ">>" operator returns true if A's bounding box is strictly
+    #  to the right of B's bounding box.
+    'right' : PostGISOperator('>>'),
+    # The "&<|" operator returns true if A's bounding box overlaps or
+    #  is below B's bounding box.
+    'overlaps_below' : PostGISOperator('&<|'),
+    # The "|&>" operator returns true if A's bounding box overlaps or
+    #  is above B's bounding box.
+    'overlaps_above' : PostGISOperator('|&>'),
+    # The "<<|" operator returns true if A's bounding box is strictly
+    #  below B's bounding box.
+    'strictly_below' : PostGISOperator('<<|'),
+    # The "|>>" operator returns true if A's bounding box is strictly
+    # above B's bounding box.
+    'strictly_above' : PostGISOperator('|>>'),
+    # The "~=" operator is the "same as" operator. It tests actual
+    #  geometric equality of two features. So if A and B are the same feature,
+    #  vertex-by-vertex, the operator returns true.
+    'same_as' : PostGISOperator('~='),
+    'exact' : PostGISOperator('~='),
+    # The "@" operator returns true if A's bounding box is completely contained
+    #  by B's bounding box.
+    'contained' : PostGISOperator('@'),
+    # The "~" operator returns true if A's bounding box completely contains
+    #  by B's bounding box.
+    'bbcontains' : PostGISOperator('~'),
+    # The "&&" operator returns true if A's bounding box overlaps
+    #  B's bounding box.
+    'bboverlaps' : PostGISOperator('&&'),
+    }
+
-# For PostGIS >= 1.2.2 the following lookup types will do a bounding box query
-# first before calling the more computationally expensive GEOS routines (called
@@ -97 +136 @@
-# 'covers'.
-POSTGIS_GEOMETRY_FUNCTIONS = {
-'Equals'
-'Disjoint'
-'Touches'
-'Crosses'
-'Within'
-'Overlaps'
-'Contains'
-'Intersects'
-'Relate'
+PostGISFunction('Equals')
+PostGISFunction('Disjoint')
+PostGISFunction('Touches')
+PostGISFunction('Crosses')
+PostGISFunction('Within')
+PostGISFunction('Overlaps')
+PostGISFunction('Contains')
+PostGISFunction('Intersects')
+PostGISRelate
-    }
-
@@ -111 +150 @@
-dtypes = (Decimal, Distance, float, int)
-DISTANCE_FUNCTIONS = {
-'>'
-'>='
-'<'
-'<='
+PostGISDistance('>')
+PostGISDistance('>=')
+PostGISDistance('<')
+PostGISDistance('<=')
-    }
-
-if GEOM_FUNC_PREFIX == 'ST_':
-    # Adding the GEOM_FUNC_PREFIX to the lookup functions.
-    for lookup, f in POSTGIS_GEOMETRY_FUNCTIONS.items():
-        if isinstance(f, tuple):
-            POSTGIS_GEOMETRY_FUNCTIONS[lookup] = (get_func(f[0]), f[1])
-        else:
-            POSTGIS_GEOMETRY_FUNCTIONS[lookup] = get_func(f)
-
-    # The ST_DWithin, ST_CoveredBy, and ST_Covers routines become available in 1.2.2+
-    POSTGIS_GEOMETRY_FUNCTIONS.update(
-'ST_DWithin'
-'ST_CoveredBy'
-'ST_Covers'
-
-
-
+PostGISFunctionParam('DWithin')
+PostGISFunction('CoveredBy')
+PostGISFunction('Covers')
+)
+
+
-POSTGIS_GEOMETRY_FUNCTIONS.update(DISTANCE_FUNCTIONS)
-
@@ -145 +177 @@
-POSTGIS_TERMS = tuple(POSTGIS_TERMS) # Making immutable
-
-
-
-
-
-
-
-
-
+
-def get_geo_where_clause(lookup_type, table_prefix, field_name, value):
-    "Returns the SQL WHERE clause for use in PostGIS SQL construction."
-
-
-
-
-
+
+
-    if lookup_type in POSTGIS_OPERATORS:
-
-
-
-
-
+
+
+
+
+
+
-        # Lookup types that are tuples take tuple arguments, e.g., 'relate' and 
-
-
-
-
-
+
+
+
+
+
+
-
-            # Ensuring that a tuple _value_ was passed in from the user
@@ -183 +207 @@
-                raise TypeError('Argument type should be %s, got %s instead.' % (arg_type, type(value[1])))
-
-
-
-
-
-
+
+
+
-        else:
-
-
-
-
-
-
-
+
+
+
+
+
+
-
-    raise TypeError("Got invalid lookup_type: %s" % repr(lookup_type))
-
-# Custom selection not needed for PostGIS since GEOS geometries may be
-# instantiated directly from the HEXEWKB returned by default.  If
-# WKT is needed for some reason in the future, this value may be changed,
-# 'AsText(%s)'
-GEOM_SELECT = None

django/branches/gis/django/contrib/gis/db/backend/util.py

@@ -9 +9 @@
-
-    def __str__(self):
-where[0] % tuple(self.params
+as_sql(
-
-
+
+
+
+
+
+
+
+
+
+
-    """
-
-
+
-    """
-
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+

django/branches/gis/django/contrib/gis/db/models/query.py

@@ -8 +8 @@
-# parse_lookup depends on the spatial database backend.
-from django.contrib.gis.db.backend import parse_lookup, \
-
+, VERSION
-from django.contrib.gis.geos import GEOSGeometry
-
-Flag indicating whether the backend is Oracle
+Shortcut booleans for determining the backend
-oracle = SPATIAL_BACKEND == 'oracle'
+postgis = SPATIAL_BACKEND == 'postgis'
-
-class GeoQ(Q):
@@ -326 +327 @@
-        if oracle:
-            gml_select = {'gml':'%s(%s)' % (ASGML, field_col)}
-
-
+
+
+
+
+
+
+
+
-
-        # Adding GML function call to SELECT part of the SQL.