Skip to content

Commit a5fab42

Browse files
authored
Merge pull request #2001 from joto/middle-dbformat-docs
Add docs for recently added new middle database format options
2 parents 37aae6c + 0805212 commit a5fab42

File tree

3 files changed

+34
-2
lines changed

3 files changed

+34
-2
lines changed

docs/osm2pgsql.1

Lines changed: 19 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
.TH "OSM2PGSQL" "1" "1.8.1" "" ""
22
.SH NAME
33
.PP
4-
osm2pgsql - Openstreetmap data to PostgreSQL converter
4+
osm2pgsql - OpenStreetMap data to PostgreSQL converter
55
.SH SYNOPSIS
66
.PP
77
\f[B]osm2pgsql\f[R] [\f[I]OPTIONS\f[R]] OSM-FILE\&...
@@ -19,7 +19,7 @@ In \[lq]create\[rq] mode osm2pgsql will create the database tables
1919
required by the configuration and import the OSM file(s) specified on
2020
the command line into those tables.
2121
Note that you also have to use the \f[B]-s, --slim\f[R] option if you
22-
want your database to be updateable.
22+
want your database to be updatable.
2323
.PP
2424
In \[lq]append\[rq] mode osm2pgsql will update the database tables with
2525
the data from OSM change files specified on the command line.
@@ -193,6 +193,23 @@ used).
193193
Set ID shift for way node bucket index in middle.
194194
Experts only.
195195
See documentation for details.
196+
.TP
197+
--middle-database-format=FORMAT
198+
Set the database format for the middle tables to FORMAT.
199+
Allowed formats are \f[B]legacy\f[R] and \f[B]new\f[R].
200+
The \f[B]legacy\f[R] format is the old format that will eventually be
201+
deprecated and removed but is currently still the default.
202+
The \f[B]new\f[R] format was introduced in version 1.9.0 and is still
203+
experimental.
204+
See the manual for details on these formats.
205+
(Only works with \f[B]--slim\f[R].
206+
In append mode osm2pgsql will automatically detect the database format,
207+
so don\[cq]t use this with \f[B]-a, --append\f[R].)
208+
.TP
209+
--middle-with-nodes
210+
Used together with the \f[B]new\f[R] middle database format when a flat
211+
nodes file is used to force storing nodes with tags in the database,
212+
too.
196213
.SH OUTPUT OPTIONS
197214
.TP
198215
-O, --output=OUTPUT

docs/osm2pgsql.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -171,6 +171,19 @@ mandatory for short options too.
171171
: Set ID shift for way node bucket index in middle. Experts only. See
172172
documentation for details.
173173

174+
\--middle-database-format=FORMAT
175+
: Set the database format for the middle tables to FORMAT. Allowed formats
176+
are **legacy** and **new**. The **legacy** format is the old format that
177+
will eventually be deprecated and removed but is currently still the
178+
default. The **new** format was introduced in version 1.9.0 and is still
179+
experimental. See the manual for details on these formats. (Only works
180+
with **\--slim**. In append mode osm2pgsql will automatically detect the
181+
database format, so don't use this with **-a, \--append**.)
182+
183+
\--middle-with-nodes
184+
: Used together with the **new** middle database format when a flat nodes
185+
file is used to force storing nodes with tags in the database, too.
186+
174187
# OUTPUT OPTIONS
175188

176189
-O, \--output=OUTPUT

src/command-line-parser.cpp

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -183,6 +183,8 @@ Middle options:\n\
183183
id, timestamp and version) for each object in the database.\n\
184184
--middle-schema=SCHEMA Schema to use for middle tables (default: none).\n\
185185
--middle-way-node-index-id-shift=SHIFT Set ID shift for bucket index.\n\
186+
--middle-database-format=FORMAT Set middle db format (default: legacy).\n\
187+
--middle-with-nodes Store tagged nodes in db (new middle db format only).\n\
186188
\n\
187189
Pgsql output options:\n\
188190
-i|--tablespace-index=TBLSPC The name of the PostgreSQL tablespace where\n\

0 commit comments

Comments
 (0)