nominatim/db/sqlalchemy_types.py

   1 # SPDX-License-Identifier: GPL-3.0-or-later
   2 #
   3 # This file is part of Nominatim. (https://nominatim.org)
   4 #
   5 # Copyright (C) 2023 by the Nominatim developer community.
   6 # For a full list of authors see the git log.
   7 """
   8 Custom types for SQLAlchemy.
   9 """
  10 from typing import Callable, Any
  11
  12 import sqlalchemy as sa
  13 import sqlalchemy.types as types
  14
  15 from nominatim.typing import SaColumn
  16
  17 class Geometry(types.UserDefinedType[Any]):
  18     """ Simplified type decorator for PostGIS geometry. This type
  19         only supports geometries in 4326 projection.
  20     """
  21     cache_ok = True
  22
  23     def __init__(self, subtype: str = 'Geometry'):
  24         self.subtype = subtype
  25
  26
  27     def get_col_spec(self) -> str:
  28         return f'GEOMETRY({self.subtype}, 4326)'
  29
  30
  31     def bind_processor(self, dialect: sa.Dialect) -> Callable[[Any], str]:
  32         def process(value: Any) -> str:
  33             assert isinstance(value, str)
  34             return value
  35         return process
  36
  37
  38     def result_processor(self, dialect: sa.Dialect, coltype: object) -> Callable[[Any], str]:
  39         def process(value: Any) -> str:
  40             assert isinstance(value, str)
  41             return value
  42         return process
  43
  44
  45     def bind_expression(self, bindvalue: sa.BindParameter[Any]) -> SaColumn:
  46         return sa.func.ST_GeomFromText(bindvalue, type_=self)
  47
  48
  49     class comparator_factory(types.UserDefinedType.Comparator):
  50
  51         def intersects(self, other: SaColumn) -> SaColumn:
  52             return self.op('&&')(other)
  53
  54         def is_line_like(self) -> SaColumn:
  55             return sa.func.ST_GeometryType(self, type_=sa.String).in_(('ST_LineString',
  56                                                                        'ST_MultiLineString'))
  57
  58         def is_area(self) -> SaColumn:
  59             return sa.func.ST_GeometryType(self, type_=sa.String).in_(('ST_Polygon',
  60                                                                        'ST_MultiPolygon'))
  61
  62
  63         def ST_DWithin(self, other: SaColumn, distance: SaColumn) -> SaColumn:
  64             return sa.func.ST_DWithin(self, other, distance, type_=sa.Float)
  65
  66
  67         def ST_Distance(self, other: SaColumn) -> SaColumn:
  68             return sa.func.ST_Distance(self, other, type_=sa.Float)
  69
  70
  71         def ST_Contains(self, other: SaColumn) -> SaColumn:
  72             return sa.func.ST_Contains(self, other, type_=sa.Float)
  73
  74
  75         def ST_ClosestPoint(self, other: SaColumn) -> SaColumn:
  76             return sa.func.ST_ClosestPoint(self, other, type_=Geometry)
  77
  78
  79         def ST_Buffer(self, other: SaColumn) -> SaColumn:
  80             return sa.func.ST_Buffer(self, other, type_=Geometry)
  81
  82
  83         def ST_Expand(self, other: SaColumn) -> SaColumn:
  84             return sa.func.ST_Expand(self, other, type_=Geometry)
  85
  86
  87         def ST_Centroid(self) -> SaColumn:
  88             return sa.func.ST_Centroid(self, type_=Geometry)
  89
  90
  91         def ST_LineInterpolatePoint(self, other: SaColumn) -> SaColumn:
  92             return sa.func.ST_LineInterpolatePoint(self, other, type_=Geometry)
  93
  94
  95         def ST_LineLocatePoint(self, other: SaColumn) -> SaColumn:
  96             return sa.func.ST_LineLocatePoint(self, other, type_=sa.Float)