Skip to content

Commit b1bca6f

Browse files
committed
Minor update to docs
1 parent acb779a commit b1bca6f

File tree

2 files changed

+24
-29
lines changed

2 files changed

+24
-29
lines changed

README.md

Lines changed: 2 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -202,33 +202,9 @@ running without Docker.
202202

203203
## Layer Sets
204204

205-
Layer sets are defined under the directory [pgosm-flex/flex-config/](https://github.com/rustprooflabs/pgosm-flex/tree/main/flex-config), the current `run-*` options are:
206-
207-
* `run-all`
208-
* `run-no-tags`
209-
* `run-road-place`
210-
* `run-unitable`
211-
212-
Each of these layer sets includes the core layer defintions
213-
(see `style/*.lua`)
214-
and post-processing SQL (see `sql/*.sql`).
215-
The `.lua` scripts work with osm2pgsql's Flex output.
216-
PgOSM-Flex is using these styles with a mix-and-match approach.
217-
This is best illustrated by looking within the main `run-all.lua` script.
218-
As the following shows, it does not define any actual styles, only includes
219-
a single style, and runs another layer set (`run-no-tags`).
220-
221-
222-
```lua
223-
require "style.tags"
224-
require "run-no-tags"
225-
```
226-
227-
The `style.tags` script creates a table `osm.tags` that contains all OSM key/value
228-
pairs, but with no geometry. This is the largest table loaded by the `run-all`
229-
layer set and enables joining any OSM data in another layer (e.g. `osm.road_line`)
230-
to find any additional tags.
231205

206+
PgOSM Flex includes a few layersets and makes it easy to customize your own.
207+
See [docs/LAYERSETS.md](docs/LAYERSETS.md) for details.
232208

233209

234210

docs/LAYERSETS.md

Lines changed: 22 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,28 @@
1-
## PgOSM Flex layersets
1+
# PgOSM Flex layersets
22

33
A layerset defines one or more layers, where each layer includes
44
one or more tables and/or views.
5+
Layers are defined by a matched pair of Lua and SQL scripts. For example,
6+
the road layer is defined by `flex-config/style/road.lua` and
7+
`flex-config/sql/road.sql`.
8+
9+
10+
Layersets are defined in `.ini` files.
11+
12+
13+
## Included layersets
14+
15+
A few layersets are included with PgOSM Flex under `flex-config/layerset/`.
16+
If the `--layerset` is not defined, the `default` layerset is used.
17+
18+
* `minimal`
19+
* `basic`
20+
* `default`
21+
* `everything`
22+
23+
24+
## Custom layerset
525

6-
Layersets are defined in `.ini` files. A few layersets are included with PgOSM Flex under
7-
`flex-config/layerset/`.
826

927
A layerset including the `poi` and `road_major` layers would look
1028
like:
@@ -17,3 +35,4 @@ road_major=true
1735

1836
Layers not listed in the layerset `.ini` are not included.
1937

38+

0 commit comments

Comments
 (0)