2.3 KiB
2.3 KiB
Routing functions
The following functions provide routing capabilities to calculate the route from one point to another using differents modes like car or bicycle for example. This service uses the routing service defined for the user (currently, only the Mapzen routing service is available).
cdb_route_point_to_point(origin geometry(Point), destination geometry(Point), mode text, [options text[], units text])
Arguments
| Name | Type | Description | Accepted values |
|---|---|---|---|
origin |
geometry(Point) |
Origin point, in 4326 projection, which defines the start location. | |
destination |
geometry(Point) |
Destination point, in 4326 projection, which defines the end location. | |
mode |
text |
Type of transport used to calculate the isolines. | car, walk, bicycle or public_transport |
options |
text[] |
(Optional) Multiple options to add more capabilities to the analysis. See Optional routing parameters for details. | |
units |
text |
Unit used to represent the length of the route. | kilometers, miles. By default is kilometers |
Returns
| Name | Type | Description |
|---|---|---|
duration |
integer |
Duration in seconds of the calculated route. |
length |
real |
Length in the defined unit in the units field. kilometers by default . |
the_geom |
geometry(LineString) |
LineString geometry of the calculated route in the 4326 projection. |
Examples
Insert the values from the calculated route in your table
INSERT INTO <TABLE> (duration, length, the_geom) SELECT duration, length, shape FROM cdb_route_point_to_point('POINT(-3.70237112 40.41706163)'::geometry,'POINT(-3.69909883 40.41236875)'::geometry, 'car')
Update the geometry field with the calculated route shape
UPDATE <TABLE> SET the_geom = (SELECT shape FROM cdb_route_point_to_point('POINT(-3.70237112 40.41706163)'::geometry,'POINT(-3.69909883 40.41236875)'::geometry, 'car', ARRAY['mode_type=shortest']::text[]))
Optional routing parameters
The optional value parameters must be passed using the format: option=value.
| Name | Type | Description | Accepted values |
|---|---|---|---|
mode_type |
text |
Type of route calculation | shortest (this option only apply to the car mode) |