nominatim/db/sqlalchemy_schema.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 SQLAlchemy definitions for all tables used by the frontend.
   9 """
  10 from typing import Any
  11
  12 import sqlalchemy as sa
  13 from sqlalchemy.dialects.postgresql import HSTORE, ARRAY, JSONB, array
  14 from sqlalchemy.dialects.sqlite import JSON as sqlite_json
  15
  16 from nominatim.db.sqlalchemy_types import Geometry
  17
  18 class PostgresTypes:
  19     """ Type definitions for complex types as used in Postgres variants.
  20     """
  21     Composite = HSTORE
  22     Json = JSONB
  23     IntArray = ARRAY(sa.Integer()) #pylint: disable=invalid-name
  24     to_array = array
  25
  26
  27 class SqliteTypes:
  28     """ Type definitions for complex types as used in Postgres variants.
  29     """
  30     Composite = sqlite_json
  31     Json = sqlite_json
  32     IntArray = sqlite_json
  33
  34     @staticmethod
  35     def to_array(arr: Any) -> Any:
  36         """ Sqlite has no special conversion for arrays.
  37         """
  38         return arr
  39
  40
  41 #pylint: disable=too-many-instance-attributes
  42 class SearchTables:
  43     """ Data class that holds the tables of the Nominatim database.
  44
  45         This schema strictly reflects the read-access view of the database.
  46         Any data used for updates only will not be visible.
  47     """
  48
  49     def __init__(self, meta: sa.MetaData, engine_name: str) -> None:
  50         if engine_name == 'postgresql':
  51             self.types: Any = PostgresTypes
  52         elif engine_name == 'sqlite':
  53             self.types = SqliteTypes
  54         else:
  55             raise ValueError("Only 'postgresql' and 'sqlite' engines are supported.")
  56
  57         self.meta = meta
  58
  59         self.import_status = sa.Table('import_status', meta,
  60             sa.Column('lastimportdate', sa.DateTime(True), nullable=False),
  61             sa.Column('sequence_id', sa.Integer),
  62             sa.Column('indexed', sa.Boolean))
  63
  64         self.properties = sa.Table('nominatim_properties', meta,
  65             sa.Column('property', sa.Text, nullable=False),
  66             sa.Column('value', sa.Text))
  67
  68         self.placex = sa.Table('placex', meta,
  69             sa.Column('place_id', sa.BigInteger, nullable=False),
  70             sa.Column('parent_place_id', sa.BigInteger),
  71             sa.Column('linked_place_id', sa.BigInteger),
  72             sa.Column('importance', sa.Float),
  73             sa.Column('indexed_date', sa.DateTime),
  74             sa.Column('rank_address', sa.SmallInteger),
  75             sa.Column('rank_search', sa.SmallInteger),
  76             sa.Column('indexed_status', sa.SmallInteger),
  77             sa.Column('osm_type', sa.String(1), nullable=False),
  78             sa.Column('osm_id', sa.BigInteger, nullable=False),
  79             sa.Column('class', sa.Text, nullable=False, key='class_'),
  80             sa.Column('type', sa.Text, nullable=False),
  81             sa.Column('admin_level', sa.SmallInteger),
  82             sa.Column('name', self.types.Composite),
  83             sa.Column('address', self.types.Composite),
  84             sa.Column('extratags', self.types.Composite),
  85             sa.Column('geometry', Geometry, nullable=False),
  86             sa.Column('wikipedia', sa.Text),
  87             sa.Column('country_code', sa.String(2)),
  88             sa.Column('housenumber', sa.Text),
  89             sa.Column('postcode', sa.Text),
  90             sa.Column('centroid', Geometry))
  91
  92         self.addressline = sa.Table('place_addressline', meta,
  93             sa.Column('place_id', sa.BigInteger),
  94             sa.Column('address_place_id', sa.BigInteger),
  95             sa.Column('distance', sa.Float),
  96             sa.Column('fromarea', sa.Boolean),
  97             sa.Column('isaddress', sa.Boolean))
  98
  99         self.postcode = sa.Table('location_postcode', meta,
 100             sa.Column('place_id', sa.BigInteger),
 101             sa.Column('parent_place_id', sa.BigInteger),
 102             sa.Column('rank_search', sa.SmallInteger),
 103             sa.Column('rank_address', sa.SmallInteger),
 104             sa.Column('indexed_status', sa.SmallInteger),
 105             sa.Column('indexed_date', sa.DateTime),
 106             sa.Column('country_code', sa.String(2)),
 107             sa.Column('postcode', sa.Text),
 108             sa.Column('geometry', Geometry))
 109
 110         self.osmline = sa.Table('location_property_osmline', meta,
 111             sa.Column('place_id', sa.BigInteger, nullable=False),
 112             sa.Column('osm_id', sa.BigInteger),
 113             sa.Column('parent_place_id', sa.BigInteger),
 114             sa.Column('indexed_date', sa.DateTime),
 115             sa.Column('startnumber', sa.Integer),
 116             sa.Column('endnumber', sa.Integer),
 117             sa.Column('step', sa.SmallInteger),
 118             sa.Column('indexed_status', sa.SmallInteger),
 119             sa.Column('linegeo', Geometry),
 120             sa.Column('address', self.types.Composite),
 121             sa.Column('postcode', sa.Text),
 122             sa.Column('country_code', sa.String(2)))
 123
 124         self.country_name = sa.Table('country_name', meta,
 125             sa.Column('country_code', sa.String(2)),
 126             sa.Column('name', self.types.Composite),
 127             sa.Column('derived_name', self.types.Composite),
 128             sa.Column('partition', sa.Integer))
 129
 130         self.country_grid = sa.Table('country_osm_grid', meta,
 131             sa.Column('country_code', sa.String(2)),
 132             sa.Column('area', sa.Float),
 133             sa.Column('geometry', Geometry))
 134
 135         # The following tables are not necessarily present.
 136         self.search_name = sa.Table('search_name', meta,
 137             sa.Column('place_id', sa.BigInteger),
 138             sa.Column('importance', sa.Float),
 139             sa.Column('search_rank', sa.SmallInteger),
 140             sa.Column('address_rank', sa.SmallInteger),
 141             sa.Column('name_vector', self.types.IntArray),
 142             sa.Column('nameaddress_vector', self.types.IntArray),
 143             sa.Column('country_code', sa.String(2)),
 144             sa.Column('centroid', Geometry))
 145
 146         self.tiger = sa.Table('location_property_tiger', meta,
 147             sa.Column('place_id', sa.BigInteger),
 148             sa.Column('parent_place_id', sa.BigInteger),
 149             sa.Column('startnumber', sa.Integer),
 150             sa.Column('endnumber', sa.Integer),
 151             sa.Column('step', sa.SmallInteger),
 152             sa.Column('linegeo', Geometry),
 153             sa.Column('postcode', sa.Text))