-
-
Notifications
You must be signed in to change notification settings - Fork 34
Withpoints chapter #260
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.
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
Withpoints chapter #260
Conversation
|
Warning Rate limit exceeded@cvvergara has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 9 minutes and 4 seconds before requesting another review. ⌛ How to resolve this issue?After the wait time has elapsed, a review can be triggered using the We recommend that you space out your commits to avoid hitting the rate limit. 🚦 How do rate limits work?CodeRabbit enforces hourly rate limits for each developer per organization. Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout. Please see our FAQ for further information. 📒 Files selected for processing (8)
WalkthroughReplaces the “plpgsql_function” chapter with a new “withPoints” chapter across docs, scripts, images, locales, and build config. Adds a new PL/pgSQL function wrk_withPoints, associated scripts, images, and views; removes prior plpgsql functions, scripts, docs, and locales. Updates two coordinate constants. Changes
Sequence Diagram(s)sequenceDiagram
autonumber
actor Dev as Developer
participant PSQL as psql
participant DB as PostgreSQL + PostGIS
participant FN as wrk_withPoints()
participant PGR as pgRouting
Dev->>PSQL: Run withPoints.sql
PSQL->>DB: CREATE FUNCTION wrk_withPoints(...)
Dev->>PSQL: Run images.sql
PSQL->>DB: CREATE tables/views (points_on_map, closest_walk, using_*)
Note over FN,PGR: Route computation flow
Dev->>PSQL: SELECT * FROM wrk_withPoints(edges_subset, p1, p2, do_debug)
PSQL->>DB: Execute function
DB->>FN: Invoke wrk_withPoints
FN->>PGR: pgr_findCloseEdges(edges_subset, point1/point2)
PGR-->>FN: Closest edges to points
FN->>PGR: pgr_withPoints(edges_subset, points/edges)
PGR-->>FN: Route rows (seq, id, cost, geom, ...)
FN-->>PSQL: Return route with azimuth and readable text
PSQL-->>Dev: Results/Views materialized
Estimated code review effort🎯 4 (Complex) | ⏱️ ~60 minutes Possibly related PRs
Suggested reviewers
Poem
Pre-merge checks and finishing touches❌ Failed checks (1 inconclusive)
✅ Passed checks (2 passed)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Actionable comments posted: 8
🧹 Nitpick comments (1)
docs/scripts/basic/withPoints/withPoints.sql (1)
48-48: Fix typo: "resuts_query" should be "results_query".The variable name contains a typographical error. This typo is also present at lines 68 and 99 where the variable is used.
Apply this diff:
DECLARE closest_query TEXT; - resuts_query TEXT; + results_query TEXT; additional_query TEXT; final_query TEXT;And update the usage at line 68:
- resuts_query := format( + results_query := format( $$SELECT seq, edge AS id, node, cost AS secondsAnd at line 99:
final_query := 'WITH - results AS (' || resuts_query || '), + results AS (' || results_query || '), additional AS ( ' || additional_query || ')
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
⛔ Files ignored due to path filters (7)
docs/basic/images/plpgsql_function/ch8-e7.pngis excluded by!**/*.pngdocs/basic/images/plpgsql_function/ch8-taxinet.pngis excluded by!**/*.pngdocs/basic/images/plpgsql_function/ch8-vehiclenet.pngis excluded by!**/*.pngdocs/basic/images/plpgsql_function/ch8-walknet.pngis excluded by!**/*.pngdocs/basic/images/plpgsql_function/closest_vertex.pngis excluded by!**/*.pngdocs/basic/images/withPoints/points_on_map.pngis excluded by!**/*.pngdocs/basic/images/withPoints/points_routing.pngis excluded by!**/*.png
📒 Files selected for processing (19)
CMakeLists.txt(1 hunks)docs/basic/CMakeLists.txt(1 hunks)docs/basic/images/CMakeLists.txt(1 hunks)docs/basic/images/withPoints/CMakeLists.txt(1 hunks)docs/basic/plpgsql_function.rst(0 hunks)docs/basic/withPoints.rst(1 hunks)docs/index.rst(1 hunks)docs/scripts/basic/CMakeLists.txt(2 hunks)docs/scripts/basic/plpgsql_function/CMakeLists.txt(0 hunks)docs/scripts/basic/plpgsql_function/plpgsql_function.sql(0 hunks)docs/scripts/basic/withPoints/CMakeLists.txt(1 hunks)docs/scripts/basic/withPoints/images.sql(1 hunks)docs/scripts/basic/withPoints/withPoints.sql(1 hunks)locale/en/LC_MESSAGES/basic/plpgsql_function.po(0 hunks)locale/en/LC_MESSAGES/basic/withPoints.po(1 hunks)locale/es/LC_MESSAGES/basic/withPoints.po(5 hunks)locale/pot/basic/plpgsql_function.pot(0 hunks)locale/pot/basic/withPoints.pot(1 hunks)locale/sv/LC_MESSAGES/basic/withPoints.po(1 hunks)
💤 Files with no reviewable changes (5)
- docs/basic/plpgsql_function.rst
- docs/scripts/basic/plpgsql_function/CMakeLists.txt
- locale/pot/basic/plpgsql_function.pot
- docs/scripts/basic/plpgsql_function/plpgsql_function.sql
- locale/en/LC_MESSAGES/basic/plpgsql_function.po
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)
- GitHub Check: Build
🔇 Additional comments (10)
docs/basic/images/withPoints/CMakeLists.txt (1)
6-8: LGTM!The image file list update correctly reflects the new withPoints chapter content, replacing the previous plpgsql_function images with the new points-related imagery.
docs/basic/images/CMakeLists.txt (1)
11-11: LGTM!The subdirectory update from
plpgsql_functiontowithPointscorrectly aligns with the chapter reorganization.docs/index.rst (1)
38-38: LGTM!The documentation index correctly references the new
withPoints.rstchapter, ensuring proper navigation structure.docs/basic/CMakeLists.txt (1)
14-14: LGTM!The workshop files list correctly includes
withPoints.rst, replacing the previousplpgsql_function.rstentry.locale/sv/LC_MESSAGES/basic/withPoints.po (1)
14-730: LGTM!The Swedish localization file has been consistently updated to reference the new
withPoints.rstdocumentation throughout. The translation structure and references align with the chapter reorganization.locale/es/LC_MESSAGES/basic/withPoints.po (1)
19-787: LGTM!The Spanish localization file has been consistently updated to reference the new
withPoints.rstdocumentation throughout. The translation structure and references align with the chapter reorganization.docs/scripts/basic/CMakeLists.txt (2)
12-12: LGTM!The directory list correctly includes
withPoints, replacing the previousplpgsql_functionentry.
28-28: LGTM!The build dependency correctly references
basic_withPoints_scripts, ensuring proper build ordering for the new chapter.docs/scripts/basic/withPoints/images.sql (1)
1-42: LGTM!The SQL script correctly creates visualization tables and views. The structure is clear, and the dependencies on
wrk_withPointsare properly managed by the build system.docs/scripts/basic/withPoints/CMakeLists.txt (1)
1-29: LGTM!The CMake configuration correctly sets up the SQL scripts execution order and dependencies. The custom command properly runs
withPoints.sqlbeforeimages.sql, ensuringwrk_withPointsis defined before the views that use it are created.
|
With this PR the basic section of the workshop rewrite is finished. |
Changes proposed in this pull request:
@pgRouting/admins
Summary by CodeRabbit