osmium-renumber man page

osmium-renumber — renumber object IDs

Synopsis

osmium renumber [Options] OSM-DATA-FILE

Description

The objects (nodes, ways, and relations) in an OSM file often have very large IDs. This can make some kinds of postprocessing difficult. This command will renumber all objects using IDs starting at 1. Referential integrity will be kept. All objects which appear in the source file will be in the same order in the output file. IDs of objects which are not in the file but referenced from ways or relations are not guaranteed to be in the correct order.

This command expects the input file to be ordered in the usual way: First nodes in order of ID, then ways in order of ID, then relations in order of ID. The input file will be read twice, so it will not work with STDIN.

Currently this command can not renumber negative IDs.

You must never upload the data generated by this command to OSM! This would really confuse the OSM database because it knows the objects under different IDs.

Options

-i, --index-directory=DIR
Directory where the index files for mapping between old and news IDs are read from and written to, respectively. Use this if you want to map IDs in several OSM files. Without this option, the indexes are not read from or written to disk. The directory must exist. Use '.' for the current directory. The files written will be named nodes.idx, ways.idx, and relations.idx. See also the section Index Files below.
-t, --object-type=TYPE
Renumber only objects of given type (node, way, or relation). By default all objects of all types are renumbered. This option can be given multiple times.

Common Options

-h, --help
Show usage help.
-v, --verbose
Set verbose mode. The program will output information about what it is doing to stderr.
--progress
Show progress bar. Usually a progress bar is only displayed if STDERR is detected to be a TTY. With this option a progress bar is always shown. Note that a progress bar will never be shown when reading from STDIN or a pipe.
--no-progress
Do not show progress bar. Usually a progress bar is displayed if STDERR is detected to be a TTY. With this option the progress bar is suppressed. Note that a progress bar will never be shown when reading from STDIN or a pipe.

Input Options

-F, --input-format=FORMAT
The format of the input file(s). Can be used to set the input format if it can't be autodetected from the file name(s). This will set the format for all input files, there is no way to set the format for some input files only. See osmium-file-formats(5) or the libosmium manual for details.

Output Options

-f, --output-format=FORMAT
The format of the output file. Can be used to set the output file format if it can't be autodetected from the output file name. See osmium-file-formats(5) or the libosmium manual for details.
--fsync
Call fsync after writing the output file to force flushing buffers to disk.
--generator=NAME
The name and version of the program generating the output file. It will be added to the header of the output file. Default is "osmium/" and the version of osmium.
-o, --output=FILE
Name of the output file. Default is '-' (stdout).
-O, --overwrite
Allow an existing output file to be overwritten. Normally osmium will refuse to write over an existing file.
--output-header=OPTION
Add output header option. This option can be given several times. See the libosmium manual for a list of allowed header options.

Index Files

When the -i or --index-directory option is used, index files named nodes.idx, ways.idx, and relations.idx are read from and written to the given directory. This can be used to force consistent mapping over several invocations of osmium renumber, for instance when you want to remap an OSM data file and a corresponding OSM change file.

The index files are in binary format, but you can use the following command line to convert them into something readable:

od -An -td8 -w8 TYPE.idx | cat -n

Diagnostics

osmium renumber exits with exit code

0
if everything went alright,
1
if there was an error processing the data, or
2
if there was a problem with the command line arguments.

Memory Usage

osmium renumber needs quite a bit of main memory to keep the mapping between old and new IDs. It is intended for small to medium sized extracts. You will need more than 32 GB RAM to run this on a full planet.

Memory use is at least 8 bytes per node, way, and relation ID in the input file.

Examples

Renumber a PBF file and output to a compressed XML file:

osmium renumber -o ch.osm.bz2 germany.osm.pbf

Renumbering Germany currently (spring 2016) takes less than three minutes and needs about 3 GB RAM.

Renumber an OSM file storing the indexes on disk:

osmium renumber -i. -o renumbered.osm data.osm

then rewrite a change file, too:

osmium renumber -i. -o renumbered.osc changes.osc

See Also

·
osmium(1), osmium-file-formats(5)
·
Osmium website (http://osmcode.org/osmium)

Contact

If you have any questions or want to report a bug, please go to http://osmcode.org/contact.html

Authors

Jochen Topf <jochen@topf.org>.

Referenced By

osmium(1).

1.4.1