osm2pgsql

https://osm2pgsql.org/doc/
Admin
osm2pgsql is a tool for importing OpenStreetMap (OSM) data into a PostgreSQL database, often used...
Tokens:77,428
Snippets:517
Trust Score:8.7
Update:1 week ago
Show doc for...
Tokens:
Raw
### osm2pgsql-replication --osm-file example

Source: https://osm2pgsql.org/doc/man/osm2pgsql-replication-2.3.1.html

Example command to initialize replication using an OSM file directly, ignoring other date information.

```bash
osm2pgsql-replication --osm-file <filename>
```

--------------------------------

### Install behave and psycopg via virtualenv

Source: https://osm2pgsql.org/doc/manual.html

Create a virtual environment and install behave and psycopg from PyPI on non-Debian systems.

```bash
virtualenv behave-env
./behave-env/bin/pip install behave psycopg

```

--------------------------------

### Install osm2pgsql on Ubuntu with apt

Source: https://osm2pgsql.org/doc/install/linux.html

Use the apt package manager to install osm2pgsql on Ubuntu.

```bash
apt install osm2pgsql
```

--------------------------------

### Install osm2pgsql on Fedora with dnf

Source: https://osm2pgsql.org/doc/install/linux.html

Use the dnf package manager to install osm2pgsql on Fedora.

```bash
dnf install osm2pgsql
```

--------------------------------

### Install behave and psycopg via apt

Source: https://osm2pgsql.org/doc/manual.html

Install the Python packages required by osm2pgsql-test-style on Debian/Ubuntu-like systems.

```bash
sudo apt-get install python3-behave python3-psycopg

```

--------------------------------

### Install osm2pgsql with Homebrew

Source: https://osm2pgsql.org/doc/install/macos.html

Installs osm2pgsql via Homebrew on macOS. Requires Homebrew to be installed beforehand.

```bash
brew install osm2pgsql

```

--------------------------------

### Install osm2pgsql with pkg on FreeBSD

Source: https://osm2pgsql.org/doc/install/freebsd.html

Use this command to install osm2pgsql from the FreeBSD Ports. Requires a FreeBSD system with the pkg package manager.

```shell
pkg install converters/osm2pgsql

```

--------------------------------

### Add Geo repository and install osm2pgsql on openSUSE

Source: https://osm2pgsql.org/doc/install/linux.html

First add the Geo package repository (adapt URL to your openSUSE version), then install osm2pgsql using zypper.

```bash
zypper ar https://download.opensuse.org/repositories/Application:/Geo/openSUSE_Leap_15.6/ "Geo"
zypper refresh
```

```bash
zypper install osm2pgsql
```

--------------------------------

### Enable and start osm2pgsql-update timer

Source: https://osm2pgsql.org/doc/manual.html

Reloads systemd to scan the new service and timer files, then enables and starts the timer. This activates the automatic update process.

```bash
sudo systemctl daemon-reload
sudo systemctl enable osm2pgsql-update.timer
sudo systemctl start osm2pgsql-update.timer

```

--------------------------------

### Initialize osm2pgsql-replication with -d

Source: https://osm2pgsql.org/doc/manual.html

Initializes the replication process by determining the starting point for updates. The -d parameter specifies the database to connect to, and the script supports other database connection parameters except -W for interactive password prompts; use a pgpass file instead. It stores replication information in the osm2pgsql_properties table and can be repeated safely to change the replication service.

```bash
osm2pgsql-replication init -d <dbname>

```

--------------------------------

### osm2pgsql-replication init

Source: https://osm2pgsql.org/doc/man/osm2pgsql-replication-2.3.1.html

Initializes the replication process for osm2pgsql, setting the replication service and start date. It can be called multiple times to change the server or rollback updates.

```APIDOC
## osm2pgsql-replication init

### Description
Initializes the replication process. Sets the replication service and determines from which date to apply updates. Must be called at least once; can be called again to change replication servers or to roll back and reapply updates.

### Method
Command

### Endpoint
Command: `osm2pgsql-replication init`

### Parameters
#### Path Parameters
None.

#### Query Parameters
None.

#### Request Body
None.

#### Command Options
- `-h` (flag) - Optional - Show help message and exit.
- `-q` (flag) - Optional - Quiet mode, suppresses output.
- `-v` (flag) - Optional - Verbose mode, increases output.
- `-d DB` (string) - Optional - Database name to use.
- `-U NAME` (string) - Optional - Database user name.
- `-H HOST` (string) - Optional - Database host.
- `-P PORT` (integer) - Optional - Database port.
- `-p PREFIX` (string) - Optional - Table prefix to use.
- `--middle-schema SCHEMA` (string) - Optional - Middle schema to use.
- `--schema SCHEMA` (string) - Optional - Schema to use.
- `--osm-file FILE` (string) - Optional - OSM file to use for replication information.
- `--server URL` (string) - Optional - Replication service URL.
- `--start-at TIME` (string) - Optional - Start date for updates, either absolute ISO timestamp (e.g., 2007-08-20T12:21:53Z) or a number of minutes to rollback.

### Usage Example

```
osm2pgsql-replication init [options]
```

### Response
#### Success Response
Exit code 0 on success.

#### Response Example

```
(no output)
```
```

--------------------------------

### Activate virtual environment

Source: https://osm2pgsql.org/doc/manual.html

Activate the virtual environment when behave is installed inside one.

```bash
. behave-env/bin/activate

```

--------------------------------

### osm2pgsql-replication init usage

Source: https://osm2pgsql.org/doc/man/osm2pgsql-replication-2.3.1.html

Shows the command-line usage for osm2pgsql-replication init, including all options. Use this to see the available parameters for initializing replication.

```bash
usage: osm2pgsql-replication init [-h] [-q] [-v] [-d DB] [-U NAME] [-H HOST]   
[-P PORT] [-p PREFIX]   
[--middle-schema SCHEMA] [--schema SCHEMA]   
[--osm-file FILE | --server URL]   
[--start-at TIME]
```

--------------------------------

### Create database user, database, and enable extensions

Source: https://osm2pgsql.org/doc/manual.html

Typical commands to create a database user and database for osm2pgsql, and enable the postgis and hstore extensions. Run as the postgres system user.

```bash
sudo -u postgres createuser osmuser
sudo -u postgres createdb --encoding=UTF8 --owner=osmuser osm
sudo -u postgres psql osm --command='CREATE EXTENSION postgis;'
sudo -u postgres psql osm --command='CREATE EXTENSION hstore;'
```

--------------------------------

### Import and Update: Initial import with -c -s/--create --slim

Source: https://osm2pgsql.org/doc/manual.html

Use these commands for the first import when you plan to update the database with change files. The -s/--slim option is required for updates. The -c/--create option is the default mode.

```bash
osm2pgsql -c -s OSMFILE
osm2pgsql --create --slim OSMFILE
osm2pgsql --slim OSMFILE
```

--------------------------------

### Set up fake replication service

Source: https://osm2pgsql.org/doc/manual.html

Sets up a mock replication service for the given URL. Optionally define sequences with timestamps; the mock returns a state file with the configured timestamp.

```gherkin
Given the replication service at <url>
    | sequence | timestamp            |
    | 9999999  | 2013-08-03T19:00:02Z |

```

--------------------------------

### Run osm2pgsql with output parameter

Source: https://osm2pgsql.org/doc/manual.html

Executes osm2pgsql with the previously configured data. The <output> placeholder is a shortcut for the '-O' parameter, which can be 'flex', 'pgsql', or 'null'. The step also automatically sets the style file, database name, and input data.

```gherkin
When running osm2pgsql <output>

```

--------------------------------

### Import Only: Equivalent osm2pgsql commands with -c/--create

Source: https://osm2pgsql.org/doc/manual.html

Use these commands for a one-time import of OSM data without updates. The -c/--create option is the default mode. Add -s/--slim and --drop to reduce main memory usage at the cost of slower imports and more database storage.

```bash
osm2pgsql -c OSMFILE
osm2pgsql --create OSMFILE
osm2pgsql OSMFILE
```

--------------------------------

### osm2pgsql.has_prefix

Source: https://osm2pgsql.org/doc/manual.html

Checks if a string starts with a given prefix. Returns nil if the string is nil.

```APIDOC
## osm2pgsql.has_prefix(STRING, PREFIX)

### Description
Returns `true` if the STRING starts with PREFIX. If STRING is `nil`, `nil` is returned.

### Parameters
- **STRING** (string) - Required - The string to check.
- **PREFIX** (string) - Required - The prefix to look for.

### Returns
- `true` if the string starts with the prefix, `false` otherwise, or `nil` if STRING is `nil`.

### Example
```lua
osm2pgsql.has_prefix('addr:city', 'addr:') -- returns true
```
```

--------------------------------

### osm2pgsql.define_table() with ids option

Source: https://osm2pgsql.org/doc/manual.html

Example of using the define_table function with an ids option to create a table with a node id column.

```APIDOC
## osm2pgsql.define_table()

### Description
Defines a database table with custom id column settings using the `ids` option.

### Method
Function call

### Endpoint
`osm2pgsql.define_table({ ... })`

### Parameters
#### ids option
- **type** (string) - Required - Allowed values: `node`, `way`, `relation`, `area`, `any`, `tile`.
- **id_column** (string) - Optional - Name of the id column. Default is `(node|way|relation|area)_id` for convenience functions.
- **type_column** (string) - Optional - For `type = 'any'`, stores object type as `N`, `W`, or `R` in a `char(1)` column.
- **create_index** (string) - Optional - Values: `'auto'` (default), `'always'`, `'unique'`, `'primary_key'`. Controls index creation.
- **cache** (boolean) - Optional - Version >= 2.3.0. Enables id caching.

### Request Example
```lua
local restaurants = osm2pgsql.define_table({
    name = 'restaurants',
    ids = { type = 'node', id_column = 'node_id' },
    columns = {
        { column = 'name', type = 'text' },
        { column = 'tags', type = 'jsonb' },
        { column = 'geom', type = 'point' }
}})
```

### Response
No direct response; function returns a table object.
```

--------------------------------

### Get first intersecting region with first_intersecting

Source: https://osm2pgsql.org/doc/manual.html

Returns the first intersecting region name, or nil if none. Faster than all_intersecting because it stops after the first match.

```lua
local cc = extract:first_intersecting(object:as_linestring())

```

--------------------------------

### Format value with Python formatter using : matcher

Source: https://osm2pgsql.org/doc/manual.html

Transforms the returned value using the Python formatter language. The example formats the value as uppercase hexadecimal.

```text
Then table foo contains
    | hexhex!:X |
    | 14EB34FF  |

```

--------------------------------

### Replace add_row with insert for multipolygon relations

Source: https://osm2pgsql.org/doc/tutorials/switching-from-add-row-to-insert

For relations creating (Multi)Polygons, replace `{ create = 'area' }` with a call to `as_multipolygon()`. The example shows both the old add_row and the new insert in the same process_relation function.

```lua
local forests = osm2pgsql.define_area_table('forests', {
    { column = 'geom', type = 'multipolygon' }
})

function osm2pgsql.process_relation(object)
    if object.tags.type == 'multipolygon' and object.tags.natural == 'wood' then
         forests:add_row({ geom = { create = 'area' } })
         forests:insert({ geom = object:as_multipolygon() })
    end
end

```

--------------------------------

### Fetch and apply updates with osm2pgsql-replication

Source: https://osm2pgsql.org/doc/manual.html

Fetches updates from the replication service and applies them by calling osm2pgsql with the given parameters. It limits the amount of data fetched at a time to avoid excessive RAM usage, repeating until the database is up to date. Use --once to stop after the first change file, --max-diff-size to adjust the download size (default 500MB), --post-processing to run a script after each update, and --diff-file to save changes before applying.

```bash
osm2pgsql-replication update -d <dbname> -- <parameters to osm2pgsql>

```

--------------------------------

### Replace add_row with insert for polygon ways

Source: https://osm2pgsql.org/doc/tutorials/switching-from-add-row-to-insert

For closed ways interpreted as polygons, replace `{ create = 'area' }` with a call to `as_polygon()`. The example shows both the old add_row and the new insert in the same process_way function.

```lua
local forests = osm2pgsql.define_way_table('forests', {
    { column = 'geom', type = 'polygon' }
})

function osm2pgsql.process_way(object)
    if object.is_closed and object.tags.natural == 'wood' then
        forests:add_row({ geom = { create = 'area' } })
        forests:insert({ geom = object:as_polygon() })
    end
end

```

--------------------------------

### Old magic area column type

Source: https://osm2pgsql.org/doc/tutorials/switching-from-add-row-to-insert

Shows the old way of using a special 'area' column type that osm2pgsql fills automatically. This example is incomplete and contains a syntax error (missing comma).

```lua
local forests = osm2pgsql.define_way_table('forests', {
    { column = 'geom', type = 'polygon' },
    { column = 'area', type = 'area' }
    { column = 'area', type = 'real' }
})

function osm2pgsql.process_way(object)
    if object.is_closed and  object.tags.natural == 'wood' then
        forests:add_row({ geom = { create = 'area' } })
        local poly = object:as_polygon():transform(3857)
        forests:insert({ geom = poly, area = poly:area() })
    end
end

```

--------------------------------

### osm2pgsql-replication status sample output

Source: https://osm2pgsql.org/doc/man/osm2pgsql-replication-2.3.1.html

Sample output from the status command without the '--json' option, showing log lines with replication service details and local database lag.

```text
2021-08-17 15:20:28 [INFO]: Using replication service ’https://planet.openstreetmap.org/replication/minute’, which is at sequence 4675115 ( 2021-08-17T13:19:43Z )   
2021-08-17 15:20:28 [INFO]: Replication server’s most recent data is <1 minute old   
2021-08-17 15:20:28 [INFO]: Local database is 8288 sequences behind the server, i.e. 5 day(s) 20 hour(s) 58 minute(s)   
2021-08-17 15:20:28 [INFO]: Local database’s most recent data is 5 day(s) 20 hour(s) 59 minute(s) old
```

--------------------------------

### Replace split_at='multi' with explicit iteration

Source: https://osm2pgsql.org/doc/tutorials/switching-from-add-row-to-insert

If you used `split_at = 'multi'`, do the split explicitly by iterating over the polygons in the multipolygon. The example shows the old add_row with split_at and the new insert inside a loop over `mgeom:geometries()`.

```lua
local forests = osm2pgsql.define_area_table('forests', {
    { column = 'geom', type = 'polygon' }
})

function osm2pgsql.process_relation(object)
    if object.tags.type == 'multipolygon' and object.tags.natural == 'wood' then
        forests:add_row({
            geom = { create = 'area', split_at = 'multi' }
        })
        local mgeom = object:as_multipolygon()
        for sgeom in mgeom:geometries() do
            forests:insert({ geom = sgeom })
        end
    end
end

```

--------------------------------

### Run osm2pgsql-test-style with pg_virtualenv

Source: https://osm2pgsql.org/doc/manual.html

Run the style tests inside a pg_virtualenv, which provides an isolated PostgreSQL environment.

```bash
pg_virtualenv osm2pgsql-test-style trees.feature

```

--------------------------------

### Match polygon geometry with geo matcher

Source: https://osm2pgsql.org/doc/manual.html

Matches a polygon with an outer ring and an inner ring. The first and last point of each ring must be identical. Polygons are matched with tolerance for winding order and starting point.

```text
Given the grid
    | 1 |    |    | 2 |
    |   | 10 | 11 |   |
    |   | 13 | 12 |   |
    | 4 |    |    | 3 |
Then table foo contains
    | poly!geo                     |
    | (1,2,3,4,1),(10,11,12,13,10) |

```
Tokens:
Raw