Renaming functions

Author: rustprooflabs

db/deploy/routing_functions.sql

@@ -28,7 +28,7 @@ COMMENT ON PROCEDURE {schema_name}.pgrouting_version_check IS 'Ensures appropria
 
 
 
-CREATE OR REPLACE PROCEDURE {schema_name}.routing_prepare_edges()
+CREATE OR REPLACE PROCEDURE {schema_name}.routing_prepare_edge_network()
 LANGUAGE plpgsql
 AS $$
 BEGIN
@@ -211,26 +211,26 @@ BEGIN
     -- Outputs:  `route_edges_output` temp table.
 END $$;
 
-COMMENT ON PROCEDURE {schema_name}.routing_prepare_edges() IS 'Requires `route_edge_input` temp table as input, creates `route_edges_output` temp table as output.';
+COMMENT ON PROCEDURE {schema_name}.routing_prepare_edge_network() IS 'Requires `route_edge_input` temp table as input, creates `route_edges_output` temp table as output.';
 
 
 
-CREATE OR REPLACE PROCEDURE {schema_name}.routing_prepare_roads()
+CREATE OR REPLACE PROCEDURE {schema_name}.routing_prepare_road_network()
 LANGUAGE plpgsql
 AS $$
 BEGIN
 
     CALL {schema_name}.pgrouting_version_check();
 
-    --Create edges table for input to routing_prepare_edges procedure
+    --Create edges table for input to routing_prepare_edge_network procedure
     DROP TABLE IF EXISTS route_edge_input;
     CREATE TEMP TABLE route_edge_input AS
     SELECT osm_id, layer, geom
         FROM {schema_name}.road_line
     ;
 
     -- Creates the `route_edges_output` table.
-    CALL {schema_name}.routing_prepare_edges();
+    CALL {schema_name}.routing_prepare_edge_network();
 
 
     DROP TABLE IF EXISTS {schema_name}.routing_road_edge;
@@ -368,7 +368,7 @@ BEGIN
 END $$;
 
 
-COMMENT ON PROCEDURE {schema_name}.routing_prepare_roads IS 'Creates the {schema_name}.routing_road_edge and {schema_name}.routing_road_vertex from the {schema_name}.road_line input data';
+COMMENT ON PROCEDURE {schema_name}.routing_prepare_road_network IS 'Creates the {schema_name}.routing_road_edge and {schema_name}.routing_road_vertex from the {schema_name}.road_line input data';
 
 
 
@@ -377,22 +377,22 @@ COMMENT ON PROCEDURE {schema_name}.routing_prepare_roads IS 'Creates the {schema
 --------------------------------------------------
 
 
-CREATE OR REPLACE PROCEDURE {schema_name}.routing_prepare_water()
+CREATE OR REPLACE PROCEDURE {schema_name}.routing_prepare_water_network()
 LANGUAGE plpgsql
 AS $$
 BEGIN
 
     CALL {schema_name}.pgrouting_version_check();
 
-    --Create edges table for input to routing_prepare_edges procedure
+    --Create edges table for input to routing_prepare_edge_network procedure
     DROP TABLE IF EXISTS route_edge_input;
     CREATE TEMP TABLE route_edge_input AS
     SELECT osm_id, layer, geom
         FROM {schema_name}.water_line
     ;
 
     -- Creates the `route_edges_output` table.
-    CALL {schema_name}.routing_prepare_edges();
+    CALL {schema_name}.routing_prepare_edge_network();
 
 
     DROP TABLE IF EXISTS {schema_name}.routing_water_edge;
@@ -508,4 +508,4 @@ BEGIN
 END $$;
 
 
-COMMENT ON PROCEDURE {schema_name}.routing_prepare_water IS 'Creates the {schema_name}.routing_water_edge and {schema_name}.routing_water_vertex from the {schema_name}.water_line input data';
+COMMENT ON PROCEDURE {schema_name}.routing_prepare_water_network IS 'Creates the {schema_name}.routing_water_edge and {schema_name}.routing_water_vertex from the {schema_name}.water_line input data';

docs/src/routing-4.md

@@ -11,22 +11,22 @@ CREATE EXTENSION IF NOT EXISTS pgrouting;
 
 # Process the OpenStreetMap Roads
 
-For routing on `osm.road_line` data use the `osm.routing_prepare_roads`
+For routing on `osm.road_line` data use the `osm.routing_prepare_road_network`
 procedure to prepare the edge and vertex data used for routing.
 
 ```sql
-CALL osm.routing_prepare_roads();
+CALL osm.routing_prepare_road_network();
 ```
 
-The `osm.routing_prepare_roads` procedure focuses on the most common use
+The `osm.routing_prepare_road_network` procedure focuses on the most common use
 cases of routing with the `osm.road_line` layer. It generates the edge/vertex
 network for all data in the `osm.road_line` table. It generates accurate `cost_length`
 by casting data to `GEOGRAPHY` and generates `cost_length_forward`
 and `cost_length_reverse` to natively support directionally-enforced routing
 without additional steps.
 
 
-> ⚠️ The `osm.routing_prepare_roads` procedure was added in PgOSM Flex 1.1.2
+> ⚠️ The `osm.routing_prepare_road_network` procedure was added in PgOSM Flex 1.1.2
 > and is a significant deviation in routing preparation along with pgRouting 4.0.
 > This procedure should be treated as a new feature with potential bugs lurking.
 
@@ -88,7 +88,7 @@ This direction data type resolves to `int2` in Postgres. Valid values are:
 * `NULL`: It's complicated. See [#172](https://github.com/rustprooflabs/pgosm-flex/issues/172).
 
 > Forward and reverse cost columns are calculated in the `cost_length_forward`
-> and `cost_length_reverse` columns within the `osm.routing_prepare_roads()` procedure.
+> and `cost_length_reverse` columns within the `osm.routing_prepare_road_network()` procedure.
 
 
 ## Travel Time Costs
@@ -297,7 +297,7 @@ PgOSM Flex also includes a procedure to prepare a routing network using
 the `osm.water_line` table.
 
 ```sql
-CALL osm.routing_prepare_water();
+CALL osm.routing_prepare_water_network();
 ```
 
 Find the `vertex_id` for start and end nodes, similar to approach above