X-Git-Url: https://git.openstreetmap.org./nominatim.git/blobdiff_plain/6a7e0d652b1d40a397e1c1386d500101796676c4..a849f3c9ec6b5db193bdce5930ebec69b55545d4:/nominatim/clicmd/admin.py?ds=inline diff --git a/nominatim/clicmd/admin.py b/nominatim/clicmd/admin.py index 8d34f386..ad900579 100644 --- a/nominatim/clicmd/admin.py +++ b/nominatim/clicmd/admin.py @@ -1,28 +1,41 @@ +# SPDX-License-Identifier: GPL-2.0-only +# +# This file is part of Nominatim. (https://nominatim.org) +# +# Copyright (C) 2022 by the Nominatim developer community. +# For a full list of authors see the git log. """ Implementation of the 'admin' subcommand. """ -from ..tools.exec_utils import run_legacy_script -from ..db.connection import connect +import logging +import argparse + +from nominatim.tools.exec_utils import run_legacy_script +from nominatim.clicmd.args import NominatimArgs # Do not repeat documentation of subcommand classes. # pylint: disable=C0111 # Using non-top-level imports to avoid eventually unused imports. # pylint: disable=E0012,C0415 +LOG = logging.getLogger() + class AdminFuncs: """\ Analyse and maintain the database. """ - @staticmethod - def add_args(parser): - group = parser.add_argument_group('Admin task arguments') - group.add_argument('--warm', action='store_true', - help='Warm database caches for search and reverse queries.') - group.add_argument('--check-database', action='store_true', - help='Check that the database is complete and operational.') - group.add_argument('--analyse-indexing', action='store_true', - help='Print performance analysis of the indexing process.') + def add_args(self, parser: argparse.ArgumentParser) -> None: + group = parser.add_argument_group('Admin tasks') + objs = group.add_mutually_exclusive_group(required=True) + objs.add_argument('--warm', action='store_true', + help='Warm database caches for search and reverse queries') + objs.add_argument('--check-database', action='store_true', + help='Check that the database is complete and operational') + objs.add_argument('--migrate', action='store_true', + help='Migrate the database to a new software version') + objs.add_argument('--analyse-indexing', action='store_true', + help='Print performance analysis of the indexing process') group = parser.add_argument_group('Arguments for cache warming') group.add_argument('--search-only', action='store_const', dest='target', const='search', @@ -37,25 +50,31 @@ class AdminFuncs: mgroup.add_argument('--place-id', type=int, help='Analyse indexing of the given Nominatim object') - @staticmethod - def run(args): - from ..tools import admin + def run(self, args: NominatimArgs) -> int: if args.warm: - AdminFuncs._warm(args) + return self._warm(args) if args.check_database: - run_legacy_script('check_import_finished.php', nominatim_env=args) + LOG.warning('Checking database') + from ..tools import check_database + return check_database.check_database(args.config) if args.analyse_indexing: - conn = connect(args.config.get_libpq_dsn()) - admin.analyse_indexing(conn, osm_id=args.osm_id, place_id=args.place_id) - conn.close() + LOG.warning('Analysing performance of indexing function') + from ..tools import admin + admin.analyse_indexing(args.config, osm_id=args.osm_id, place_id=args.place_id) + return 0 + + if args.migrate: + LOG.warning('Checking for necessary database migrations') + from ..tools import migration + return migration.migrate(args.config, args) - return 0 + return 1 - @staticmethod - def _warm(args): + def _warm(self, args: NominatimArgs) -> int: + LOG.warning('Warming database caches') params = ['warm.php'] if args.target == 'reverse': params.append('--reverse-only')