Skip to content

Docs: Clarify pgr_createTopology edge table updates and notice (#880) #3062

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
sakirr05 wants to merge 2 commits into
base: develop
Choose a base branch
from
+25 −7
Open

Docs: Clarify pgr_createTopology edge table updates and notice (#880) #3062

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
f158997
Docs: Clarify pgr_createTopology edge table updates and notice (#880)
Feb 7, 2026
8fd2b55
Update locale: commit f15899721
github-actions[bot] Feb 7, 2026
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
11 changes: 9 additions & 2 deletions doc/src/pgRouting-concepts.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -489,14 +489,21 @@ documentation and the `PostGIS <https://postgis.net/>`__ documentation.
Build a routing topology
...............................................................................

.. note::
When using topology creation (e.g. the deprecated ``pgr_createTopology`` or
the steps below), the edge table may be affected: if ``clean=true``, the
``source`` and ``target`` column values are wiped and reassigned; otherwise
they are only updated where not already filled. Indexes may be created on
``id``, ``the_geom``, ``source``, and ``target`` if they do not exist. A
vertices table is created if not present.

The basic information to use the majority of the pgRouting functions ``id,
source, target, cost, [reverse_cost]`` is what in pgRouting is called the
routing topology.

``reverse_cost`` is optional but strongly recommended to have in order to reduce
the size of the database due to the size of the geometry columns.
Having said that, in this documentation ``reverse_cost`` is used in this
documentation.
Having said that, in this documentation ``reverse_cost`` is used throughout.

When the data comes with geometries and there is no routing topology, then this
step is needed.
Expand Down
14 changes: 11 additions & 3 deletions locale/en/LC_MESSAGES/pgrouting_doc_strings.po
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ msgid ""
msgstr ""
"Project-Id-Version: pgRouting v4.1\n"
"Report-Msgid-Bugs-To: \n"
"POT-Creation-Date: 2026-02-06 17:38+0000\n"
"POT-Creation-Date: 2026-02-07 21:55+0000\n"
"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
"Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
"Language-Team: LANGUAGE <LL@li.org>\n"
Expand Down Expand Up @@ -4797,6 +4797,15 @@ msgstr ""
msgid "Build a routing topology"
msgstr ""

msgid ""
"When using topology creation (e.g. the deprecated ``pgr_createTopology`` or "
"the steps below), the edge table may be affected: if ``clean=true``, the "
"``source`` and ``target`` column values are wiped and reassigned; otherwise "
"they are only updated where not already filled. Indexes may be created on "
"``id``, ``the_geom``, ``source``, and ``target`` if they do not exist. A "
"vertices table is created if not present."
msgstr ""

msgid ""
"The basic information to use the majority of the pgRouting functions ``id, "
"source, target, cost, [reverse_cost]`` is what in pgRouting is called the "
Expand All @@ -4806,8 +4815,7 @@ msgstr ""
msgid ""
"``reverse_cost`` is optional but strongly recommended to have in order to "
"reduce the size of the database due to the size of the geometry columns. "
"Having said that, in this documentation ``reverse_cost`` is used in this "
"documentation."
"Having said that, in this documentation ``reverse_cost`` is used throughout."
msgstr ""

msgid ""
Expand Down
7 changes: 5 additions & 2 deletions locale/pot/pgrouting_doc_strings.pot
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ msgid ""
msgstr ""
"Project-Id-Version: pgRouting v4.1\n"
"Report-Msgid-Bugs-To: \n"
"POT-Creation-Date: 2026-02-06 17:38+0000\n"
"POT-Creation-Date: 2026-02-07 21:55+0000\n"
"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
"Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
"Language-Team: LANGUAGE <LL@li.org>\n"
Expand Down Expand Up @@ -4309,10 +4309,13 @@ msgstr ""
msgid "Build a routing topology"
msgstr ""

msgid "When using topology creation (e.g. the deprecated ``pgr_createTopology`` or the steps below), the edge table may be affected: if ``clean=true``, the ``source`` and ``target`` column values are wiped and reassigned; otherwise they are only updated where not already filled. Indexes may be created on ``id``, ``the_geom``, ``source``, and ``target`` if they do not exist. A vertices table is created if not present."
msgstr ""

msgid "The basic information to use the majority of the pgRouting functions ``id, source, target, cost, [reverse_cost]`` is what in pgRouting is called the routing topology."
msgstr ""

msgid "``reverse_cost`` is optional but strongly recommended to have in order to reduce the size of the database due to the size of the geometry columns. Having said that, in this documentation ``reverse_cost`` is used in this documentation."
msgid "``reverse_cost`` is optional but strongly recommended to have in order to reduce the size of the database due to the size of the geometry columns. Having said that, in this documentation ``reverse_cost`` is used throughout."
msgstr ""

msgid "When the data comes with geometries and there is no routing topology, then this step is needed."
Expand Down