+# 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 nominatim.tools.exec_utils import run_legacy_script
-from nominatim.db.connection import connect
+from nominatim.clicmd.args import NominatimArgs
# Do not repeat documentation of subcommand classes.
# pylint: disable=C0111
LOG = logging.getLogger()
+
class AdminFuncs:
"""\
Analyse and maintain the database.
"""
- @staticmethod
- def add_args(parser):
+ 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='Migrate the database to a new software version')
objs.add_argument('--analyse-indexing', action='store_true',
help='Print performance analysis of the indexing process')
+ objs.add_argument('--collect-os-info', action="store_true",
+ help="Generate a report about the host system information")
group = parser.add_argument_group('Arguments for cache warming')
group.add_argument('--search-only', action='store_const', dest='target',
const='search',
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:
- return AdminFuncs._warm(args)
+ return self._warm(args)
if args.check_database:
LOG.warning('Checking database')
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
if args.migrate:
from ..tools import migration
return migration.migrate(args.config, args)
- return 1
+ if args.collect_os_info:
+ LOG.warning("Reporting System Information")
+ from ..tools import collect_os_info
+ collect_os_info.report_system_information(args.config)
+ 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')
if args.target == 'search':
params.append('--search-only')
- return run_legacy_script(*params, nominatim_env=args)
+ return run_legacy_script(*params, config=args.config)