Table of Contents
Instructions for downloading and installing binaries for different operating systems, additional notes and corrections not included in this documentation can be found in Installation wiki
To use pgRouting PostGIS needs to be installed, please read the information about installation in this Install Guide
Extracting the tar ball
tar xvfz pgrouting-3.4.0.tar.gz cd pgrouting-3.4.0
To compile assuming you have all the dependencies in your search path:
mkdir build cd build cmake .. make sudo make install
Once pgRouting is installed, it needs to be enabled in each individual database you want to use it in.
createdb routing psql routing -c 'CREATE EXTENSION PostGIS' psql routing -c 'CREATE EXTENSION pgRouting'
Get the sources¶
The pgRouting latest release can be found in https://github.com/pgRouting/pgrouting/releases/latest
To download this release:
wget -O pgrouting-3.4.0.tar.gz https://github.com/pgRouting/pgrouting/archive/v3.4.0.tar.gz
Go to Short Version for more instructions on extracting tar ball and compiling pgRouting.
To download the repository
git clone git://github.com/pgRouting/pgrouting.git cd pgrouting git checkout v3.4.0
Go to Short Version for more instructions on compiling pgRouting (there is no tar ball involved while downloading pgRouting repository from GitHub).
Enabling and upgrading in the database¶
Enabling the database
pgRouting is a PostgreSQL extension and depends on PostGIS to provide functionalities to end user. Below given code demonstrates enabling PostGIS and pgRouting in the database.
CREATE EXTENSION postgis; CREATE EXTENSION pgrouting;
Checking PostGIS and pgRouting version after enabling them in the database.
SELECT PostGIS_full_version(); SELECT * FROM pgr_version();
Upgrading the database
To upgrade pgRouting in the database to version 3.4.0 use the following command:
ALTER EXTENSION pgrouting UPDATE TO "3.4.0";
More information can be found in https://www.postgresql.org/docs/current/sql-createextension.html
To be able to compile pgRouting, make sure that the following dependencies are met:
C and C++0x compilers
Compiling with Boost 1.56 up to Boost 1.74 requires C++ Compiler with C++03 or C++11 standard support
Compiling with Boost 1.75 requires C++ Compiler with C++14 standard support
Postgresql version = Supported versions by PostgreSQL
The Boost Graph Library (BGL). Version >= 1.56
CMake >= 3.2
For user’s documentation
Sphinx >= 1.1
For developer’s documentation
Doxygen >= 1.7
PostGIS version >= 2.2
Example: Installing dependencies on linux
Installing the compilation dependencies
sudo apt install postgresql-14 sudo apt install postgresql-server-dev-14 sudo apt install postgresql-14-postgis
Entering psql console
sudo systemctl start postgresql.service sudo -i -u postgres psql
To exit psql console
Entering psql console directly without switching roles can be done by the following commands
sudo -u postgres psql
Then use the above given method to exit out of the psql console
Checking PostgreSQL version
Enter the psql console using above given method and then enter
Creating PostgreSQL role
sudo -i -u postgres createuser --interactive
sudo -u postgres createuser --interactive
Default role provided by PostgreSQL is postgres. To create new roles you can use the above provided commands. The prompt will ask the user to type name of the role and then provide affirmation. Proceed with the steps and you will succeed in creating PostgreSQL role successfully.
To add password to the role or change previously created password of the role use the following commands
ALTER USER <role name> PASSWORD <password>
To get additional details on the flags associated with
given command can be used
Creating Database in PostgreSQL
sudo -i -u postgres createdb <database name>
sudo -u postgres createdb <database name>
Connecting to a PostgreSQL Database
Enter the psql console and type the following commands
connect <database name>
sudo apt install cmake sudo apt install g++ sudo apt install libboost-graph-dev
For documentation and testing
pip install sphinx pip install sphinx-bootstrap-theme sudo apt install texlive sudo apt install doxygen sudo apt install libtap-parser-sourcehandler-pgtap-perl sudo apt install postgresql-14-pgtap
pgRouting uses the cmake system to do the configuration.
The build directory is different from the source directory
Create the build directory
$ mkdir build
To see the variables that can be configured
$ cd build $ cmake -L ..
Configuring The Documentation
Most of the effort of the documentation has been on the HTML files. Some variables for building documentation:
Turn on/off building the documentation
If ON, turn on/off building HTML for user’s documentation
If ON, turn on/off building HTML for developer’s documentation
If ON, turn on/off building PDF
If ON, turn on/off building MAN pages
If ON, use sphinx-bootstrap for HTML pages of the users documentation
Configuring cmake to create documentation before building pgRouting
$ cmake -DWITH_DOC=ON -DDOC_USE_BOOTSTRAP=ON ..
Most of the effort of the documentation has been on the html files.
make to build the code and the documentation
The following instructions start from path/to/pgrouting/build
$ make # build the code but not the documentation $ make doc # build only the user's documentation $ make all doc # build both the code and the user's documentation $ make doxy # build only the developer's documentation
We have tested on several platforms, For installing or reinstalling all the steps are needed.
The sql signatures are configured and build in the
MinGW on Windows
$ mkdir build $ cd build $ cmake -G"MSYS Makefiles" .. $ make $ make install
The following instructions start from path/to/pgrouting
mkdir build cd build cmake .. make sudo make install
To remove the build when the configuration changes, use the following code:
rm -rf build
and start the build process as mentioned previously.
Currently there is no
make test and testing is done as follows
The following instructions start from path/to/pgrouting/
tools/testers/doc_queries_generator.pl createdb -U <user> ___pgr___test___ sh ./tools/testers/pg_prove_tests.sh <user> dropdb -U <user> ___pgr___test___
Indices and tables