From bade19a0dca9981fb8dcd913854cc562d046654b Mon Sep 17 00:00:00 2001 From: Frederik Ramm Date: Thu, 4 Oct 2018 11:39:28 +0200 Subject: [PATCH] make clear that slim tables are an internal implementation detail, responding to #230 --- docs/pgsql.md | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/docs/pgsql.md b/docs/pgsql.md index 620fa1da4..7d4c3a7f3 100644 --- a/docs/pgsql.md +++ b/docs/pgsql.md @@ -27,6 +27,15 @@ tables which are used by the pgsql middle layer, not the backend: With the ``--flat-nodes`` option, the ``planet_osm_nodes`` information is instead stored in a binary file. +**Note:** The names and structure of these additional tables, colloquially +referred to as "slim tables", are an *internal implemention detail* of +osm2pgsql. While they do not usually change between releases of osm2pgsql, +be advised that if you rely on the content or layout of these tables in +your application, it is your responsibility to check whether your assumptions +are still true in a newer version of osm2pgsql before updating. See +https://github.com/openstreetmap/osm2pgsql/issues/230 for a discussion of +the topic. + ## Importing ## 1. Runs a parser on the input file and processes the nodes, ways and relations.