Ubuntu Manpage: osm2pgsql - OpenStreetMap data to PostgreSQL converter

NAME

       osm2pgsql - OpenStreetMap data to PostgreSQL converter

SYNOPSIS

       osm2pgsql [OPTIONS] OSM-FILE...

DESCRIPTION

       osm2pgsql  imports  OpenStreetMap  data  into  a  PostgreSQL/PostGIS  database.   It is an
       essential part of many rendering toolchains, the Nominatim geocoder and other applications
       processing OSM data.

       osm2pgsql  can  run  in either “create” mode (the default) or in “append” mode (option -a,
       --append).

       In “create” mode osm2pgsql will create the database tables required by  the  configuration
       and import the OSM file(s) specified on the command line into those tables.  Note that you
       also have to use the -s, --slim option if you want your database to be updatable.

       In “append” mode osm2pgsql will update the database tables with the data from  OSM  change
       files specified on the command line.

       This  man  page  can  only cover some of the basics and describe the command line options.
       See the Osm2pgsql Manual (https://osm2pgsql.org/doc/manual.html) for more information.

OPTIONS

       This program follows the usual GNU command line syntax, with long  options  starting  with
       two dashes (--).  Mandatory arguments to long options are mandatory for short options too.

MAIN OPTIONS

       -a, --append
              Run  in  append  mode.  Adds the OSM change file into the database without removing
              existing data.

       -c, --create
              Run in create mode.  This is the default if -a, --append is not specified.  Removes
              existing data from the database tables!

HELP/VERSION OPTIONS

       -h, --help
              Print help.  Add -v, --verbose to display more verbose help.

       -V, --version
              Print osm2pgsql version.

LOGGING OPTIONS

       --log-level=LEVEL
              Set log level (`debug', `info' (default), `warn', or `error').

       --log-progress=VALUE
              Enable  (true)  or  disable  (false)  progress  logging.  Setting this to auto will
              enable progress logging on the console and disable it if the output  is  redirected
              to a file.  Default: true.

       --log-sql
              Enable logging of SQL commands for debugging.

       --log-sql-data
              Enable  logging  of  all  data  added  to the database.  This will write out a huge
              amount of data!  For debugging.

       -v, --verbose
              Same as --log-level=debug.

DATABASE OPTIONS

       -d, --database=NAME
              The name of the PostgreSQL database to connect to.  If this parameter contains an =
              sign  or  starts  with  a  valid  URI  prefix (postgresql:// or postgres://), it is
              treated as a conninfo string.  See the PostgreSQL manual for details.

       -U, --username=NAME
              Postgresql user name.

       -W, --password
              Force password prompt.

       -H, --host=HOSTNAME
              Database server hostname or unix domain socket location.

       -P, --port=PORT
              Database server port.

       --schema=SCHEMA
              Default for various schema settings throughout osm2pgsql  (default:  public).   The
              schema must exist in the database and be writable by the database user.

INPUT OPTIONS

       -r, --input-reader=FORMAT
              Select  format  of  the  input  file.   Available  choices  are  auto (default) for
              autodetecting the format, xml for OSM XML format files, o5m for o5m formatted files
              and pbf for OSM PBF binary format.

       -b, --bbox=MINLON,MINLAT,MAXLON,MAXLAT
              Apply   a   bounding   box   filter   on   the   imported  data.   Example:  --bbox
              -0.5,51.25,0.5,51.75

MIDDLE OPTIONS

       -i, --tablespace-index=TABLESPC
              Store all indexes in the PostgreSQL tablespace TABLESPC.  This option also  affects
              the  tables  created  by  the  pgsql  output.   This option is deprecated.  Use the
              --tablespace-slim-index and/or --tablespace-main-index options instead.

       --tablespace-slim-data=TABLESPC
              Store the slim mode tables in the given tablespace.

       --tablespace-slim-index=TABLESPC
              Store the indexes of the slim mode tables in the given tablespace.

       -p, --prefix=PREFIX
              Prefix for table names (default: planet_osm).

       -s, --slim
              Store temporary data in the database.  Without this mode,  all  temporary  data  is
              stored  in RAM and if you do not have enough the import will not work successfully.
              With slim mode, you should be able to import the data even on a system with limited
              RAM, although if you do not have enough RAM to cache at least all of the nodes, the
              time to import the data will likely be greatly increased.

       --drop Drop the slim mode tables from the database and the flat node file once the  import
              is  complete.   This  can greatly reduce the size of the database, as the slim mode
              tables typically are the same size, if not slightly bigger than  the  main  tables.
              It does not, however, reduce the maximum spike of disk usage during import.  It can
              furthermore increase the import speed, as no indexes need to  be  created  for  the
              slim mode tables, which (depending on hardware) can nearly halve import time.  Slim
              mode tables however have to be persistent if you want to be  able  to  update  your
              database, as these tables are needed for diff processing.

       -C, --cache=NUM
              Only  for  slim  mode: Use up to NUM MB of RAM for caching nodes.  Giving osm2pgsql
              sufficient cache to store all imported nodes typically greatly increases the  speed
              of  the  import.   Each cached node requires 8 bytes of cache, plus about 10% - 30%
              overhead.  As a rule of thumb, give a bit more than the size of the import file  in
              PBF  format.   If the RAM is not big enough, use about 75% of memory.  Make sure to
              leave enough RAM for PostgreSQL.  It needs at least the  amount  of  shared_buffers
              given in its configuration.  Defaults to 800.

       -x, --extra-attributes
              Include  attributes  of each object in the middle tables and make them available to
              the outputs.  Attributes are: user name,  user  id,  changeset  id,  timestamp  and
              version.

       -F, --flat-nodes=FILENAME
              Use  a  file  on disk to store node locations instead of storing them in memory (in
              non-slim mode) or in the database (in slim mode).  This is much more efficient than
              storing the data in the database.  Storing the node information for the full planet
              requires more than 500GB in PostgreSQL, the same data  is  stored  in  “only”  90GB
              using  the  flat-nodes  mode.   This  can  also increase the speed of applying diff
              files.  This option activates the flat-nodes mode and specifies the location of the
              database  file.  It is a single large file.  This mode is only recommended for full
              planet imports as it  doesn’t  work  well  with  small  imports.   The  default  is
              disabled.   The  file  will stay on disk after import, use --drop to remove it (but
              you can’t do updates then).

       --middle-schema=SCHEMA
              Use PostgreSQL schema SCHEMA for all tables, indexes, and functions in the  middle.
              The  schema  must  exist  in the database and be writable by the database user.  By
              default the schema set with --schema is used, or public if that is not set.

       --middle-with-nodes
              When a flat nodes file is used, nodes are not stored in  the  database.   Use  this
              option to force storing nodes with tags in the database, too.

OUTPUT OPTIONS

       -O, --output=OUTPUT
              Specifies  the  output to use.  Currently osm2pgsql supports pgsql, flex, and null.
              pgsql is the default output  still  available  for  backwards  compatibility.   New
              setups  should  use  the  flex  output  which  allows  for  a  much  more  flexible
              configuration.  The null output does not write anything  and  is  only  useful  for
              testing or with --slim for creating slim tables.

       -S, --style=FILE
              The  style  file.   This  specifies how the data is imported into the database, its
              format  depends  on  the  output.   (For  the  pgsql   output,   the   default   is
              /usr/share/osm2pgsql/default.style, for other outputs there is no default.)

PGSQL OUTPUT OPTIONS

--tablespace-main-data=TABLESPC
Store the data tables in the PostgreSQL tablespace TABLESPC.

--tablespace-main-index=TABLESPC
Store the indexes in the PostgreSQL tablespace TABLESPC.

--latlong
Store coordinates in degrees of latitude & longitude.

-m, --merc
Store coordinates in Spherical Mercator (Web Mercator, EPSG:3857) (the default).

-E, --proj=SRID
Use projection EPSG:SRID.

-p, --prefix=PREFIX
Prefix for table names (default: planet_osm). This option affects the middle as
well as the pgsql output table names.

--tag-transform-script=SCRIPT
Specify a Lua script to handle tag filtering and normalisation. The script
contains callback functions for nodes, ways and relations, which each take a set of
tags and returns a transformed, filtered set of tags which are then written to the
database.

-x, --extra-attributes
Include attributes (user name, user id, changeset id, timestamp and version). This
also requires additional entries in your style file.

-k, --hstore
Add tags without column to an additional hstore (key/value) column in the database
tables.

-j, --hstore-all
Add all tags to an additional hstore (key/value) column in the database tables.

-z, --hstore-column=PREFIX
Add an additional hstore (key/value) column named PREFIX containing all tags that
have a key starting with PREFIX, eg \--hstore-column "name:" will produce an extra
hstore column that contains all name:xx tags.

--hstore-match-only
Only keep objects that have a value in at least one of the non-hstore columns.

--hstore-add-index
Create indexes for all hstore columns after import.

-G, --multi-geometry
Normally osm2pgsql splits multi-part geometries into separate database rows per
part. A single OSM object can therefore use several rows in the output tables.
With this option, osm2pgsql instead generates multi-geometry features in the
PostgreSQL tables.

-K, --keep-coastlines
Keep coastline data rather than filtering it out. By default objects tagged
natural=coastline will be discarded based on the assumption that Shapefiles
generated by OSMCoastline (https://osmdata.openstreetmap.de/) will be used for the
coastline data.

--reproject-area
Compute area column using spherical mercator coordinates even if a different
projection is used for the geometries.

--output-pgsql-schema=SCHEMA
Use PostgreSQL schema SCHEMA for all tables, indexes, and functions in the pgsql
output. The schema must exist in the database and be writable by the database
user. By default the schema set with --schema is used, or public if that is not
set.

EXPIRE OPTIONS

       -e, --expire-tiles=[MIN_ZOOM-]MAX-ZOOM
              Create a tile expiry list.

       -o, --expire-output=FILENAME
              Output file name for expired tiles list.

       --expire-bbox-size=SIZE
              Max size for a polygon to expire the whole polygon, not just the boundary.

ADVANCED OPTIONS

       -I, --disable-parallel-indexing
              Disable parallel clustering and index building on all tables, build one index after
              the other.

       --number-processes=THREADS
              Specifies the number of parallel threads used for certain operations.