X-Git-Url: https://git.openstreetmap.org./nominatim.git/blobdiff_plain/e5206133628c0ab1cacd6c5a04a2a9a973bfc86c..a849f3c9ec6b5db193bdce5930ebec69b55545d4:/nominatim/clicmd/admin.py diff --git a/nominatim/clicmd/admin.py b/nominatim/clicmd/admin.py index fd9382eb..ad900579 100644 --- a/nominatim/clicmd/admin.py +++ b/nominatim/clicmd/admin.py @@ -1,10 +1,17 @@ +# 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. """ import logging +import argparse -from ..tools.exec_utils import run_legacy_script -from ..db.connection import connect +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 @@ -18,15 +25,17 @@ 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', @@ -41,10 +50,9 @@ class AdminFuncs: mgroup.add_argument('--place-id', type=int, help='Analyse indexing of the given Nominatim object') - @staticmethod - def run(args): + def run(self, args: NominatimArgs) -> int: if args.warm: - AdminFuncs._warm(args) + return self._warm(args) if args.check_database: LOG.warning('Checking database') @@ -54,14 +62,18 @@ class AdminFuncs: if args.analyse_indexing: LOG.warning('Analysing performance of indexing function') from ..tools import admin - with connect(args.config.get_libpq_dsn()) as conn: - admin.analyse_indexing(conn, osm_id=args.osm_id, place_id=args.place_id) + admin.analyse_indexing(args.config, osm_id=args.osm_id, place_id=args.place_id) + return 0 - return 0 + if args.migrate: + LOG.warning('Checking for necessary database migrations') + from ..tools import migration + return migration.migrate(args.config, args) + return 1 - @staticmethod - def _warm(args): + + def _warm(self, args: NominatimArgs) -> int: LOG.warning('Warming database caches') params = ['warm.php'] if args.target == 'reverse':