]> git.openstreetmap.org Git - nominatim.git/blob - src/nominatim_db/clicmd/admin.py
ensure consistent country assignments
[nominatim.git] / src / nominatim_db / clicmd / admin.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 Implementation of the 'admin' subcommand.
9 """
10 import logging
11 import argparse
12 import random
13
14 from ..errors import UsageError
15 from ..db.connection import connect, table_exists
16 from .args import NominatimArgs
17
18 # Do not repeat documentation of subcommand classes.
19 # pylint: disable=C0111
20 # Using non-top-level imports to avoid eventually unused imports.
21 # pylint: disable=E0012,C0415
22
23 LOG = logging.getLogger()
24
25
26 class AdminFuncs:
27     """\
28     Analyse and maintain the database.
29     """
30
31     def add_args(self, parser: argparse.ArgumentParser) -> None:
32         group = parser.add_argument_group('Admin tasks')
33         objs = group.add_mutually_exclusive_group(required=True)
34         objs.add_argument('--warm', action='store_true',
35                           help='Warm database caches for search and reverse queries')
36         objs.add_argument('--check-database', action='store_true',
37                           help='Check that the database is complete and operational')
38         objs.add_argument('--migrate', action='store_true',
39                           help='Migrate the database to a new software version')
40         objs.add_argument('--analyse-indexing', action='store_true',
41                           help='Print performance analysis of the indexing process')
42         objs.add_argument('--collect-os-info', action="store_true",
43                           help="Generate a report about the host system information")
44         objs.add_argument('--clean-deleted', action='store', metavar='AGE',
45                           help='Clean up deleted relations')
46         group = parser.add_argument_group('Arguments for cache warming')
47         group.add_argument('--search-only', action='store_const', dest='target',
48                            const='search',
49                            help="Only pre-warm tables for search queries")
50         group.add_argument('--reverse-only', action='store_const', dest='target',
51                            const='reverse',
52                            help="Only pre-warm tables for reverse queries")
53         group = parser.add_argument_group('Arguments for index anaysis')
54         mgroup = group.add_mutually_exclusive_group()
55         mgroup.add_argument('--osm-id', type=str,
56                             help='Analyse indexing of the given OSM object')
57         mgroup.add_argument('--place-id', type=int,
58                             help='Analyse indexing of the given Nominatim object')
59
60
61     def run(self, args: NominatimArgs) -> int:
62         # pylint: disable=too-many-return-statements
63         if args.warm:
64             return self._warm(args)
65
66         if args.check_database:
67             LOG.warning('Checking database')
68             from ..tools import check_database
69             return check_database.check_database(args.config)
70
71         if args.analyse_indexing:
72             LOG.warning('Analysing performance of indexing function')
73             from ..tools import admin
74             admin.analyse_indexing(args.config, osm_id=args.osm_id, place_id=args.place_id)
75             return 0
76
77         if args.migrate:
78             LOG.warning('Checking for necessary database migrations')
79             from ..tools import migration
80             return migration.migrate(args.config, args)
81
82         if args.collect_os_info:
83             LOG.warning("Reporting System Information")
84             from ..tools import collect_os_info
85             collect_os_info.report_system_information(args.config)
86             return 0
87
88         if args.clean_deleted:
89             LOG.warning('Cleaning up deleted relations')
90             from ..tools import admin
91             admin.clean_deleted_relations(args.config, age=args.clean_deleted)
92             return 0
93
94         return 1
95
96
97     def _warm(self, args: NominatimArgs) -> int:
98         try:
99             import nominatim_api as napi
100         except ModuleNotFoundError as exp:
101             raise UsageError("Warming requires nominatim API. "
102                              "Install with 'pip install nominatim-api'.") from exp
103         LOG.warning('Warming database caches')
104
105         api = napi.NominatimAPI(args.project_dir)
106
107         try:
108             if args.target != 'search':
109                 for _ in range(1000):
110                     api.reverse((random.uniform(-90, 90), random.uniform(-180, 180)),
111                                 address_details=True)
112
113             if args.target != 'reverse':
114                 from ..tokenizer import factory as tokenizer_factory
115
116                 tokenizer = tokenizer_factory.get_tokenizer_for_db(args.config)
117                 with connect(args.config.get_libpq_dsn()) as conn:
118                     if table_exists(conn, 'search_name'):
119                         words = tokenizer.most_frequent_words(conn, 1000)
120                     else:
121                         words = []
122
123                 for word in words:
124                     api.search(word)
125         finally:
126             api.close()
127
128         return 0