Skip to content

Add documentation for missing replication script parameters #76

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Add documentation for missing replication script parameters #76

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 11 additions & 4 deletions _manual-v2/A-preparing-input-data.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -103,7 +103,7 @@ The `-d` parameter tells the replication script which database to connect
to. The script also supports all other parameters mentioned in the section
[database connection](#database-connection) including
[libpq environment variables](https://www.postgresql.org/docs/current/libpq-envars.html).
The only exception is the '-W' parameter for interactive password prompts.
The only exception is the `-W` parameter for interactive password prompts.
When you need to supply a password, always use a
[pgpass file](https://www.postgresql.org/docs/current/libpq-pgpass.html).

Expand All @@ -115,7 +115,8 @@ the replication information.
By default the update server and interval will be set from the file headers,
for planet dumps minutely updates from the OSM main servers will be used. If
you want to use a different replication service, use the `--server`
parameter.
parameter. You can also use `--osm-file <osm-file>` to retrieve the update
server from a data file.

It is safe to repeat initialisation at any time. For example, when you want
to change the replication service, simply run the init command again with a
Expand All @@ -132,15 +133,21 @@ and calls osm2pgsql with the given parameters to apply the changes. Note that
osm2pgsql-replication makes sure to only fetch a limited amount of data at the
time to make sure that it does not use up too much RAM. If more data is
available it will repeat the download and call of osm2pgsql until the database
is up to date. You can change the amount of data downloaded at once with
`--max-diff-size`, the default is 500MB.
is up to date (unless the option `--once` is used). You can change the amount
of data downloaded per at once with `--max-diff-size`, the default is 500MB.

Sometimes you need to run additional commands after osm2pgsql has updated the
database, for example, when you use the expiry function. You can use the
option `--post-processing` to give osm2pgsql-replication a script it is
supposed to run after each call to osm2pgsql. Note that if the script fails,
then the entire update process is considered a failure and aborted.

You can use the option `--diff-file <file>` to specify a file where osm2pgsql-replication
will save the changes before they are applied to the database.

After the update has finished, osm2pgsql-replication can run a script specified
by the option `--post-processing <script>`.

##### Putting it all together with systemd

osm2pgsql-replication works well as a systemd service that keeps your database
Expand Down