Skip to content

Commit bade19a

Browse files
committed
make clear that slim tables are an internal implementation detail, responding to #230
1 parent 7123da6 commit bade19a

File tree

1 file changed

+9
-0
lines changed

1 file changed

+9
-0
lines changed

docs/pgsql.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,15 @@ tables which are used by the pgsql middle layer, not the backend:
2727
With the ``--flat-nodes`` option, the ``planet_osm_nodes`` information is
2828
instead stored in a binary file.
2929

30+
**Note:** The names and structure of these additional tables, colloquially
31+
referred to as "slim tables", are an *internal implemention detail* of
32+
osm2pgsql. While they do not usually change between releases of osm2pgsql,
33+
be advised that if you rely on the content or layout of these tables in
34+
your application, it is your responsibility to check whether your assumptions
35+
are still true in a newer version of osm2pgsql before updating. See
36+
https://github.com/openstreetmap/osm2pgsql/issues/230 for a discussion of
37+
the topic.
38+
3039
## Importing ##
3140

3241
1. Runs a parser on the input file and processes the nodes, ways and relations.

0 commit comments

Comments
 (0)