]> git.openstreetmap.org Git - nominatim.git/blob - utils/setup.php
Merge remote-tracking branch 'upstream/master'
[nominatim.git] / utils / setup.php
1 <?php
2
3 require_once(CONST_BasePath.'/lib/init-cmd.php');
4 require_once(CONST_BasePath.'/lib/setup/SetupClass.php');
5 require_once(CONST_BasePath.'/lib/setup_functions.php');
6 ini_set('memory_limit', '800M');
7
8 use Nominatim\Setup\SetupFunctions as SetupFunctions;
9
10 // (long-opt, short-opt, min-occurs, max-occurs, num-arguments, num-arguments, type, help)
11 $aCMDOptions
12 = array(
13    'Create and setup nominatim search system',
14    array('help', 'h', 0, 1, 0, 0, false, 'Show Help'),
15    array('quiet', 'q', 0, 1, 0, 0, 'bool', 'Quiet output'),
16    array('verbose', 'v', 0, 1, 0, 0, 'bool', 'Verbose output'),
17
18    array('osm-file', '', 0, 1, 1, 1, 'realpath', 'File to import'),
19    array('threads', '', 0, 1, 1, 1, 'int', 'Number of threads (where possible)'),
20
21    array('all', '', 0, 1, 0, 0, 'bool', 'Do the complete process'),
22
23    array('create-db', '', 0, 1, 0, 0, 'bool', 'Create nominatim db'),
24    array('setup-db', '', 0, 1, 0, 0, 'bool', 'Build a blank nominatim db'),
25    array('import-data', '', 0, 1, 0, 0, 'bool', 'Import a osm file'),
26    array('osm2pgsql-cache', '', 0, 1, 1, 1, 'int', 'Cache size used by osm2pgsql'),
27    array('reverse-only', '', 0, 1, 0, 0, 'bool', 'Do not create search tables and indexes'),
28    array('create-functions', '', 0, 1, 0, 0, 'bool', 'Create functions'),
29    array('enable-diff-updates', '', 0, 1, 0, 0, 'bool', 'Turn on the code required to make diff updates work'),
30    array('enable-debug-statements', '', 0, 1, 0, 0, 'bool', 'Include debug warning statements in pgsql commands'),
31    array('ignore-errors', '', 0, 1, 0, 0, 'bool', 'Continue import even when errors in SQL are present (EXPERT)'),
32    array('create-tables', '', 0, 1, 0, 0, 'bool', 'Create main tables'),
33    array('create-partition-tables', '', 0, 1, 0, 0, 'bool', 'Create required partition tables'),
34    array('create-partition-functions', '', 0, 1, 0, 0, 'bool', 'Create required partition triggers'),
35    array('no-partitions', '', 0, 1, 0, 0, 'bool', 'Do not partition search indices (speeds up import of single country extracts)'),
36    array('import-wikipedia-articles', '', 0, 1, 0, 0, 'bool', 'Import wikipedia article dump'),
37    array('load-data', '', 0, 1, 0, 0, 'bool', 'Copy data to live tables from import table'),
38    array('disable-token-precalc', '', 0, 1, 0, 0, 'bool', 'Disable name precalculation (EXPERT)'),
39    array('import-tiger-data', '', 0, 1, 0, 0, 'bool', 'Import tiger data (not included in \'all\')'),
40    array('calculate-postcodes', '', 0, 1, 0, 0, 'bool', 'Calculate postcode centroids'),
41    array('index', '', 0, 1, 0, 0, 'bool', 'Index the data'),
42    array('index-noanalyse', '', 0, 1, 0, 0, 'bool', 'Do not perform analyse operations during index (EXPERT)'),
43    array('create-search-indices', '', 0, 1, 0, 0, 'bool', 'Create additional indices required for search and update'),
44    array('create-country-names', '', 0, 1, 0, 0, 'bool', 'Create default list of searchable country names'),
45    array('drop', '', 0, 1, 0, 0, 'bool', 'Drop tables needed for updates, making the database readonly (EXPERIMENTAL)'),
46    array('setup-website', '', 0, 1, 0, 0, 'bool', 'Used to compile environment variables for the website'),
47   );
48
49 // $aCMDOptions passed to getCmdOpt by reference
50 getCmdOpt($_SERVER['argv'], $aCMDOptions, $aCMDResult, true, true);
51
52 $bDidSomething = false;
53
54 //*******************************************************
55 // Making some sanity check:
56 // Check if osm-file is set and points to a valid file
57 if ($aCMDResult['import-data'] || $aCMDResult['all']) {
58     // to remain in /lib/setup_functions.php function
59     checkInFile($aCMDResult['osm-file']);
60 }
61
62 // ******************************************************
63 // instantiate Setup class
64 $oSetup = new SetupFunctions($aCMDResult);
65
66 // *******************************************************
67 // go through complete process if 'all' is selected or start selected functions
68 if ($aCMDResult['create-db'] || $aCMDResult['all']) {
69     $bDidSomething = true;
70     $oSetup->createDB();
71 }
72
73 if ($aCMDResult['setup-db'] || $aCMDResult['all']) {
74     $bDidSomething = true;
75     $oSetup->setupDB();
76 }
77
78 if ($aCMDResult['import-data'] || $aCMDResult['all']) {
79     $bDidSomething = true;
80     $oSetup->importData($aCMDResult['osm-file']);
81 }
82
83 if ($aCMDResult['create-functions'] || $aCMDResult['all']) {
84     $bDidSomething = true;
85     $oSetup->createFunctions();
86 }
87
88 if ($aCMDResult['create-tables'] || $aCMDResult['all']) {
89     $bDidSomething = true;
90     $oSetup->createTables($aCMDResult['reverse-only']);
91     $oSetup->createFunctions();
92     $oSetup->createTableTriggers();
93 }
94
95 if ($aCMDResult['create-partition-tables'] || $aCMDResult['all']) {
96     $bDidSomething = true;
97     $oSetup->createPartitionTables();
98 }
99
100 if ($aCMDResult['create-partition-functions'] || $aCMDResult['all']) {
101     $bDidSomething = true;
102     $oSetup->createPartitionFunctions();
103 }
104
105 if ($aCMDResult['import-wikipedia-articles'] || $aCMDResult['all']) {
106     $bDidSomething = true;
107     $oSetup->importWikipediaArticles();
108 }
109
110 if ($aCMDResult['load-data'] || $aCMDResult['all']) {
111     $bDidSomething = true;
112     $oSetup->loadData($aCMDResult['disable-token-precalc']);
113 }
114
115 if ($aCMDResult['import-tiger-data']) {
116     $bDidSomething = true;
117     $oSetup->importTigerData();
118 }
119
120 if ($aCMDResult['calculate-postcodes'] || $aCMDResult['all']) {
121     $bDidSomething = true;
122     $oSetup->calculatePostcodes($aCMDResult['all']);
123 }
124
125 if ($aCMDResult['index'] || $aCMDResult['all']) {
126     $bDidSomething = true;
127     $oSetup->index($aCMDResult['index-noanalyse']);
128 }
129
130 if ($aCMDResult['drop']) {
131     $bDidSomething = true;
132     $oSetup->drop($aCMDResult);
133 }
134
135 if ($aCMDResult['create-search-indices'] || $aCMDResult['all']) {
136     $bDidSomething = true;
137     $oSetup->createSearchIndices();
138 }
139
140 if ($aCMDResult['create-country-names'] || $aCMDResult['all']) {
141     $bDidSomething = true;
142     $oSetup->createCountryNames($aCMDResult);
143 }
144
145 if ($aCMDResult['setup-website'] || $aCMDResult['all']) {
146     $bDidSomething = true;
147     $oSetup->setupWebsite();
148 }
149
150 // ******************************************************
151 // If we did something, repeat the warnings
152 if (!$bDidSomething) {
153     showUsage($aCMDOptions, true);
154 } else {
155     echo "Summary of warnings:\n\n";
156     repeatWarnings();
157     echo "\n";
158     info('Setup finished.');
159 }