lds
Last updated
Was this helpful?
Last updated
Was this helpful?
This module contains functions and procedures that make use of location data services, such as geocoding, reverse geocoding, isolines and routing computation.
Your CARTO account has monthly quotas assigned for each LDS service that are used up by every call to the LDS functions and procedures in the Analytics Toolbox.
Accordingly, the use of these functions and procedures requires providing authorization credentials to prevent fraudulent usage. Two parameters are needed:
api_base_url
The API base url is simply the address through which you can access all the services of your CARTO account, and it depends on the region or premises where your account is located. Usually it will be this one: https://gcp-us-east1.api.carto.com
.
api_access_token
This token is an that is allowed to use the LDS API. You must keep this secret! Anyone that has access to this token can use up the LDS quota assigned to your account.
Both the API base url and your API access token can be accessed through the developers section of the CARTO user interface. The API base url is displayed inside this section while for the API access token you will have to create a new API access token allowing the LDS API.
For more information about CARTO for developers, please check our .
warning
Description
Geocodes an input table by adding an user defined column geom_column
with the geographic coordinates (latitude and longitude) of a given address column. This procedure also adds a carto_geocode_metadata
column with additional information of the geocoding result in JSON format. It geocodes sequentially the table in chunks of 100.
api_base_url
: STRING
url of the API where the customer account is stored.
input_table
: STRING
name of the table to be geocoded. Please make sure you have enough permissions to alter this table, as this procedure will add two columns to it to store the geocoding result.
address_column
: STRING
name of the column from the input table that contains the addresses to be geocoded.
geom_column
: STRING
|''
column name for the geometry column. Defaults to 'geom'
. Set to ''
to use the default value.
options
: STRING
|''
containing a valid JSON with the different options. In addition to the options targeted at the geocoding service described below, a boolean option carto_force_geocode
(false by default) can be used to force geocoding rows that already have a non-null value in geom_column
. Valid geocoding service options are described in the table below. If no options are indicated then 'default' values would be applied.
All
language
A STRING
that specifies the language of the geocoding in RFC 4647 format.
If the input table already contains a geometry column with the name defined by geom_column
, only those rows with NULL
values will be geocoded.
Examples
warning
Description
Reverse-geocodes an input table by adding an user defined column address_column
with the address coordinates corresponding to a given point location column. It geocodes sequentially the table in chunks of 100 rows.
api_base_url
: STRING
url of the API where the customer account is stored.
input_table
: STRING
name of the table to be reverse-geocoded. Please make sure you have enough permissions to alter this table, as this procedure will add two columns to it to store the geocoding result.
geom_column
: STRING
|''
column name for the geometry column that contains the points to be reverse-geocoded. Defaults to 'geom'
. Set to ''
to use the default value.
address_column
: STRING
name of the column where the computed addresses will be stored. It defaults to 'address'
, and it is created on the input table if it doesn't exist.
language
: STRING
|''
language in which results should be returned. Defaults to ''
. The effect and interpretation of this parameter depends on the LDS provider assigned to your account.
options
: STRING
|''
containing a valid JSON with the different options. No options are allowed currently, so this value will not be taken into account.
If the input table already contains a column with the name defined by address_column
, only those rows with NULL values will be reverse-geocoded.
Examples
warning
Description
Calculates the isolines (polygons) from given origins (points) in a table or query. It creates a new table with the columns of the input table or query except the geom_column
plus the isolines in the column geom
(if the input already contains a geom
column, it will be overwritten). It calculates isolines sequentially in chunks of N rows, N being the optimal batch size for this datawarehouse and the specific LDS provider that you are using.
The output table will contain a column named carto_isoline_metadata
with error information for each isoline result. Rows with errors will have a NULL geom
.
Note that The term isoline is used here in a general way to refer to the areas that can be reached from a given origin point within the given travel time or distance (depending on the range_type
parameter).
api_base_url
: STRING
url of the API where the customer account is stored.
input
: STRING
name of the input table or query.
output_table
: STRING
name of the output table. It will raise an error if the table already exists.
geom_column
: STRING
column name for the origin geometry column.
mode
: STRING
type of transport. The supported modes depend on the provider:
HERE
: 'walk', 'car', 'truck', 'taxi', 'bus', 'private_bus'.
TomTom
: 'walk', 'car', 'bike', 'motorbike', 'truck', 'taxi', 'bus', 'van'.
TravelTime
: 'walk', 'car', 'bike', 'public_transport', 'coach', 'bus', 'train', 'ferry'.
Mapbox
: 'walk', 'car', 'bike'.
range_value
: BIGINT
range of the isoline in seconds (for range_type
'time') or meters (for range_type
'distance').
range_type
: STRING
type of range. Supported: 'time' (for isochrones), 'distance' (for isodistances).
options
: STRING
|''
containing a valid JSON with the different options. Valid options are described in the table below. If no options are indicated then 'default' values would be applied.
HERE
arrival_time
A STRING
that specifies the time of arrival. If the value is set, a reverse isoline is calculated. If set to "any"
, then time-dependent effects will not be taken into account. It cannot be used in combination with departure_time
. Supported: "any"
, "now"
and date-time as "<YYYY-MM-DD>T<hh:mm:ss>"
.
HERE
departure_time
Default: "any"
. A STRING
that specifies the time of departure. If set to "any"
, then time-dependent effects will not be taken into account. It cannot be used in combination with arrival_time
. Supported: "any"
, "now"
and date-time as "<YYYY-MM-DD>T<hh:mm:ss>"
.
HERE
optimize_for
Default: "balanced"
. A STRING
that specifies how isoline calculation is optimized. Supported: "quality"
(calculation of isoline focuses on quality, that is, the graph used for isoline calculation has higher granularity generating an isoline that is more precise), "performance"
(calculation of isoline is performance-centric, quality of isoline is reduced to provide better performance) and "balanced"
(calculation of isoline takes a balanced approach averaging between quality and performance).
HERE
routing_mode
Default: "fast"
. A STRING
that specifies which optimization is applied during isoline calculation. Supported: "fast"
(route calculation from start to destination optimized by travel time. In many cases, the route returned by the fast mode may not be the route with the fastest possible travel time. For example, the routing service may favor a route that remains on a highway, even if a faster travel time can be achieved by taking a detour or shortcut through an inconvenient side road) and "short"
(route calculation from start to destination disregarding any speed information. In this mode, the distance of the route is minimized, while keeping the route sensible. This includes, for example, penalizing turns. Because of that, the resulting route will not necessarily be the one with minimal distance).
TomTom
departure_time
Default: "now"
. A STRING
that specifies the time of departure. Supported: "now"
and date-time as "<YYYY-MM-DD>T<hh:mm:ss>"
.
TomTom
traffic
Default: false
. A BOOLEAN
that specifies if all available traffic information will be taken into consideration. Supported: true
and false
.
TravelTime
single_shape
Default: false
. A BOOLEAN
that specifies if the response should contain only the main polygon in case of a result with multiple polygons. Supported: true
and false
.
TravelTime
level_of_detail
A JSON string. In the most typical case, you will want to use a string in the form { scale_type: 'simple_numeric', level: -N }
, with N
being the detail level (-8 by default). Higher Ns (more negative levels) will simplify the polygons more but will reduce performance. There are other ways of setting the level of detail. Check the [https://docs.traveltime.com/api/reference/isochrones#arrival_searches-level_of_detail](TravelTime docs) for more info.
TravelTime
departure_time
Default: "now"
. A STRING
that specifies the time of departure. Supported: "now"
and date-time as "<YYYY-MM-DD>T<hh:mm:ss>"
.
warning
Examples
warning
Description
Calculates the routes (line strings) between given origins and destinations (points) in a query. It creates a new table with the columns of the input query with the resulting route in the user defined column geom_column
(if the input already contains a column named geom_column
, it will be overwritten) and a carto_routing_metadata
column with the response of the service provider except for the route geometry. It calculates routes sequentially in chunks of 100 rows.
Note that routes are calculated using the external LDS provider assigned to your CARTO account. Currently TomTom and HERE are supported.
api_base_url
: STRING
url of the API where the customer account is stored.
input
: STRING
name of the input query, which must have columns named origin
and destination
of type GEOGRAPHY
and containing points. If a column named waypoints
is also present, it should contain a STRING with the coordinates of the desired intermediate points with the format "lon1,lat1:lon2,lat2..."
.
output_table
: STRING
name of the output table. It will raise an error if the table already exists.
geom_column
: STRING
column name for the generated geography column that will contain the resulting routes.
mode
: STRING
type of transport. The supported modes depend on the provider:
TomTom
: 'car', 'pedestrian', 'bicycle', 'motorcycle', 'truck', 'taxi', 'bus', 'van'.
HERE
: 'car', 'truck', 'pedestrian', 'bicycle', 'scooter', 'taxi', 'bus', 'privateBus'.
TomTom
:
avoid
: Specifies something that the route calculation should try to avoid when determining the route. Possible values (several of them can be used at the same time):
tollRoads
motorways
ferries
unpavedRoads
carpools
alreadyUsedRoads
Avoids
This
borderCrossings
tunnels
carTrains
lowEmissionZones
routeType
: Specifies the type of optimization used when calculating routes. Possible values: fastest
, shortest
, short
eco
, thrilling
traffic
: Set to true true
to consider all available traffic information during routing. Set to false
otherwise
departAt
: The date and time of departure at the departure point. It should be specified in RFC 3339 format with an optional time zone offset.
arriveAt
: The date and time of arrival at the destination point. It should be specified in RFC 3339 format with an optional time zone offset.
vehicleMaxspeed
: Maximum speed of the vehicle in kilometers/hour.
HERE
departureTime
: The date and time of departure at the departure point. It should be specified in RFC 3339 format with an optional time zone offset.
arrivalTime
: The date and time of arrival at the destination point. It should be specified in RFC 3339 format with an optional time zone offset.
For more advanced usage, check the documentation of your provider's routing API.
warning
Examples
Example with TomTom specific parameters:
warning
Description
Geocodes an address into a point with its geographic coordinates (latitude and longitude).
api_base_url
: STRING
url of the API where the customer account is stored.
address
: STRING
input address to geocode.
options
: STRING
|''
containing a valid JSON with the different options.
All
language
A STRING
that specifies the language of the geocoding in RFC 4647 format.
Return type
GEOGRAPHY
Examples
warning
This function consumes LDS quota. Each call consumes one unit of quota. Before running, check the size of the data to be reverse geocoded and make sure you store the result in a table to avoid misuse of the quota. To check the information about available and consumed quota use the function [GET_LDS_QUOTA_INFO
](lds.md#get_ lds_quota_info)
Description
Performs a reverse geocoding of the point received as input.
api_base_url
: STRING
url of the API where the customer account is stored.
geom
: GEOGRAPHY
input point for which to obtain the address.
language
: STRING
language in which results should be returned. Defaults to ''
. The effect and interpretation of this parameter depends on the LDS provider assigned to your account.
options
: STRING
|''
containing a valid JSON with the different options. No options are allowed currently, so this value will not be taken into account.
Return type
STRING
Examples
warning
Description
Calculates the isoline polygon from a given point.
api_base_url
: STRING
url of the API where the customer account is stored.
origin
: GEOGRAPHY
origin point of the isoline.
mode
: STRING
type of transport. The supported modes depend on the provider:
HERE
: 'walk', 'car', 'truck', 'taxi', 'bus', 'private_bus'.
TomTom
: 'walk', 'car', 'bike', 'motorbike', 'truck', 'taxi', 'bus', 'van'.
TravelTime
: 'walk', 'car', 'bike', 'public_transport', 'coach', 'bus', 'train', 'ferry'.
Mapbox
: 'walk', 'car', 'bike'.
range_value
: INT
range of the isoline in seconds (for range_type
'time') or meters (for range_type
'distance').
range_type
: STRING
type of range. Supported: 'time' (for isochrones), 'distance' (for isodistances).
options
STRING
|''
containing a valid JSON with the different options. Valid options are described in the table below. If no options are indicated then 'default' values would be applied.
HERE
arrival_time
A STRING
that specifies the time of arrival. If the value is set, a reverse isoline is calculated. If set to "any"
, then time-dependent effects will not be taken into account. It cannot be used in combination with departure_time
. Supported: "any"
, "now"
and date-time as "<YYYY-MM-DD>T<hh:mm:ss>"
.
HERE
departure_time
Default: "now"
. A STRING
that specifies the time of departure. If set to "any"
, then time-dependent effects will not be taken into account. It cannot be used in combination with arrival_time
. Supported: "any"
, "now"
and date-time as "<YYYY-MM-DD>T<hh:mm:ss>"
.
HERE
optimize_for
Default: "balanced"
. A STRING
that specifies how isoline calculation is optimized. Supported: "quality"
(calculation of isoline focuses on quality, that is, the graph used for isoline calculation has higher granularity generating an isoline that is more precise), "performance"
(calculation of isoline is performance-centric, quality of isoline is reduced to provide better performance) and "balanced"
(calculation of isoline takes a balanced approach averaging between quality and performance).
HERE
routing_mode
Default: "fast"
. A STRING
that specifies which optimization is applied during isoline calculation. Supported: "fast"
(route calculation from start to destination optimized by travel time. In many cases, the route returned by the fast mode may not be the route with the fastest possible travel time. For example, the routing service may favor a route that remains on a highway, even if a faster travel time can be achieved by taking a detour or shortcut through an inconvenient side road) and "short"
(route calculation from start to destination disregarding any speed information. In this mode, the distance of the route is minimized, while keeping the route sensible. This includes, for example, penalizing turns. Because of that, the resulting route will not necessarily be the one with minimal distance).
TomTom
departure_time
Default: "now"
. A STRING
that specifies the time of departure. If set to "any"
, then time-dependent effects will not be taken into account. Supported: "any"
, "now"
and date-time as "<YYYY-MM-DD>T<hh:mm:ss>"
.
TomTom
traffic
Default: true
. A BOOLEAN
that specifies if all available traffic information will be taken into consideration. Supported: true
and false
.
TravelTime
level_of_detail
A JSON string. In the most typical case, you will want to use a string in the form { scale_type: 'simple_numeric', level: -N }
, with N
being the detail level (-8 by default). Higher Ns (more negative levels) will simplify the polygons more but will reduce performance. There are other ways of setting the level of detail. Check the [https://docs.traveltime.com/api/reference/isochrones#arrival_searches-level_of_detail](TravelTime docs) for more info.
TravelTime
departure_time
Default: "now"
. A STRING
that specifies the time of departure. Supported: "now"
and date-time as "<YYYY-MM-DD>T<hh:mm:ss>"
.
warning
Return type
GEOGRAPHY
Examples
Description
Returns statistics about the LDS quota. LDS quota is an annual quota that defines how much geocoding and isolines you can compute. Each geocoded row or computed isolines counts as one LDS quota unit. The single element in the result of GET_LDS_QUOTA_INFO will show your LDS quota for the current annual period (annual_quota), how much you’ve spent (used_quota), and which LDS providers are in use.
api_base_url
: STRING
url of the API where the customer account is stored.
Return type
STRING
Example
This function consumes LDS quota. Each call consumes as many units of quota as the number of rows of your input table. Before running, we recommend checking the size of the data to be geocoded and your available quota using the function.
api_access_token
: STRING
an that is allowed to use the LDS API.
country
: STRING
|''
name of the country in .
This function consumes LDS quota. Each call consumes as many units of quota as the number of rows your input table has. Before running, we recommend checking the size of the data to be geocoded and your available quota using the function.
api_access_token
: STRING
an that is allowed to use the LDS API.
This function consumes LDS quota. Each call consumes as many units of quota as the number of rows your input table or query has. Before running, we recommend checking the size of data for which isolines will be created and your available quota using the function.
api_access_token
: STRING
an that is allowed to use the LDS API.
Before running, we recommend checking your provider using the function. Notice that some of the parameters are provider dependant. Please contact your CARTO representative if you have questions regarding the service provider configured in your organization.
This function consumes LDS quota. Each call consumes as many units of quota as the number of rows your input query has. Before running, we recommend checking the size of the data used to create the routes and your available quota using the function.
api_access_token
: STRING
an that is allowed to use the LDS API.
options
: STRING
|''
containing a valid JSON with optional parameters. This is intended for advanced use: additional parameters can be passed directly to the Routing provider by placing them in this JSON string. To find out what your provider is, check the function. The following are some of the most common parameters for each provider:
avoid
: Elements or areas to avoid. Information about avoidance can be found
language
: The language to use. Supported language codes can be found
Before running, we recommend checking your provider using the function. Notice that some of the parameters are provider dependant. Please contact your CARTO representative if you have questions regarding the service provider configured in your organization.
This function consumes LDS quota. Each call consumes one unit of quota. Before running, check the size of the data to be geocoded and make sure you store the result in a table to avoid misuse of the quota. To check the information about available and consumed quota use the function .
We recommend using this function only with an input of up to 10 records. In order to geocode larger sets of addresses, we strongly recommend using the procedure. Likewise, in order to materialize the results in a table.
api_access_token
: STRING
an that is allowed to use the LDS API.
country
: STRING
|''
name of the country in .
We recommend using this function only with an input of up to 10 records. In order to reverse-geocode larger sets of locations, we strongly recommend using the procedure. Likewise, in order to materialize the results in a table.
api_access_token
: STRING
an that is allowed to use the LDS API.
This function consumes LDS quota. Each call consumes one unit quota. Before running, check the size of the data and make sure you store the result in a table to avoid misuse of the quota. To check the information about available and consumed quota use the function .
We recommend using this function only with an input of up to 10 records. In order to calculate isolines for larger sets of locations, we strongly recommend using the procedure. Likewise, in order to materialize the results in a table.
api_access_token
: STRING
an that is allowed to use the LDS API.
Before running, we recommend checking your provider using the function. Notice that some of the parameters are provider dependant. Please contact your CARTO representative if you have questions regarding the service provider configured in your organization.
api_access_token
: STRING
an that is allowed to use the LDS API.