src/nominatim_db/db/sql_preprocessor.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) 2024 by the Nominatim developer community.
   6 # For a full list of authors see the git log.
   7 """
   8 Preprocessing of SQL files.
   9 """
  10 from typing import Set, Dict, Any, cast
  11
  12 import jinja2
  13
  14 from .connection import Connection
  15 from ..config import Configuration
  16 from ..db.query_pool import QueryPool
  17
  18
  19 def _get_partitions(conn: Connection) -> Set[int]:
  20     """ Get the set of partitions currently in use.
  21     """
  22     with conn.cursor() as cur:
  23         cur.execute('SELECT DISTINCT partition FROM country_name')
  24         partitions = set([0])
  25         for row in cur:
  26             partitions.add(row[0])
  27
  28     return partitions
  29
  30
  31 def _get_tables(conn: Connection) -> Set[str]:
  32     """ Return the set of tables currently in use.
  33     """
  34     with conn.cursor() as cur:
  35         cur.execute("SELECT tablename FROM pg_tables WHERE schemaname = 'public'")
  36
  37         return set((row[0] for row in list(cur)))
  38
  39
  40 def _get_middle_db_format(conn: Connection, tables: Set[str]) -> str:
  41     """ Returns the version of the slim middle tables.
  42     """
  43     if 'osm2pgsql_properties' not in tables:
  44         return '1'
  45
  46     with conn.cursor() as cur:
  47         cur.execute("SELECT value FROM osm2pgsql_properties WHERE property = 'db_format'")
  48         row = cur.fetchone()
  49
  50         return cast(str, row[0]) if row is not None else '1'
  51
  52
  53 def _setup_tablespace_sql(config: Configuration) -> Dict[str, str]:
  54     """ Returns a dict with tablespace expressions for the different tablespace
  55         kinds depending on whether a tablespace is configured or not.
  56     """
  57     out = {}
  58     for subset in ('ADDRESS', 'SEARCH', 'AUX'):
  59         for kind in ('DATA', 'INDEX'):
  60             tspace = getattr(config, f'TABLESPACE_{subset}_{kind}')
  61             if tspace:
  62                 tspace = f'TABLESPACE "{tspace}"'
  63             out[f'{subset.lower()}_{kind.lower()}'] = tspace
  64
  65     return out
  66
  67
  68 def _setup_postgresql_features(conn: Connection) -> Dict[str, Any]:
  69     """ Set up a dictionary with various optional Postgresql/Postgis features that
  70         depend on the database version.
  71     """
  72     return {}
  73
  74
  75 class SQLPreprocessor:
  76     """ A environment for preprocessing SQL files from the
  77         lib-sql directory.
  78
  79         The preprocessor provides a number of default filters and variables.
  80         The variables may be overwritten when rendering an SQL file.
  81
  82         The preprocessing is currently based on the jinja2 templating library
  83         and follows its syntax.
  84     """
  85
  86     def __init__(self, conn: Connection, config: Configuration) -> None:
  87         self.env = jinja2.Environment(autoescape=False,
  88                                       loader=jinja2.FileSystemLoader(str(config.lib_dir.sql)))
  89
  90         db_info: Dict[str, Any] = {}
  91         db_info['partitions'] = _get_partitions(conn)
  92         db_info['tables'] = _get_tables(conn)
  93         db_info['reverse_only'] = 'search_name' not in db_info['tables']
  94         db_info['tablespace'] = _setup_tablespace_sql(config)
  95         db_info['middle_db_format'] = _get_middle_db_format(conn, db_info['tables'])
  96
  97         self.env.globals['config'] = config
  98         self.env.globals['db'] = db_info
  99         self.env.globals['postgres'] = _setup_postgresql_features(conn)
 100
 101     def run_string(self, conn: Connection, template: str, **kwargs: Any) -> None:
 102         """ Execute the given SQL template string on the connection.
 103             The keyword arguments may supply additional parameters
 104             for preprocessing.
 105         """
 106         sql = self.env.from_string(template).render(**kwargs)
 107
 108         with conn.cursor() as cur:
 109             cur.execute(sql)
 110         conn.commit()
 111
 112     def run_sql_file(self, conn: Connection, name: str, **kwargs: Any) -> None:
 113         """ Execute the given SQL file on the connection. The keyword arguments
 114             may supply additional parameters for preprocessing.
 115         """
 116         sql = self.env.get_template(name).render(**kwargs)
 117
 118         with conn.cursor() as cur:
 119             cur.execute(sql)
 120         conn.commit()
 121
 122     async def run_parallel_sql_file(self, dsn: str, name: str, num_threads: int = 1,
 123                                     **kwargs: Any) -> None:
 124         """ Execute the given SQL files using parallel asynchronous connections.
 125             The keyword arguments may supply additional parameters for
 126             preprocessing.
 127
 128             After preprocessing the SQL code is cut at lines containing only
 129             '---'. Each chunk is sent to one of the `num_threads` workers.
 130         """
 131         sql = self.env.get_template(name).render(**kwargs)
 132
 133         parts = sql.split('\n---\n')
 134
 135         async with QueryPool(dsn, num_threads) as pool:
 136             for part in parts:
 137                 await pool.put_query(part, None)