gpudb::ModifyGraphRequest Struct Reference

A set of input parameters for const. More...

#include <gpudb/protocol/modify_graph.h>

Public Member Functions
	ModifyGraphRequest ()
	Constructs a ModifyGraphRequest object with default parameter values. More...
	ModifyGraphRequest (const std::string &graphName_, const std::vector< std::string > &nodes_, const std::vector< std::string > &edges_, const std::vector< std::string > &weights_, const std::vector< std::string > &restrictions_, const std::map< std::string, std::string > &options_)
	Constructs a ModifyGraphRequest object with the specified parameters. More...

Public Attributes
std::string	graphName
std::vector< std::string >	nodes
std::vector< std::string >	edges
std::vector< std::string >	weights
std::vector< std::string >	restrictions
std::map< std::string, std::string >	options

Detailed Description

A set of input parameters for const.

Update an existing graph network using given nodes, edges, weights, restrictions, and options.

IMPORTANT: It's highly recommended that you review the Network Graphs & Solvers concepts documentation, the Graph REST Tutorial, and/or some graph examples before using this endpoint.

Definition at line 27 of file modify_graph.h.

Constructor & Destructor Documentation

gpudb::ModifyGraphRequest::ModifyGraphRequest ( )

inline

Constructs a ModifyGraphRequest object with default parameter values.

Definition at line 34 of file modify_graph.h.

gpudb::ModifyGraphRequest::ModifyGraphRequest ( const std::string &  graphName_, const std::vector< std::string > &  nodes_, const std::vector< std::string > &  edges_, const std::vector< std::string > &  weights_, const std::vector< std::string > &  restrictions_, const std::map< std::string, std::string > &  options_  )

inline

Constructs a ModifyGraphRequest object with the specified parameters.

Parameters

[in]	graphName_	Name of the graph resource to modify.
[in]	nodes_	Nodes with which to update existing nodes in graph specified by graphName. Review Nodes for more information. Nodes must be specified using identifiers; identifiers are grouped as combinations. Identifiers can be used with existing column names, e.g., 'table.column AS NODE_ID', expressions, e.g., 'ST_MAKEPOINT(column1, column2) AS NODE_WKTPOINT', or raw values, e.g., '{9, 10, 11} AS NODE_ID'. If using raw values in an identifier combination, the number of values specified must match across the combination. Identifier combination(s) do not have to match the method used to create the graph, e.g., if column names were specified to create the graph, expressions or raw values could also be used to modify the graph.
[in]	edges_	Edges with which to update existing edges in graph specified by graphName. Review Edges for more information. Edges must be specified using identifiers; identifiers are grouped as combinations. Identifiers can be used with existing column names, e.g., 'table.column AS EDGE_ID', expressions, e.g., 'SUBSTR(column, 1, 6) AS EDGE_NODE1_NAME', or raw values, e.g., "{'family', 'coworker'} AS EDGE_LABEL". If using raw values in an identifier combination, the number of values specified must match across the combination. Identifier combination(s) do not have to match the method used to create the graph, e.g., if column names were specified to create the graph, expressions or raw values could also be used to modify the graph.
[in]	weights_	Weights with which to update existing weights in graph specified by graphName. Review Weights for more information. 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 raw values, e.g., '{4, 15} AS WEIGHTS_VALUESPECIFIED'. If using raw values in an identifier combination, the number of values specified must match across the combination. Identifier combination(s) do not have to match the method used to create the graph, e.g., if column names were specified to create the graph, expressions or raw values could also be used to modify the graph.
[in]	restrictions_	Restrictions with which to update existing restrictions in graph specified by graphName. Review Restrictions for more information. 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 raw values, e.g., '{0, 0, 0, 1} AS RESTRICTIONS_ONOFFCOMPARED'. If using raw values in an identifier combination, the number of values specified must match across the combination. Identifier combination(s) do not have to match the method used to create the graph, e.g., if column names were specified to create the graph, expressions or raw values could also be used to modify the graph.
[in]	options_	Optional parameters. gpudb::modify_graph_restriction_threshold_value: Value-based restriction comparison. Any node or edge with a RESTRICTIONS_VALUECOMPARED value greater than the restriction_threshold_value will not be included in the graph. gpudb::modify_graph_export_create_results: If set to true, returns the graph topology in the response as arrays. gpudb::modify_graph_true gpudb::modify_graph_false The default value is gpudb::modify_graph_false. gpudb::modify_graph_enable_graph_draw: If set to true, adds a 'EDGE_WKTLINE' column identifier to the specified graph_table so the graph can be viewed via WMS; for social and non-geospatial graphs, the 'EDGE_WKTLINE' column identifier will be populated with spatial coordinates derived from a flattening layout algorithm so the graph can still be viewed. gpudb::modify_graph_true gpudb::modify_graph_false The default value is gpudb::modify_graph_false. gpudb::modify_graph_save_persist: If set to true, the graph will be saved in the persist directory (see the config reference for more information). If set to false, the graph will be removed when the graph server is shutdown. gpudb::modify_graph_true gpudb::modify_graph_false The default value is gpudb::modify_graph_false. gpudb::modify_graph_add_table_monitor: Adds a table monitor to every table used in the creation of the graph; this table monitor will trigger the graph to update dynamically upon inserts to the source table(s). Note that upon database restart, if save_persist is also set to true, the graph will be fully reconstructed and the table monitors will be reattached. For more details on table monitors, see /create/tablemonitor. gpudb::modify_graph_true gpudb::modify_graph_false The default value is gpudb::modify_graph_false. gpudb::modify_graph_graph_table: If specified, the created graph is also created as a table with the given name and following identifier columns: 'EDGE_ID', 'EDGE_NODE1_ID', 'EDGE_NODE2_ID'. If left blank, no table is created. The default value is ''. gpudb::modify_graph_remove_label_only: When RESTRICTIONS on labeled entities requested, if set to true this will NOT delete the entity but only the label associated with the entity. Otherwise (default), it'll delete the label AND the entity. gpudb::modify_graph_true gpudb::modify_graph_false The default value is gpudb::modify_graph_false. gpudb::modify_graph_add_turns: Adds dummy 'pillowed' edges around intersection nodes where there are more than three edges so that additional weight penalties can be imposed by the solve endpoints. (increases the total number of edges). gpudb::modify_graph_true gpudb::modify_graph_false The default value is gpudb::modify_graph_false. gpudb::modify_graph_turn_angle: Value in degrees modifies the thresholds for attributing right, left, sharp turns, and intersections. It is the vertical deviation angle from the incoming edge to the intersection node. The larger the value, the larger the threshold for sharp turns and intersections; the smaller the value, the larger the threshold for right and left turns; 0 < turn_angle < 90. The default value is '60'.

Definition at line 246 of file modify_graph.h.

Member Data Documentation

std::vector<std::string> gpudb::ModifyGraphRequest::edges

Definition at line 258 of file modify_graph.h.

std::string gpudb::ModifyGraphRequest::graphName

Definition at line 256 of file modify_graph.h.

std::vector<std::string> gpudb::ModifyGraphRequest::nodes

Definition at line 257 of file modify_graph.h.

std::map<std::string, std::string> gpudb::ModifyGraphRequest::options

Definition at line 261 of file modify_graph.h.

std::vector<std::string> gpudb::ModifyGraphRequest::restrictions

Definition at line 260 of file modify_graph.h.

std::vector<std::string> gpudb::ModifyGraphRequest::weights

Definition at line 259 of file modify_graph.h.

---

The documentation for this struct was generated from the following file:

• gpudb/protocol/modify_graph.h