# SPDX-License-Identifier: GPL-2.0-only
#
# This file is part of Nominatim.
-# Copyright (C) 2020 Sarah Hoffmann
-
+# Copyright (C) 2021 by the Nominatim developer community.
+# For a full list of authors see the git log.
+""" Database helper functions for the indexer.
+"""
import logging
import psycopg2
from psycopg2.extras import wait_select
-log = logging.getLogger()
+LOG = logging.getLogger()
def make_connection(options, asynchronous=False):
+ """ Create a psycopg2 connection from the given options.
+ """
params = {'dbname' : options.dbname,
'user' : options.user,
'password' : options.password,
return psycopg2.connect(**params)
-class DBConnection(object):
+class DBConnection:
""" A single non-blocking database connection.
"""
self.options = options
self.conn = None
+ self.cursor = None
self.connect()
def connect(self):
# implemented.
self.perform(
""" UPDATE pg_settings SET setting = -1 WHERE name = 'jit_above_cost';
- UPDATE pg_settings SET setting = 0
+ UPDATE pg_settings SET setting = 0
WHERE name = 'max_parallel_workers_per_gather';""")
self.wait()
wait_select(self.conn)
self.current_query = None
return
- except psycopg2.extensions.TransactionRollbackError as e:
- if e.pgcode == '40P01':
- log.info("Deadlock detected (params = {}), retry."
- .format(self.current_params))
+ except psycopg2.extensions.TransactionRollbackError as error:
+ if error.pgcode == '40P01':
+ LOG.info("Deadlock detected (params = %s), retry.",
+ str(self.current_params))
self.cursor.execute(self.current_query, self.current_params)
else:
raise
- except psycopg2.errors.DeadlockDetected:
+ except psycopg2.errors.DeadlockDetected: # pylint: disable=E1101
self.cursor.execute(self.current_query, self.current_params)
def perform(self, sql, args=None):
if self.conn.poll() == psycopg2.extensions.POLL_OK:
self.current_query = None
return True
- except psycopg2.extensions.TransactionRollbackError as e:
- if e.pgcode == '40P01':
- log.info("Deadlock detected (params = {}), retry.".format(self.current_params))
+ except psycopg2.extensions.TransactionRollbackError as error:
+ if error.pgcode == '40P01':
+ LOG.info("Deadlock detected (params = %s), retry.", str(self.current_params))
self.cursor.execute(self.current_query, self.current_params)
else:
raise
- except psycopg2.errors.DeadlockDetected:
+ except psycopg2.errors.DeadlockDetected: # pylint: disable=E1101
self.cursor.execute(self.current_query, self.current_params)
return False
-
# along with this program; if not, write to the Free Software
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
#-----------------------------------------------------------------------------
-
-from argparse import ArgumentParser, RawDescriptionHelpFormatter, ArgumentTypeError
+# pylint: disable=C0111
+from argparse import ArgumentParser, RawDescriptionHelpFormatter
import logging
import sys
-import re
import getpass
-from datetime import datetime
import select
-from indexer.progress import ProgressLogger
-from indexer.db import DBConnection, make_connection
+from indexer.progress import ProgressLogger # pylint: disable=E0401
+from indexer.db import DBConnection, make_connection # pylint: disable=E0401
-log = logging.getLogger()
+LOG = logging.getLogger()
-class RankRunner(object):
+class RankRunner:
""" Returns SQL commands for indexing one rank within the placex table.
"""
WHERE indexed_status > 0 and rank_address = {}
ORDER BY geometry_sector""".format(self.rank)
- def sql_index_place(self, ids):
+ @staticmethod
+ def sql_index_place(ids):
return "UPDATE placex SET indexed_status = 0 WHERE place_id IN ({})"\
.format(','.join((str(i) for i in ids)))
-class InterpolationRunner(object):
+class InterpolationRunner:
""" Returns SQL commands for indexing the address interpolation table
location_property_osmline.
"""
- def name(self):
+ @staticmethod
+ def name():
return "interpolation lines (location_property_osmline)"
- def sql_count_objects(self):
+ @staticmethod
+ def sql_count_objects():
return """SELECT count(*) FROM location_property_osmline
WHERE indexed_status > 0"""
- def sql_get_objects(self):
+ @staticmethod
+ def sql_get_objects():
return """SELECT place_id FROM location_property_osmline
WHERE indexed_status > 0
ORDER BY geometry_sector"""
- def sql_index_place(self, ids):
+ @staticmethod
+ def sql_index_place(ids):
return """UPDATE location_property_osmline
SET indexed_status = 0 WHERE place_id IN ({})"""\
.format(','.join((str(i) for i in ids)))
-class BoundaryRunner(object):
+class BoundaryRunner:
""" Returns SQL commands for indexing the administrative boundaries
of a certain rank.
"""
and class = 'boundary' and type = 'administrative'
ORDER BY partition, admin_level""".format(self.rank)
- def sql_index_place(self, ids):
+ @staticmethod
+ def sql_index_place(ids):
return "UPDATE placex SET indexed_status = 0 WHERE place_id IN ({})"\
.format(','.join((str(i) for i in ids)))
-class Indexer(object):
+class Indexer:
""" Main indexing routine.
"""
- def __init__(self, options):
- self.minrank = max(1, options.minrank)
- self.maxrank = min(30, options.maxrank)
- self.conn = make_connection(options)
- self.threads = [DBConnection(options) for i in range(options.threads)]
+ def __init__(self, opts):
+ self.minrank = max(1, opts.minrank)
+ self.maxrank = min(30, opts.maxrank)
+ self.conn = make_connection(opts)
+ self.threads = [DBConnection(opts) for _ in range(opts.threads)]
def index_boundaries(self):
- log.warning("Starting indexing boundaries using {} threads".format(
- len(self.threads)))
+ LOG.warning("Starting indexing boundaries using %s threads",
+ len(self.threads))
for rank in range(max(self.minrank, 5), min(self.maxrank, 26)):
self.index(BoundaryRunner(rank))
def index_by_rank(self):
""" Run classic indexing by rank.
"""
- log.warning("Starting indexing rank ({} to {}) using {} threads".format(
- self.minrank, self.maxrank, len(self.threads)))
+ LOG.warning("Starting indexing rank (%i to %i) using %i threads",
+ self.minrank, self.maxrank, len(self.threads))
for rank in range(max(1, self.minrank), self.maxrank):
self.index(RankRunner(rank))
for indexing. `batch` describes the number of objects that
should be processed with a single SQL statement
"""
- log.warning("Starting %s (using batch size %s)", obj.name(), batch)
+ LOG.warning("Starting %s (using batch size %s)", obj.name(), batch)
cur = self.conn.cursor()
cur.execute(obj.sql_count_objects())
total_tuples = cur.fetchone()[0]
- log.debug("Total number of rows: {}".format(total_tuples))
+ LOG.debug("Total number of rows: %i", total_tuples)
cur.close()
next_thread = self.find_free_thread()
while True:
places = [p[0] for p in cur.fetchmany(batch)]
- if len(places) == 0:
+ if not places:
break
- log.debug("Processing places: {}".format(places))
+ LOG.debug("Processing places: %s", str(places))
thread = next(next_thread)
thread.perform(obj.sql_index_place(places))
cur.close()
- for t in self.threads:
- t.wait()
+ for thread in self.threads:
+ thread.wait()
progress.done()
# refresh the connections occasionaly to avoid potential
# memory leaks in Postgresql.
if command_stat > 100000:
- for t in self.threads:
- while not t.is_done():
- t.wait()
- t.connect()
+ for thread in self.threads:
+ while not thread.is_done():
+ thread.wait()
+ thread.connect()
command_stat = 0
ready = self.threads
else:
def nominatim_arg_parser():
""" Setup the command-line parser for the tool.
"""
- def h(s):
- return re.sub("\s\s+" , " ", s)
-
- p = ArgumentParser(description="Indexing tool for Nominatim.",
- formatter_class=RawDescriptionHelpFormatter)
-
- p.add_argument('-d', '--database',
- dest='dbname', action='store', default='nominatim',
- help='Name of the PostgreSQL database to connect to.')
- p.add_argument('-U', '--username',
- dest='user', action='store',
- help='PostgreSQL user name.')
- p.add_argument('-W', '--password',
- dest='password_prompt', action='store_true',
- help='Force password prompt.')
- p.add_argument('-H', '--host',
- dest='host', action='store',
- help='PostgreSQL server hostname or socket location.')
- p.add_argument('-P', '--port',
- dest='port', action='store',
- help='PostgreSQL server port')
- p.add_argument('-b', '--boundary-only',
- dest='boundary_only', action='store_true',
- help='Only index administrative boundaries (ignores min/maxrank).')
- p.add_argument('-r', '--minrank',
- dest='minrank', type=int, metavar='RANK', default=0,
- help='Minimum/starting rank.')
- p.add_argument('-R', '--maxrank',
- dest='maxrank', type=int, metavar='RANK', default=30,
- help='Maximum/finishing rank.')
- p.add_argument('-t', '--threads',
- dest='threads', type=int, metavar='NUM', default=1,
- help='Number of threads to create for indexing.')
- p.add_argument('-v', '--verbose',
- dest='loglevel', action='count', default=0,
- help='Increase verbosity')
-
- return p
+ parser = ArgumentParser(description="Indexing tool for Nominatim.",
+ formatter_class=RawDescriptionHelpFormatter)
+
+ parser.add_argument('-d', '--database',
+ dest='dbname', action='store', default='nominatim',
+ help='Name of the PostgreSQL database to connect to.')
+ parser.add_argument('-U', '--username',
+ dest='user', action='store',
+ help='PostgreSQL user name.')
+ parser.add_argument('-W', '--password',
+ dest='password_prompt', action='store_true',
+ help='Force password prompt.')
+ parser.add_argument('-H', '--host',
+ dest='host', action='store',
+ help='PostgreSQL server hostname or socket location.')
+ parser.add_argument('-P', '--port',
+ dest='port', action='store',
+ help='PostgreSQL server port')
+ parser.add_argument('-b', '--boundary-only',
+ dest='boundary_only', action='store_true',
+ help='Only index administrative boundaries (ignores min/maxrank).')
+ parser.add_argument('-r', '--minrank',
+ dest='minrank', type=int, metavar='RANK', default=0,
+ help='Minimum/starting rank.')
+ parser.add_argument('-R', '--maxrank',
+ dest='maxrank', type=int, metavar='RANK', default=30,
+ help='Maximum/finishing rank.')
+ parser.add_argument('-t', '--threads',
+ dest='threads', type=int, metavar='NUM', default=1,
+ help='Number of threads to create for indexing.')
+ parser.add_argument('-v', '--verbose',
+ dest='loglevel', action='count', default=0,
+ help='Increase verbosity')
+
+ return parser
if __name__ == '__main__':
logging.basicConfig(stream=sys.stderr, format='%(levelname)s: %(message)s')
- options = nominatim_arg_parser().parse_args(sys.argv[1:])
+ OPTIONS = nominatim_arg_parser().parse_args(sys.argv[1:])
- log.setLevel(max(3 - options.loglevel, 0) * 10)
+ LOG.setLevel(max(3 - OPTIONS.loglevel, 0) * 10)
- options.password = None
- if options.password_prompt:
- password = getpass.getpass("Database password: ")
- options.password = password
+ OPTIONS.password = None
+ if OPTIONS.password_prompt:
+ PASSWORD = getpass.getpass("Database password: ")
+ OPTIONS.password = PASSWORD
- if options.boundary_only:
- Indexer(options).index_boundaries()
+ if OPTIONS.boundary_only:
+ Indexer(OPTIONS).index_boundaries()
else:
- Indexer(options).index_by_rank()
+ Indexer(OPTIONS).index_by_rank()