Skip to content

Issue 2913 standardize output columns pgr_dagShortestPath #2918

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

Merged
cvvergara merged 3 commits into from
Jun 16, 2025
Merged

Issue 2913 standardize output columns pgr_dagShortestPath #2918

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
a6fa854
Standardizing pgr_DAGshortestPath to one path result columns
cvvergara Jun 12, 2025
386ec71
(pgr_DAGshortestPath) updating NEWS and release notes about standardi…
cvvergara Jun 13, 2025
2554911
Update locale: commit 386ec71f1f
github-actions[bot] Jun 14, 2025
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
31 changes: 17 additions & 14 deletions NEWS.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -54,6 +54,9 @@ Functions promoted to official

**Signatures promoted to official**

[#2718](https://github.com/pgRouting/pgrouting/issues/2918)
Make official the Combinations signature on the official functions

* pgr_aStar(Combinations)
* pgr_aStarCost(Combinations)
* pgr_bdAstar(Combinations)
Expand All @@ -74,14 +77,8 @@ SQL signatures and output standardization
[#2904](https://github.com/pgRouting/pgrouting/issues/2904)
Standardize output columns of functions with different output columns within overloads


**Official functions**

* [#2906](https://github.com/pgRouting/pgrouting/issues/2906) pgr_bdDijkstra

* Output columns standardized to ``(seq, path_seq, start_vid, end_vid, node, edge, cost, agg_cost)``
* Combinations signature promoted to official.

* [#2905](https://github.com/pgRouting/pgrouting/issues/2905)
pgr_withPoints

Expand All @@ -92,15 +89,10 @@ Standardize output columns of functions with different output columns within ove
- Directed graph valid values: ``l`` or ``L`` and ``r``, ``R``
- Undirected graph valid values: ``b`` or ``B``

* [#2905](https://github.com/pgRouting/pgrouting/issues/2905)
pgr_withPointsCost
* [#2906](https://github.com/pgRouting/pgrouting/issues/2906) pgr_bdDijkstra

* Function promoted to official.
* Output columns standardized to ``(start_vid, end_vid, agg_cost)``
* Signature change: ``driving_side`` parameter changed from named optional to
unnamed positional.
- Directed graph valid values: ``l`` or ``L`` and ``r``, ``R``
- Undirected graph valid values: ``b`` or ``B``
* Output columns standardized to ``(seq, path_seq, start_vid, end_vid, node, edge, cost, agg_cost)``
* Combinations signature promoted to official.

**Experimental functions**

Expand All @@ -114,6 +106,11 @@ Standardize output columns of functions with different output columns within ove

* Output columns standardized to ``(seq, path_seq, start_vid, end_vid, node, edge, cost, agg_cost)``

* [#2913](https://github.com/pgRouting/pgrouting/issues/2913)
pgr_DAGshortestPath

* Output columns standardized to ``(seq, path_seq, start_vid, end_vid, node, edge, cost, agg_cost)``

Removal of SQL deprecated signatures
...............................................................................

Expand Down Expand Up @@ -207,6 +204,10 @@ Related issues: [#2897](https://github.com/pgRouting/pgrouting/issues/2897)
* _v4trsp(text,text,text,boolean)
* _pgr_tspeuclidean(text,bigint,bigint,double precision,integer,integer,integer,double precision,double precision,double precision,boolean)
* _pgr_tsp(text,bigint,bigint,double precision,integer,integer,integer,double precision,double precision,double precision,boolean)
* [#2913](https://github.com/pgRouting/pgrouting/issues/2913)
_pgr_dagshortestpath(text,text,boolean,boolean)
* [#2913](https://github.com/pgRouting/pgrouting/issues/2913)
_pgr_dagshortestpath(text,anyarray,anyarray,boolean,boolean)


* [#2861](https://github.com/pgRouting/pgrouting/issues/2861):
Expand Down Expand Up @@ -253,5 +254,7 @@ Code enhancements
* _v4trsp(text,text,anyarray,anyarray,boolean)
* _v4trsp(text,text,text,boolean)
* _pgr_withpointsdd(text,text,anyarray,double precision,boolean,character,boolean,boolean)
* [#2913](https://github.com/pgRouting/pgrouting/issues/2913)
_pgr_dagshortestpath

</details>
30 changes: 17 additions & 13 deletions doc/dagShortestPath/pgr_dagShortestPath.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,15 +27,19 @@ In particular, the DAG shortest paths algorithm implemented by Boost.Graph.

.. rubric:: Availability

* Version 3.2.0
.. rubric:: Version 4.0.0

* New experimental function.
* Output columns standardized to |short-generic-result|

* pgr_dagShortestPath(Combinations)
.. rubric:: Version 3.2.0

* Version 3.0.0
* New experimental function.

* New experimental function.
* pgr_dagShortestPath(Combinations)

..rubric:: Version 3.0.0

* New experimental function.


Description
Expand Down Expand Up @@ -93,7 +97,7 @@ Signatures
| pgr_dagShortestPath(`Edges SQL`_, **start vids**, **end vids**)
| pgr_dagShortestPath(`Edges SQL`_, `Combinations SQL`_)

| Returns set of |result-1-1|
| Returns set of |short-generic-result|
| OR EMPTY SET


Expand All @@ -108,7 +112,7 @@ One to One

| pgr_dagShortestPath(`Edges SQL`_, **start vid**, **end vid**)

| Returns set of |result-1-1|
| Returns set of |short-generic-result|
| OR EMPTY SET

:Example: From vertex :math:`5` to vertex :math:`11` on a **directed** graph
Expand All @@ -128,7 +132,7 @@ One to Many

| pgr_dagShortestPath(`Edges SQL`_, **start vid**, **end vids**)

| Returns set of |result-1-1|
| Returns set of |short-generic-result|
| OR EMPTY SET

:Example: From vertex :math:`5` to vertices :math:`\{7, 11\}`
Expand All @@ -148,7 +152,7 @@ Many to One

| pgr_dagShortestPath(`Edges SQL`_, **start vids**, **end vid**)

| Returns set of |result-1-1|
| Returns set of |short-generic-result|
| OR EMPTY SET

:Example: From vertices :math:`\{5, 10\}` to vertex :math:`11`
Expand All @@ -168,7 +172,7 @@ Many to Many

| pgr_dagShortestPath(`Edges SQL`_, **start vids**, **end vids**)

| Returns set of |result-1-1|
| Returns set of |short-generic-result|
| OR EMPTY SET

:Example: From vertices :math:`\{5, 15\}` to vertices :math:`\{11, 17\}` on an
Expand All @@ -189,7 +193,7 @@ Combinations

| pgr_dagShortestPath(`Edges SQL`_, `Combinations SQL`_)

| Returns set of |result-1-1|
| Returns set of |short-generic-result|
| OR EMPTY SET

:Example: Using a combinations table on an **undirected** graph
Expand Down Expand Up @@ -234,8 +238,8 @@ Return columns
-------------------------------------------------------------------------------

.. include:: pgRouting-concepts.rst
:start-after: return_path_short_start
:end-before: return_path_short_end
:start-after: return_path_complete_start
:end-before: return_path_complete_end

Additional Examples
-------------------------------------------------------------------------------
Expand Down
23 changes: 23 additions & 0 deletions doc/src/migration.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -81,6 +81,8 @@ types.
- `Migration of single path functions`_
* - .. versionchanged:: 4.0.0 :doc:`pgr_bellmanFord` [3]_
- `Migration of single path functions`_
* - .. versionchanged:: 4.0.0 :doc:`pgr_dagShortestPath` [3]_
- `Migration of single path functions`_
* - .. versionchanged:: 4.0.0 :doc:`pgr_edwardMoore` [3]_
- `Migration of single path functions`_
* - .. versionchanged:: 4.0.0 :doc:`pgr_withPoints` [2]_
Expand Down Expand Up @@ -313,6 +315,9 @@ application.
* - ``pgr_bellmanFord``
- v < 4.0
- |old-generic-result|
* - ``pgr_dagShortestPath``
- v < 4.0
- |result-1-1|
* - ``pgr_edwardMoore``
- v < 4.0
- |old-generic-result|
Expand Down Expand Up @@ -410,6 +415,24 @@ Before updating pgRouting enumerate the columns: |result-1-1|
:start-after: --bdDijkstra-1-to-1-filter
:end-before: --bdDijkstra-1-to-m

.. rubric:: Using ``pgr_DAGshortestPath``

Migrating `this v3.8
<https://docs.pgrouting.org/3.8/en/pgr_dagShortestPath.html#one-to-one>`__
example.

.. literalinclude:: migration.queries
:start-after: --DAGshortestPath-1-to-1
:end-before: --DAGshortestPath-1-to-1-filter

Before updating pgRouting enumerate the columns: |result-1-1|

.. literalinclude:: migration.queries
:start-after: --DAGshortestPath-1-to-1-filter
:end-before: --DAGshortestPath-END

.. note:: This applies to all signatures of ``pgr_DAGshortestPath``

Examples for One to Many with one route result
...............................................................................

Expand Down
28 changes: 18 additions & 10 deletions doc/src/release_notes.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -75,6 +75,9 @@ Functions promoted to official

.. rubric:: Signatures promoted to official

`#2718 <https://github.com/pgRouting/pgrouting/issues/2918>`__
Make official the Combinations signature on the official functions

* pgr_aStar(Combinations)
* pgr_aStarCost(Combinations)
* pgr_bdAstar(Combinations)
Expand All @@ -95,26 +98,18 @@ SQL signatures and output standardization
`#2904 <https://github.com/pgRouting/pgrouting/issues/2904>`__
Standardize output columns of functions with different output columns within overloads


.. rubric:: Official functions

* `#2906 <https://github.com/pgRouting/pgrouting/issues/2906>`__ pgr_bdDijkstra

.. include:: pgr_bdDijkstra.rst
:start-after: Version 4.0.0
:end-before: .. rubric

* `#2905 <https://github.com/pgRouting/pgrouting/issues/2905>`__
pgr_withPoints

.. include:: pgr_withPoints.rst
:start-after: Version 4.0.0
:end-before: .. rubric

* `#2905 <https://github.com/pgRouting/pgrouting/issues/2905>`__
pgr_withPointsCost
* `#2906 <https://github.com/pgRouting/pgrouting/issues/2906>`__ pgr_bdDijkstra

.. include:: pgr_withPointsCost.rst
.. include:: pgr_bdDijkstra.rst
:start-after: Version 4.0.0
:end-before: .. rubric

Expand All @@ -134,6 +129,13 @@ Standardize output columns of functions with different output columns within ove
:start-after: Version 4.0.0
:end-before: .. rubric

* `#2913 <https://github.com/pgRouting/pgrouting/issues/2913>`__
pgr_DAGshortestPath

.. include:: pgr_dagShortestPath.rst
:start-after: Version 4.0.0
:end-before: .. rubric

Removal of SQL deprecated signatures
...............................................................................

Expand Down Expand Up @@ -227,6 +229,10 @@ Related issues: `#2897 <https://github.com/pgRouting/pgrouting/issues/2897>`__
* _v4trsp(text,text,text,boolean)
* _pgr_tspeuclidean(text,bigint,bigint,double precision,integer,integer,integer,double precision,double precision,double precision,boolean)
* _pgr_tsp(text,bigint,bigint,double precision,integer,integer,integer,double precision,double precision,double precision,boolean)
* `#2913 <https://github.com/pgRouting/pgrouting/issues/2913>`__
_pgr_dagshortestpath(text,text,boolean,boolean)
* `#2913 <https://github.com/pgRouting/pgrouting/issues/2913>`__
_pgr_dagshortestpath(text,anyarray,anyarray,boolean,boolean)


* `#2861 <https://github.com/pgRouting/pgrouting/issues/2861>`__:
Expand Down Expand Up @@ -273,6 +279,8 @@ Code enhancements
* _v4trsp(text,text,anyarray,anyarray,boolean)
* _v4trsp(text,text,text,boolean)
* _pgr_withpointsdd(text,text,anyarray,double precision,boolean,character,boolean,boolean)
* `#2913 <https://github.com/pgRouting/pgrouting/issues/2913>`__
_pgr_dagshortestpath

pgRouting 3
*******************************************************************************
Expand Down
Loading