Skip to main content
interface MatchGraphRequest
graph_name: string;
options?: Record<string, string>;
sample_points: string[];
solution_table?: string;
solve_method?: string;
graph_name options? sample_points solution_table? solve_method?
graph_name: string

Name of the underlying geospatial graph resource to match to using sample_points.

options?: Record<string, string>

Additional parameters.

sample_points: string[]

Sample points used to match to an underlying geospatial graph. Sample points must be specified using identifiers; identifiers are grouped as combinations. Identifiers can be used with: existing column names, e.g., ‘table.column AS SAMPLE_X’; expressions, e.g., ‘ST_MAKEPOINT(table.x, table.y) AS SAMPLE_WKTPOINT’; or constant values, e.g., ‘1, 2, 10 AS SAMPLE_TRIPID’.

solution_table?: string

The name of the table used to store the results, in [schema_name.]table_name format, using standard name resolution rules and meeting table naming criteria. This table contains a track of geospatial points for the matched portion of the graph, a track ID, and a score value. Also outputs a details table containing a trip ID (that matches the track ID), the latitude/longitude pair, the timestamp the point was recorded at, and an edge ID corresponding to the matched road segment. Must not be an existing table of the same name.

solve_method?: string

The type of solver to use for graph matching.