modify\_graph(graph\_name=None, nodes=None, edges=None, weights=None, restrictions=None, options={"{"}{"}"})\[source]

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

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

Parameters

graph\_name (str) –

Name of the graph resource to modify.

nodes (list of str) –

Nodes with which to update existing input parameter nodes in graph specified by input parameter graph\_name. 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. The user can provide a single element (which will be automatically promoted to a list internally) or a list.

edges (list of str) –

Edges with which to update existing input parameter edges in graph specified by input parameter graph\_name. 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. The user can provide a single element (which will be automatically promoted to a list internally) or a list.

weights (list of str) –

Weights with which to update existing input parameter weights in graph specified by input parameter graph\_name. 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. The user can provide a single element (which will be automatically promoted to a list internally) or a list.

restrictions (list of str) –

Restrictions with which to update existing input parameter restrictions in graph specified by input parameter graph\_name. 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. The user can provide a single element (which will be automatically promoted to a list internally) or a list.

options (dict of str to str) –

Optional parameters. Allowed keys are:

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.
export\_create\_results – If set to true, returns the graph topology in the response as arrays. Allowed values are:
- true
- false
The default value is ‘false’.
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. Allowed values are:
- true
- false
The default value is ‘false’.
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. Allowed values are:
- true
- false
The default value is ‘false’.
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.create\_table\_monitor(). Allowed values are:
- true
- false
The default value is ‘false’.
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 ‘’.
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. Allowed values are:
- true
- false
The default value is ‘false’.
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). Allowed values are:
- true
- false
The default value is ‘false’.
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’.
use\_rtree – Use an range tree structure to accelerate and improve the accuracy of snapping, especially to edges. Allowed values are:
- true
- false
The default value is ‘true’.
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 ‘’.
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. Allowed values are:
- true
- false
The default value is ‘true’.
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 dict ( {"{"}{"}"} ).

Returns

A dict with the following entries–

result (bool) –

Indicates a successful modification on all servers.

num\_nodes (long) –

Total number of nodes in the graph.

num\_edges (long) –

Total number of edges in the graph.

edges\_ids (list of longs) –

Edges given as pairs of node indices. Only populated if export\_create\_results is set to true.

info (dict of str to str) –

Additional information.