OpenStreetMap PBF Sources
Note
Only the bulk mode of martin cp and martin test can process these sources.
The tile serving mode can only serve them after they are brought into a more suitable format.
Martin reads one .osm.pbf file per source, using layers.
osm:
sources:
berlin:
path: berlin-latest.osm.pbf
tags: [highway, name, building]
layers:
roads:
geometry: line
where: "highway in ['motorway', 'trunk', 'primary']"
attributes: [highway, name]
buildings:
geometry: polygon
minzoom: 14
where: "building != null"
attributes: []
A run renders either osm sources or database sources, not both.
Building a basemap from OpenStreetMap has one possible basemap schema.
Settings
| Key | Meaning |
|---|---|
path |
The .osm.pbf file |
tags |
The tag keys the layers read, each a string property |
layers |
Output layers, as for table sources |
minzoom, maxzoom |
Narrow the zooms of --min-zoom and --max-zoom |
extent, buffer, clip_geom |
Defaults for the contained layers |
Supported Features and handling
| OSM object | Feature | osm_type |
Feature id |
|---|---|---|---|
| Node with tags | point | node |
id * 10 + 1 |
| Way with tags | line, or polygon if closed and its tags make it an area | way |
id * 10 + 2 |
Relation with type=multipolygon or type=boundary |
polygon or multipolygon | relation |
id * 10 + 3 |
Martin leaves out objects without tags, and other relations.
Whether a closed way is an area follows osmflow's AreaRules (building, landuse, natural other than coastline, area=yes and so on).
A relation's member ways are joined into rings.
A ring inside an odd number of others is a hole, whatever its role.
A way or relation whose nodes are not in the file is left out, as is a relation with a member way that is not.
Each key in tags is a string property, null where the object does not have the tag or its value is empty.
osm_type is always one.
An expression reading a key not in tags fails the run. A tag such as name:en is read with
feature['name:en'].
Reading only what the layers take
The where and geometry of every layer are checked while the file is read, as PostgreSQL checks them for table
sources:
- An object type no layer can take is not decoded. Without layers that take lines or polygons, the node locations are not even loaded.
- A block of the file whose strings cannot hold a match, such as one without the string
highwayforhighway == 'primary', is skipped before it is decompressed in full. - Each object's tags are checked before the locations of a way's nodes are looked up.
This needs the same equivalent of where as table sources do. Without one, Martin
reads every tagged object and checks where itself, with the same result.
Node locations
Martin builds ways and relations from node locations, which it loads before it reads the file. For a PBF of up to
512 MiB, it keeps them in memory, about 30 bytes per node. For a larger file, it keeps them in a file of about
5 bytes per node in the first --temp-dir, and deletes that file when the run ends.
Draw order
Without sort_by, features keep the order of the file, nodes before ways, then relations by id.
The output does not depend on --threads.