solve_graph
- solve_graph(
graph_name: string,
weights_on_edges?: string[],
restrictions?: string[],
solver_type?: string,
source_nodes?: string[],
destination_nodes?: string[],
solution_table?: string,
options?: Record<string, string>,
callback?: GPUdbCallback,
): Promise<SolveGraphResponse>Parameters
- graph_name: string
Name of the graph resource to solve.
Optionalweights_on_edges: string[]Additional weights to apply to the edges of an existing graph. Weights must be specified using identifiers; identifiers are grouped as combinations. Identifiers can be used with existing column names, e.g., ‘table.column AS WEIGHTS_EDGE_ID’, expressions, e.g., ‘ST_LENGTH(wkt) AS WEIGHTS_VALUESPECIFIED’, or constant values, e.g., ‘4, 15, 2 AS WEIGHTS_VALUESPECIFIED’. Any provided weights will be added (in the case of ‘WEIGHTS_VALUESPECIFIED’) to or multiplied with (in the case of ‘WEIGHTS_FACTORSPECIFIED’) the existing weight(s). If using constant values in an identifier combination, the number of values specified must match across the combination.
Optionalrestrictions: string[]Additional restrictions to apply to the nodes/edges of an existing graph. Restrictions must be specified using identifiers; identifiers are grouped as combinations. Identifiers can be used with existing column names, e.g., ‘table.column AS RESTRICTIONS_EDGE_ID’, expressions, e.g., ‘column/2 AS RESTRICTIONS_VALUECOMPARED’, or constant values, e.g., ‘0, 0, 0, 1 AS RESTRICTIONS_ONOFFCOMPARED’. If using constant values in an identifier combination, the number of values specified must match across the combination. If remove_previous_restrictions option is set to true, any provided restrictions will replace the existing restrictions. Otherwise, any provided restrictions will be added (in the case of ‘RESTRICTIONS_VALUECOMPARED’) to or replaced (in the case of ‘RESTRICTIONS_ONOFFCOMPARED’).
Optionalsolver_type: stringThe type of solver to use for the graph.
Optionalsource_nodes: string[]It can be one of the nodal identifiers - e.g: ‘NODE_WKTPOINT’ for source nodes. For BACKHAUL_ROUTING, this list depicts the fixed assets.
Optionaldestination_nodes: string[]It can be one of the nodal identifiers - e.g: ‘NODE_WKTPOINT’ for destination (target) nodes. For BACKHAUL_ROUTING, this list depicts the remote assets.
Optionalsolution_table: stringName of the table to store the solution, in [schema_name.]table_name format, using standard name resolution rules.
Optionaloptions: Record<string, string>Additional parameters.
Optionalcallback: GPUdbCallbackOptional callback function
Returns Promise<SolveGraphResponse>
Promise<Types.SolveGraphResponse> - Promise resolving to the response
- Defined in src/GPUdb.ts:14457
- graph_name: string
solve_graph_request
- solve_graph_request(
request: SolveGraphRequest,
callback?: GPUdbCallback,
): Promise<SolveGraphResponse>Solves an existing graph for a type of problem (e.g., shortest path, page rank, traveling salesman, etc.) using source nodes, destination nodes, and additional, optional weights and restrictions.
IMPORTANT: It’s highly recommended that you review the Graphs and Solvers concepts documentation, the Graph REST Tutorial, and/or some /solve/graph examples before using this endpoint.
Parameters
- request: SolveGraphRequest
Request object containing the parameters for the operation
Optionalcallback: GPUdbCallbackOptional callback function
Returns Promise<SolveGraphResponse>
Promise<Types.SolveGraphResponse> - Promise resolving to the response
- Defined in src/GPUdb.ts:14395
- request: SolveGraphRequest
Solves an existing graph for a type of problem (e.g., shortest path, page rank, traveling salesman, etc.) using source nodes, destination nodes, and additional, optional weights and restrictions.
IMPORTANT: It’s highly recommended that you review the Graphs and Solvers concepts documentation, the Graph REST Tutorial, and/or some /solve/graph examples before using this endpoint.