The quick start section showed how to get up and running using the Postgres instance within the PgOSM Flex docker image. Many production usage cases of PgOSM Flex prefer to connect the PgOSM Flex processing within Docker directly to an already running Postgres instances.
The first step to using PgOSM Flex with your own Postgres instance is to have a database already created, and a login role with proper permissions. The steps in this page prepare for the steps outlined in the Using External Postgres Connection section.
These first steps require elevated permissions within Postgres.
CREATE DATABASE requires the
Creating the PostGIS extension requires
Postgres superuser permissions.
In the target Postgres instance, create your database.
CREATE DATABASE your_db_name;
your_db_name and create the PostGIS extension.
This is done along with the
CREATE DATABASE since both steps
require the superuser role.
CREATE EXTENSION postgis;
Your target database needs to have an
osm schema and the database user
requires the ability to create and populate tables in
The following commands show one approach to granting permissions required for PgOSM Flex to run on an external database. Do not simply run this assuming this is the proper approach for your database security!
CREATE ROLE pgosm_flex WITH LOGIN PASSWORD 'mysecretpassword'; CREATE SCHEMA osm AUTHORIZATION pgosm_flex; GRANT CREATE ON DATABASE your_db_name TO pgosm_flex; GRANT CREATE ON SCHEMA public TO pgosm_flex;
These permissions should allow the full PgOSM Flex process to run.
GRANT CREATE ON DATABASE is required to allow the sqitch process to run and create the
GRANT CREATE ON SCHEMA public is required for Postgres 15 and newer.
GRANT CREATE gives the
pgosm_flex role far more permissions than
it really needs in many cases.
docker exec with
--data-only skips these steps and would make the
GRANT CREATE permission unnecessary for the
It also is often desired to not make a login role the owner of database objects. This example reduces the scope of permissions.
CREATE ROLE pgosm_flex; CREATE SCHEMA osm AUTHORIZATION pgosm_flex; GRANT pgosm_flex TO your_login_role;