osm2pgsql is a tool for loading OpenStreetMap data into a PostgreSQL / PostGIS database suitable for applications like rendering into a map, geocoding with Nominatim, or general analysis.
See the documentation for instructions on how to install and run osm2pgsql.
- Converts OSM files to a PostgreSQL DB
- Conversion of tags to columns is configurable in the style file
- Able to read .gz, .bz2, .pbf and .o5m files directly
- Can apply diffs to keep the database up to date
- Support the choice of output projection
- Configurable table names
- Support for hstore field type to store the complete set of tags in one database field if desired
Most Linux distributions include osm2pgsql. It is available on macOS with Homebrew and Windows builds are also available. See https://osm2pgsql.org/doc/install.html for details.
The latest source code is available in the osm2pgsql git repository on GitHub and can be downloaded as follows:
git clone https://github.com/openstreetmap/osm2pgsql.gitOsm2pgsql uses the cross-platform CMake build system to configure and build itself.
Required libraries are
- expat
- proj
- bzip2
- zlib
- Boost libraries, including geometry, system and filesystem
- CImg (Optional, for generalization only)
- potrace (Optional, for generalization only)
- PostgreSQL client libraries
- Lua (Optional, used for Lua tag transforms and the flex output)
- Python (only for running tests)
- Psycopg (only for running tests)
The following libraries are included in the contrib directory. You can build
with other versions of those libraries (set the EXTERNAL_*libname* option to
ON) but make sure you are using a compatible version:
It also requires access to a database server running PostgreSQL 9.6+ and PostGIS 2.2+.
Make sure you have installed the development packages for the libraries mentioned in the requirements section and a C++ compiler which supports C++17. We officially support gcc >= 7.0 and clang >= 8.
To rebuild the included man page you'll need the pandoc tool.
First install the dependencies.
On a Debian or Ubuntu system, this can be done with:
sudo apt-get install make cmake g++ libboost-dev libboost-system-dev \
libboost-filesystem-dev libexpat1-dev zlib1g-dev libpotrace-dev cimg-dev \
libbz2-dev libpq-dev libproj-dev lua5.3 liblua5.3-dev pandocOn a Fedora system, use
sudo dnf install cmake make gcc-c++ boost-devel expat-devel zlib-devel \
potrace-devel cimg-devel \
bzip2-devel postgresql-devel proj-devel proj-epsg lua-devel pandocOn RedHat / CentOS first run sudo yum install epel-release then install
dependencies with:
sudo yum install cmake make gcc-c++ boost-devel expat-devel zlib-devel \
bzip2-devel postgresql-devel proj-devel proj-epsg lua-devel pandocOn a FreeBSD system, use
pkg install devel/cmake devel/boost-libs textproc/expat2 \
databases/postgresql94-client graphics/proj lang/lua52On Alpine, use
apk --update-cache add cmake make g++ boost-dev expat-dev \
bzip2-dev zlib-dev libpq proj-dev lua5.3-dev postgresql-devOnce dependencies are installed, use CMake to build the Makefiles in a separate folder:
mkdir build && cd build
cmake ..If some installed dependencies are not found by CMake, more options may need
to be set. Typically, setting CMAKE_PREFIX_PATH to a list of appropriate
paths is sufficient.
When the Makefiles have been successfully built, compile with
makeThe man page can be rebuilt with:
make manThe compiled files can be installed with
sudo make installBy default, the Release build with debug info is created and no tests are compiled. You can change that behavior by using additional options like following:
cmake .. -G "Unix Makefiles" -DCMAKE_BUILD_TYPE=Debug -DBUILD_TESTS=ONNote that Debug builds will be much slower than release build. For production
Release or RelWithDebInfo builds are recommended.
Osm2pgsql has builtin support for the Latlong (WGS84, EPSG:4326) and the WebMercator (EPSG:3857) projection. If you need other projections you have to compile with the PROJ library.
Both the older API (PROJ version 4) and the newer API (PROJ version 6.1 and
above) are supported. Usually the CMake configuration will find a suitable
version and use it automatically, but you can set the USE_PROJ_LIB CMake
cache variable to choose between the following behaviours:
4: Look for PROJ library with API version 4. If it is not found, stop with error.6: Look for PROJ library with API version 6. If it is not found, stop with error.off: Build without PROJ library.auto: Choose API 4 if available, otherwise API 6. If both are not available build without PROJ library. (This is the default.)
To speed up Lua tag transformations, LuaJIT can be optionally enabled on supported platforms. This can speed up processing considerably.
On a Debian or Ubuntu system install the LuaJIT library:
sudo apt-get install libluajit-5.1-devConfiguration parameter WITH_LUAJIT=ON needs to be added to enable LuaJIT.
Otherwise make and installation steps are identical to the description above.
cmake -D WITH_LUAJIT=ON ..Use osm2pgsql --version to verify that the build includes LuaJIT support.
The output should show something like
Lua 5.1.4 (LuaJIT 2.1.0-beta3)
There is some experimental support for data generalization. See https://osm2pgsql.org/generalization/ for details.
If you have problems with osm2pgsql or want to report a bug, go to https://osm2pgsql.org/support/ .
This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.
This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.
We welcome contributions to osm2pgsql. See CONTRIBUTING.md and https://osm2pgsql.org/contribute/ for information on how to contribute.