]> git.openstreetmap.org Git - nominatim.git/blobdiff - utils/setup.php
Fix documentation links (#1760)
[nominatim.git] / utils / setup.php
old mode 100755 (executable)
new mode 100644 (file)
index 6afe196..3015f13
-#!@PHP_BIN@ -Cq\r
-<?php\r
-\r
-require_once(dirname(dirname(__FILE__)).'/settings/settings.php');\r
-require_once(CONST_BasePath.'/lib/init-cmd.php');\r
-include_once(CONST_InstallPath.'/utils/setupClass.php');\r
-// ->indirect via init-cmd.php -> /lib/cmd.php                  for runWithEnv, getCmdOpt\r
-// ->indirect via init-cmd.php -> /lib/init.php -> db.php       for &getDB()\r
-\r
-include_once(CONST_BasePath.'/lib/setup_functions.php');\r
-include_once(CONST_BasePath.'/lib/setup_functions.php');\r
-ini_set('memory_limit', '800M');\r
-\r
-\r
-$aCMDOptions = createSetupArgvArray();\r
-\r
-// $aCMDOptions passed to getCmdOpt by reference\r
-getCmdOpt($_SERVER['argv'], $aCMDOptions, $aCMDResult, true, true);\r
-\r
-\r
-$bDidSomething = false;\r
-\r
-//*******************************************************\r
-// Making some sanity check:\r
-// Check if osm-file is set and points to a valid file\r
-if ($aCMDResult['import-data'] || $aCMDResult['all']) {\r
-    // to remain in /lib/setup_functions.php function\r
-    checkInFile($aCMDResult['osm-file']);  \r
-    echo $aCMDResult['osm-file'];\r
-}\r
-\r
-// osmosis init is no longer supported\r
-if ($aCMDResult['osmosis-init']) {\r
-    $bDidSomething = true;\r
-    echo "Command 'osmosis-init' no longer available, please use utils/update.php --init-updates.\n";\r
-}\r
-\r
-// ******************************************************\r
-// instantiate Setup class\r
-$cSetup = new SetupFunctions ($aCMDResult); \r
-if ($aCMDResult['create-db'] || $aCMDResult['all']) {\r
-    $bDidSomething = true;\r
-    $cSetup -> createDB();\r
-}\r
-\r
-// *******************************************************\r
-// go through complete process if 'all' is selected or start selected functions\r
-if ($aCMDResult['setup-db'] || $aCMDResult['all']) {\r
-    $bDidSomething = true;\r
-    $cSetup -> setupDB();\r
-}\r
-\r
-// Try accessing the C module, so we know early if something is wrong\r
-if (!checkModulePresence()) {\r
-    fail('error loading nominatim.so module');\r
-}\r
-\r
-if ($aCMDResult['import-data'] || $aCMDResult['all']) {\r
-    $bDidSomething = true;\r
-    $cSetup -> importData($aCMDResult['osm-file']);\r
-}\r
\r
-if ($aCMDResult['create-functions'] || $aCMDResult['all']) {\r
-    $bDidSomething = true;\r
-    $cSetup -> createFunctions();\r
-}\r
-\r
-if ($aCMDResult['create-tables'] || $aCMDResult['all']) {\r
-    $bDidSomething = true;\r
-    $cSetup -> createTables();\r
-}\r
-\r
-if ($aCMDResult['create-partition-tables'] || $aCMDResult['all']) {\r
-    $bDidSomething = true;\r
-    $cSetup -> createPartitionTables();\r
-}\r
-\r
-if ($aCMDResult['create-partition-functions'] || $aCMDResult['all']) {\r
-    $bDidSomething = true;\r
-    $cSetup -> createPartitionFunctions();\r
-}\r
-/*\r
-if ($aCMDResult['import-wikipedia-articles'] || $aCMDResult['all']) {\r
-    $bDidSomething = true;\r
-    $cSetup -> importWikipediaArticles();\r
-}\r
-*/\r
-if ($aCMDResult['load-data'] || $aCMDResult['all']) {\r
-    $bDidSomething = true;\r
-    $cSetup -> loadData($aCMDResult['disable-token-precalc']);\r
-}\r
-    \r
-if ($aCMDResult['import-tiger-data']) {\r
-    $bDidSomething = true;\r
-    $cSetup -> importTigerData();\r
-}\r
-\r
-if ($aCMDResult['calculate-postcodes'] || $aCMDResult['all']) {\r
-    $bDidSomething = true;\r
-    $cSetup -> calculatePostcodes($aCMDResult['all']);\r
-}\r
-\r
-if ($aCMDResult['index'] || $aCMDResult['all']) {\r
-    $bDidSomething = true;\r
-    $cSetup -> index($aCMDResult['index-noanalyse']);\r
-}\r
-\r
-if ($aCMDResult['create-search-indices'] || $aCMDResult['all']) {\r
-    $bDidSomething = true;\r
-    $cSetup -> createSearchIndices();\r
-}\r
-\r
-if ($aCMDResult['create-country-names'] || $aCMDResult['all']) {\r
-    $bDidSomething = true;\r
-    $cSetup -> createCountryNames($aCMDResult);\r
-}\r
-\r
-if ($aCMDResult['drop']) {\r
-    $bDidSomething = true;\r
-    $cSetup -> drop($aCMDResult);\r
-}\r
-\r
-// ******************************************************\r
-// If we did something, repeat the warnings\r
-if (!$bDidSomething) {\r
-    showUsage($aCMDOptions, true);\r
-} else {\r
-    echo "Summary of warnings:\n\n";\r
-    repeatWarnings();\r
-    echo "\n";\r
-    info('Setup finished.');\r
-}\r
-\r
-\r
-\r
+<?php
+
+require_once(CONST_BasePath.'/lib/init-cmd.php');
+require_once(CONST_BasePath.'/lib/setup/SetupClass.php');
+require_once(CONST_BasePath.'/lib/setup_functions.php');
+ini_set('memory_limit', '800M');
+
+use Nominatim\Setup\SetupFunctions as SetupFunctions;
+
+// (long-opt, short-opt, min-occurs, max-occurs, num-arguments, num-arguments, type, help)
+$aCMDOptions
+= array(
+   'Create and setup nominatim search system',
+   array('help', 'h', 0, 1, 0, 0, false, 'Show Help'),
+   array('quiet', 'q', 0, 1, 0, 0, 'bool', 'Quiet output'),
+   array('verbose', 'v', 0, 1, 0, 0, 'bool', 'Verbose output'),
+
+   array('osm-file', '', 0, 1, 1, 1, 'realpath', 'File to import'),
+   array('threads', '', 0, 1, 1, 1, 'int', 'Number of threads (where possible)'),
+
+   array('all', '', 0, 1, 0, 0, 'bool', 'Do the complete process'),
+
+   array('create-db', '', 0, 1, 0, 0, 'bool', 'Create nominatim db'),
+   array('setup-db', '', 0, 1, 0, 0, 'bool', 'Build a blank nominatim db'),
+   array('import-data', '', 0, 1, 0, 0, 'bool', 'Import a osm file'),
+   array('osm2pgsql-cache', '', 0, 1, 1, 1, 'int', 'Cache size used by osm2pgsql'),
+   array('reverse-only', '', 0, 1, 0, 0, 'bool', 'Do not create search tables and indexes'),
+   array('create-functions', '', 0, 1, 0, 0, 'bool', 'Create functions'),
+   array('enable-diff-updates', '', 0, 1, 0, 0, 'bool', 'Turn on the code required to make diff updates work'),
+   array('enable-debug-statements', '', 0, 1, 0, 0, 'bool', 'Include debug warning statements in pgsql commands'),
+   array('ignore-errors', '', 0, 1, 0, 0, 'bool', 'Continue import even when errors in SQL are present (EXPERT)'),
+   array('create-tables', '', 0, 1, 0, 0, 'bool', 'Create main tables'),
+   array('create-partition-tables', '', 0, 1, 0, 0, 'bool', 'Create required partition tables'),
+   array('create-partition-functions', '', 0, 1, 0, 0, 'bool', 'Create required partition triggers'),
+   array('no-partitions', '', 0, 1, 0, 0, 'bool', 'Do not partition search indices (speeds up import of single country extracts)'),
+   array('import-wikipedia-articles', '', 0, 1, 0, 0, 'bool', 'Import wikipedia article dump'),
+   array('load-data', '', 0, 1, 0, 0, 'bool', 'Copy data to live tables from import table'),
+   array('disable-token-precalc', '', 0, 1, 0, 0, 'bool', 'Disable name precalculation (EXPERT)'),
+   array('import-tiger-data', '', 0, 1, 0, 0, 'bool', 'Import tiger data (not included in \'all\')'),
+   array('calculate-postcodes', '', 0, 1, 0, 0, 'bool', 'Calculate postcode centroids'),
+   array('osmosis-init', '', 0, 1, 0, 0, 'bool', 'Generate default osmosis configuration'),
+   array('index', '', 0, 1, 0, 0, 'bool', 'Index the data'),
+   array('index-noanalyse', '', 0, 1, 0, 0, 'bool', 'Do not perform analyse operations during index (EXPERT)'),
+   array('create-search-indices', '', 0, 1, 0, 0, 'bool', 'Create additional indices required for search and update'),
+   array('create-country-names', '', 0, 1, 0, 0, 'bool', 'Create default list of searchable country names'),
+   array('drop', '', 0, 1, 0, 0, 'bool', 'Drop tables needed for updates, making the database readonly (EXPERIMENTAL)'),
+  );
+
+// $aCMDOptions passed to getCmdOpt by reference
+getCmdOpt($_SERVER['argv'], $aCMDOptions, $aCMDResult, true, true);
+
+$bDidSomething = false;
+
+//*******************************************************
+// Making some sanity check:
+// Check if osm-file is set and points to a valid file
+if ($aCMDResult['import-data'] || $aCMDResult['all']) {
+    // to remain in /lib/setup_functions.php function
+    checkInFile($aCMDResult['osm-file']);
+}
+
+// osmosis init is no longer supported
+if ($aCMDResult['osmosis-init']) {
+    $bDidSomething = true;
+    echo "Command 'osmosis-init' no longer available, please use utils/update.php --init-updates.\n";
+}
+
+// ******************************************************
+// instantiate Setup class
+$oSetup = new SetupFunctions($aCMDResult);
+
+// *******************************************************
+// go through complete process if 'all' is selected or start selected functions
+if ($aCMDResult['create-db'] || $aCMDResult['all']) {
+    $bDidSomething = true;
+    $oSetup->createDB();
+}
+
+$oSetup->connect();
+
+if ($aCMDResult['setup-db'] || $aCMDResult['all']) {
+    $bDidSomething = true;
+    $oSetup->setupDB();
+}
+
+// Try accessing the C module, so we know early if something is wrong
+checkModulePresence(); // raises exception on failure
+
+if ($aCMDResult['import-data'] || $aCMDResult['all']) {
+    $bDidSomething = true;
+    $oSetup->importData($aCMDResult['osm-file']);
+}
+
+if ($aCMDResult['create-functions'] || $aCMDResult['all']) {
+    $bDidSomething = true;
+    $oSetup->createFunctions();
+}
+
+if ($aCMDResult['create-tables'] || $aCMDResult['all']) {
+    $bDidSomething = true;
+    $oSetup->createTables($aCMDResult['reverse-only']);
+    $oSetup->createFunctions();
+    $oSetup->createTableTriggers();
+}
+
+if ($aCMDResult['create-partition-tables'] || $aCMDResult['all']) {
+    $bDidSomething = true;
+    $oSetup->createPartitionTables();
+}
+
+if ($aCMDResult['create-partition-functions'] || $aCMDResult['all']) {
+    $bDidSomething = true;
+    $oSetup->createPartitionFunctions();
+}
+
+if ($aCMDResult['import-wikipedia-articles'] || $aCMDResult['all']) {
+    $bDidSomething = true;
+    $oSetup->importWikipediaArticles();
+}
+
+if ($aCMDResult['load-data'] || $aCMDResult['all']) {
+    $bDidSomething = true;
+    $oSetup->loadData($aCMDResult['disable-token-precalc']);
+}
+
+if ($aCMDResult['import-tiger-data']) {
+    $bDidSomething = true;
+    $oSetup->importTigerData();
+}
+
+if ($aCMDResult['calculate-postcodes'] || $aCMDResult['all']) {
+    $bDidSomething = true;
+    $oSetup->calculatePostcodes($aCMDResult['all']);
+}
+
+if ($aCMDResult['index'] || $aCMDResult['all']) {
+    $bDidSomething = true;
+    $oSetup->index($aCMDResult['index-noanalyse']);
+}
+
+if ($aCMDResult['drop']) {
+    $bDidSomething = true;
+    $oSetup->drop($aCMDResult);
+}
+
+if ($aCMDResult['create-search-indices'] || $aCMDResult['all']) {
+    $bDidSomething = true;
+    $oSetup->createSearchIndices();
+}
+
+if ($aCMDResult['create-country-names'] || $aCMDResult['all']) {
+    $bDidSomething = true;
+    $oSetup->createCountryNames($aCMDResult);
+}
+
+// ******************************************************
+// If we did something, repeat the warnings
+if (!$bDidSomething) {
+    showUsage($aCMDOptions, true);
+} else {
+    echo "Summary of warnings:\n\n";
+    repeatWarnings();
+    echo "\n";
+    info('Setup finished.');
+}