nominatim/clicmd/setup.py

   1 """
   2 Implementation of the 'import' subcommand.
   3 """
   4 import logging
   5 from pathlib import Path
   6
   7 import psutil
   8
   9 from ..tools.exec_utils import run_legacy_script
  10 from ..db.connection import connect
  11 from ..db import status
  12 from ..errors import UsageError
  13
  14 # Do not repeat documentation of subcommand classes.
  15 # pylint: disable=C0111
  16 # Using non-top-level imports to avoid eventually unused imports.
  17 # pylint: disable=E0012,C0415
  18
  19 LOG = logging.getLogger()
  20
  21 class SetupAll:
  22     """\
  23     Create a new Nominatim database from an OSM file.
  24     """
  25
  26     @staticmethod
  27     def add_args(parser):
  28         group_name = parser.add_argument_group('Required arguments')
  29         group = group_name.add_mutually_exclusive_group(required=True)
  30         group.add_argument('--osm-file', metavar='FILE',
  31                            help='OSM file to be imported.')
  32         group.add_argument('--continue', dest='continue_at',
  33                            choices=['load-data', 'indexing', 'db-postprocess'],
  34                            help='Continue an import that was interrupted')
  35         group = parser.add_argument_group('Optional arguments')
  36         group.add_argument('--osm2pgsql-cache', metavar='SIZE', type=int,
  37                            help='Size of cache to be used by osm2pgsql (in MB)')
  38         group.add_argument('--reverse-only', action='store_true',
  39                            help='Do not create tables and indexes for searching')
  40         group.add_argument('--no-partitions', action='store_true',
  41                            help="""Do not partition search indices
  42                                    (speeds up import of single country extracts)""")
  43         group.add_argument('--no-updates', action='store_true',
  44                            help="""Do not keep tables that are only needed for
  45                                    updating the database later""")
  46         group = parser.add_argument_group('Expert options')
  47         group.add_argument('--ignore-errors', action='store_true',
  48                            help='Continue import even when errors in SQL are present')
  49         group.add_argument('--index-noanalyse', action='store_true',
  50                            help='Do not perform analyse operations during index')
  51
  52
  53     @staticmethod
  54     def run(args): # pylint: disable=too-many-statements
  55         from ..tools import database_import
  56         from ..tools import refresh
  57         from ..indexer.indexer import Indexer
  58
  59         if args.osm_file and not Path(args.osm_file).is_file():
  60             LOG.fatal("OSM file '%s' does not exist.", args.osm_file)
  61             raise UsageError('Cannot access file.')
  62
  63         if args.continue_at is None:
  64             database_import.setup_database_skeleton(args.config.get_libpq_dsn(),
  65                                                     args.data_dir,
  66                                                     args.no_partitions,
  67                                                     rouser=args.config.DATABASE_WEBUSER)
  68
  69             LOG.warning('Installing database module')
  70             with connect(args.config.get_libpq_dsn()) as conn:
  71                 database_import.install_module(args.module_dir, args.project_dir,
  72                                                args.config.DATABASE_MODULE_PATH,
  73                                                conn=conn)
  74
  75             LOG.warning('Importing OSM data file')
  76             database_import.import_osm_data(Path(args.osm_file),
  77                                             args.osm2pgsql_options(0, 1),
  78                                             drop=args.no_updates,
  79                                             ignore_errors=args.ignore_errors)
  80
  81             LOG.warning('Create functions (1st pass)')
  82             with connect(args.config.get_libpq_dsn()) as conn:
  83                 refresh.create_functions(conn, args.config, args.sqllib_dir,
  84                                          False, False)
  85
  86             LOG.warning('Create tables')
  87             params = ['setup.php', '--create-tables', '--create-partition-tables']
  88             if args.reverse_only:
  89                 params.append('--reverse-only')
  90             run_legacy_script(*params, nominatim_env=args,
  91                               throw_on_fail=not args.ignore_errors)
  92
  93             LOG.warning('Create functions (2nd pass)')
  94             with connect(args.config.get_libpq_dsn()) as conn:
  95                 refresh.create_functions(conn, args.config, args.sqllib_dir,
  96                                          False, False)
  97
  98             LOG.warning('Importing wikipedia importance data')
  99             data_path = Path(args.config.WIKIPEDIA_DATA_PATH or args.project_dir)
 100             if refresh.import_wikipedia_articles(args.config.get_libpq_dsn(),
 101                                                  data_path) > 0:
 102                 LOG.error('Wikipedia importance dump file not found. '
 103                           'Will be using default importances.')
 104
 105             LOG.warning('Initialise tables')
 106             with connect(args.config.get_libpq_dsn()) as conn:
 107                 database_import.truncate_data_tables(conn, args.config.MAX_WORD_FREQUENCY)
 108
 109         if args.continue_at is None or args.continue_at == 'load-data':
 110             LOG.warning('Load data into placex table')
 111             database_import.load_data(args.config.get_libpq_dsn(),
 112                                       args.data_dir,
 113                                       args.threads or psutil.cpu_count() or 1)
 114
 115             LOG.warning('Calculate postcodes')
 116             run_legacy_script('setup.php', '--calculate-postcodes',
 117                               nominatim_env=args, throw_on_fail=not args.ignore_errors)
 118
 119         if args.continue_at is None or args.continue_at in ('load-data', 'indexing'):
 120             LOG.warning('Indexing places')
 121             indexer = Indexer(args.config.get_libpq_dsn(),
 122                               args.threads or psutil.cpu_count() or 1)
 123             indexer.index_full(analyse=not args.index_noanalyse)
 124
 125         LOG.warning('Post-process tables')
 126         params = ['setup.php', '--create-search-indices', '--create-country-names']
 127         if args.no_updates:
 128             params.append('--drop')
 129         run_legacy_script(*params, nominatim_env=args, throw_on_fail=not args.ignore_errors)
 130
 131         webdir = args.project_dir / 'website'
 132         LOG.warning('Setup website at %s', webdir)
 133         refresh.setup_website(webdir, args.phplib_dir, args.config)
 134
 135         with connect(args.config.get_libpq_dsn()) as conn:
 136             try:
 137                 dbdate = status.compute_database_date(conn)
 138                 status.set_status(conn, dbdate)
 139                 LOG.info('Database is at %s.', dbdate)
 140             except Exception as exc: # pylint: disable=broad-except
 141                 LOG.error('Cannot determine date of database: %s', exc)
 142
 143         return 0