gpudb::ModifyGraphRequest Struct Reference

A set of parameters for GPUdb::modifyGraph. More...

#include <gpudb/protocol/modify_graph.h>

Public Member Functions
	ModifyGraphRequest ()
	Constructs a ModifyGraphRequest object with default parameters. 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
	Name of the graph resource to modify. More...
std::vector< std::string >	nodes
	Nodes with which to update existing nodes in graph specified by graphName. More...
std::vector< std::string >	edges
	Edges with which to update existing edges in graph specified by graphName. More...
std::vector< std::string >	weights
	Weights with which to update existing weights in graph specified by graphName. More...
std::vector< std::string >	restrictions
	Restrictions with which to update existing restrictions in graph specified by graphName. More...
std::map< std::string, std::string >	options
	Optional parameters. More...

Detailed Description

A set of parameters for GPUdb::modifyGraph.

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

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

Definition at line 25 of file modify_graph.h.

Constructor & Destructor Documentation

ModifyGraphRequest() [1/2]

gpudb::ModifyGraphRequest::ModifyGraphRequest ( )

inline

Constructs a ModifyGraphRequest object with default parameters.

Definition at line 30 of file modify_graph.h.

ModifyGraphRequest() [2/2]

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. 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. modify_graph_export_create_results: If set to true, returns the graph topology in the response as arrays. Supported values: modify_graph_true modify_graph_false The default value is modify_graph_false. 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. Supported values: modify_graph_true modify_graph_false The default value is modify_graph_false. 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. Supported values: modify_graph_true modify_graph_false The default value is modify_graph_false. 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 GPUdb::createTableMonitor. Supported values: modify_graph_true modify_graph_false The default value is modify_graph_false. modify_graph_graph_table: If specified, the created graph is also created as a table with the given name, in [schema_name.]table_name format, using standard name resolution rules and meeting table naming criteria. This table will have the following identifier columns: 'EDGE_ID', 'EDGE_NODE1_ID', 'EDGE_NODE2_ID'. If left blank, no table is created. The default value is ''. 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. Supported values: modify_graph_true modify_graph_false The default value is modify_graph_false. 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). Supported values: modify_graph_true modify_graph_false The default value is modify_graph_false. 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'. modify_graph_use_rtree: Use an range tree structure to accelerate and improve the accuracy of snapping, especially to edges. Supported values: modify_graph_true modify_graph_false The default value is modify_graph_true. modify_graph_label_delimiter: If provided the label string will be split according to this delimiter and each sub-string will be applied as a separate label onto the specified edge. The default value is ''. modify_graph_allow_multiple_edges: Multigraph choice; allowing multiple edges with the same node pairs if set to true, otherwise, new edges with existing same node pairs will not be inserted. Supported values: modify_graph_true modify_graph_false The default value is modify_graph_true. modify_graph_embedding_table: If table exists (should be generated by the match/graph match_embedding solver), the vector embeddings for the newly inserted nodes will be appended into this table. The default value is ''. The default value is an empty map.

Definition at line 360 of file modify_graph.h.

Member Data Documentation

edges

std::vector<std::string> gpudb::ModifyGraphRequest::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.

Definition at line 415 of file modify_graph.h.

graphName

std::string gpudb::ModifyGraphRequest::graphName

Name of the graph resource to modify.

Definition at line 373 of file modify_graph.h.

nodes

std::vector<std::string> gpudb::ModifyGraphRequest::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.

Definition at line 394 of file modify_graph.h.

options

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

Optional parameters.

• 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.
• modify_graph_export_create_results: If set to true, returns the graph topology in the response as arrays. Supported values:
  • modify_graph_true
  • modify_graph_false
  The default value is modify_graph_false.
• 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. Supported values:
  • modify_graph_true
  • modify_graph_false
  The default value is modify_graph_false.
• 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. Supported values:
  • modify_graph_true
  • modify_graph_false
  The default value is modify_graph_false.
• 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 GPUdb::createTableMonitor. Supported values:
  • modify_graph_true
  • modify_graph_false
  The default value is modify_graph_false.
• modify_graph_graph_table: If specified, the created graph is also created as a table with the given name, in [schema_name.]table_name format, using standard name resolution rules and meeting table naming criteria. This table will have the following identifier columns: 'EDGE_ID', 'EDGE_NODE1_ID', 'EDGE_NODE2_ID'. If left blank, no table is created. The default value is ''.
• 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. Supported values:
  • modify_graph_true
  • modify_graph_false
  The default value is modify_graph_false.
• 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). Supported values:
  • modify_graph_true
  • modify_graph_false
  The default value is modify_graph_false.
• 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 <
  1. The default value is '60'.
• modify_graph_use_rtree: Use an range tree structure to accelerate and improve the accuracy of snapping, especially to edges. Supported values:
  • modify_graph_true
  • modify_graph_false
  The default value is modify_graph_true.
• modify_graph_label_delimiter: If provided the label string will be split according to this delimiter and each sub-string will be applied as a separate label onto the specified edge. The default value is ''.
• modify_graph_allow_multiple_edges: Multigraph choice; allowing multiple edges with the same node pairs if set to true, otherwise, new edges with existing same node pairs will not be inserted. Supported values:
  • modify_graph_true
  • modify_graph_false
  The default value is modify_graph_true.
• modify_graph_embedding_table: If table exists (should be generated by the match/graph match_embedding solver), the vector embeddings for the newly inserted nodes will be appended into this table. The default value is ''.

The default value is an empty map.

Definition at line 609 of file modify_graph.h.

restrictions

std::vector<std::string> gpudb::ModifyGraphRequest::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.

Definition at line 457 of file modify_graph.h.

weights

std::vector<std::string> gpudb::ModifyGraphRequest::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.

Definition at line 436 of file modify_graph.h.

---

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

• gpudb/protocol/modify_graph.h