Documentation

geo.totalDistance() function

geo.totalDistance() is experimental and subject to change at any time.

geo.totalDistance() calculates the total distance covered by subsequent points in each input table.

Each row must contain lat (latitude) and lon (longitude) columns that represent the geographic coordinates of the point. Row sort order determines the order in which distance between points is calculated. Use the geo.units option to specify the unit of distance to return (default is km).

Function type signature
(<-tables: stream[{B with lon: float, lat: float}], ?outputColumn: A) => stream[C] where C: Record

For more information, see Function type signatures.

Parameters

outputColumn

Total distance output column. Default is _value.

tables

Input data. Default is piped-forward data (<-).

Examples

Return the total distance travelled per input table

import "experimental/geo"

data
    |> geo.totalDistance()

View example input and output

Return the total distance travelled in miles

import "experimental/geo"

option geo.units = {distance: "mile"}

data
    |> geo.totalDistance()

View example input and output


Was this page helpful?

Thank you for your feedback!


The future of Flux

Flux is going into maintenance mode. You can continue using it as you currently are without any changes to your code.

Flux is going into maintenance mode and will not be supported in InfluxDB 3.0. This was a decision based on the broad demand for SQL and the continued growth and adoption of InfluxQL. We are continuing to support Flux for users in 1.x and 2.x so you can continue using it with no changes to your code. If you are interested in transitioning to InfluxDB 3.0 and want to future-proof your code, we suggest using InfluxQL.

For information about the future of Flux, see the following: